Jobs - Get

Tjänst:

IoT Central

API-version:

2022-07-31

Hämta ett jobb efter ID
Få information om ett jobb som körs eller slutförts efter jobb-ID.

GET https://{subdomain}.{baseDomain}/api/jobs/{jobId}?api-version=2022-07-31

URI-parametrar

Name	I	Obligatorisk	Typ	Description
baseDomain	path	True	string	Basdomänen för alla Azure IoT Central-tjänstbegäranden.
jobId	path	True	string maxLength: 255 pattern: ^[a-zA-Z0-9_-]*$	Unikt ID för jobbet.
subdomain	path	True	string	Programmets underdomän.
api-version	query	True	string	Den version av API:et som anropas.

Svar

Name	Typ	Description
200 OK	Job	Framgång
Other Status Codes	Error	Ett felsvar som togs emot från IoT Central-tjänsten. Sidhuvuden x-ms-error-code: string

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Get a job by ID

Exempelbegäran

HTTP

GET https://appsubdomain.azureiotcentral.com/api/jobs/myJobId?api-version=2022-07-31

Exempelsvar

Statuskod:

200

{
  "id": "myJobId",
  "displayName": "My Job",
  "group": "475cad48-b7ff-4a09-b51e-1a9021385453",
  "data": [
    {
      "type": "property",
      "target": "urn:1dgygpt7t:modelDefinition:02uwtefvdy",
      "path": "componentName.propertyName",
      "value": "updated value"
    }
  ],
  "status": "running"
}

Definitioner

Name	Description
CloudPropertyJobData	Jobbdata för molnegenskap.
CommandJobData	Datadefinitionen för kommandojobbet.
DeviceTemplateMigrationJobData	Datadefinitionen för enhetsmallens migreringsjobb.
Error	Svarsfeldefinitionen.
ErrorDetails	Information om felet.
Job	Jobbdefinitionen.
JobBatch	Jobbbatchdefinitionen.
JobBatchType	Om batchbearbetning görs på ett angivet antal enheter eller en procentandel av det totala antalet enheter.
JobCancellationThreshold	Tröskelvärdet för uppsägning av jobb.
JobCancellationThresholdType	Om tröskelvärdet för annullering är per ett angivet antal enheter eller en procentandel av de totala enheterna.
JobProgress	förloppssammanfattning för ett schemalagt jobb.
PropertyJobData	Datadefinitionen för egenskapsjobbet.

CloudPropertyJobData

Objekt

Jobbdata för molnegenskap.

Name	Typ	Description
path	string	Sökvägen till målfunktionen i enhetsmallen.
target	string minLength: 1	Enhetsmallen som definierar målfunktionen för jobbet.
type	string: cloudProperty	Typ av jobbdata.
value	AnyValue	Det värde som används för att uppdatera målfunktionen, om det finns något.

CommandJobData

Objekt

Datadefinitionen för kommandojobbet.

Name	Typ	Description
path	string	Sökvägen till målfunktionen i enhetsmallen.
target	string minLength: 1	Enhetsmallen som definierar målfunktionen för jobbet.
type	string: command	Typ av jobbdata.
value	AnyValue	Det värde som används för att uppdatera målfunktionen, om det finns något.

DeviceTemplateMigrationJobData

Objekt

Datadefinitionen för enhetsmallens migreringsjobb.

Name	Typ	Description
template	string minLength: 1	Målenhetsmallen som enheterna ska migreras till.
type	string: deviceTemplateMigration	Typ av jobbdata.

Error

Objekt

Svarsfeldefinitionen.

Name	Typ	Description
error	ErrorDetails	Felinformation för aktuell begäran.

ErrorDetails

Objekt

Information om felet.

Name	Typ	Description
code	string	Felkod.
message	string	Information om felmeddelande.
requestId	string	Korrelations-ID för aktuell begäran.
time	string (date-time-rfc1123)	Den tid då felbegäran misslyckades.

Job

Objekt

Jobbdefinitionen.

Name	Typ	Description
batch	JobBatch	Batchkonfigurationen för jobbet.
cancellationThreshold	JobCancellationThreshold	Tröskelvärdet för annullering för jobbet.
data	JobData[]: CloudPropertyJobData[] CommandJobData[] DeviceTemplateMigrationJobData[] PropertyJobData[]	Funktionerna som uppdateras av jobbet och de värden som de uppdateras med.
description	string	Detaljerad beskrivning av jobbet.
displayName	string	Jobbets visningsnamn.
end	string (date-time)	Jobbets sluttid
group	string	ID:t för den enhetsgrupp som jobbet ska köras på.
id	string	Unikt ID för jobbet.
organizations	string[]	Lista över organisationer för jobbet, endast en organisation stöds idag, flera organisationer kommer snart att stödjas.
progress	JobProgress	Förloppsstatistik för jobbet.
scheduledJobId	string	Id för den schemalagda jobbdefinitionen som skapade det här jobbet.
start	string (date-time)	Starttiden för jobbet
status	string	Anger om jobbet startar, körs osv.

JobBatch

Objekt

Jobbbatchdefinitionen.

Name	Typ	Description
type	JobBatchType	Om batchbearbetning görs på ett angivet antal enheter eller en procentandel av det totala antalet enheter.
value	number	Antalet eller procentandelen enheter som batchbearbetningen görs på.

JobBatchType

Uppräkning

Om batchbearbetning görs på ett angivet antal enheter eller en procentandel av det totala antalet enheter.

Värde	Description
number	Jobbbatching baserat på antalet enheter.
percentage	Jobb batchbearbetningsbaserad procentandel av det totala antalet tillämpade enheter.

JobCancellationThreshold

Objekt

Tröskelvärdet för uppsägning av jobb.

Name	Typ	Description
batch	boolean	Om tröskelvärdet för annullering gäller per batch eller för det övergripande jobbet.
type	JobCancellationThresholdType	Om tröskelvärdet för annullering är per ett angivet antal enheter eller en procentandel av de totala enheterna.
value	number	Antalet eller procentandelen enheter som tröskelvärdet för annullering tillämpas på.

JobCancellationThresholdType

Uppräkning

Om tröskelvärdet för annullering är per ett angivet antal enheter eller en procentandel av de totala enheterna.

Värde	Description
number	Tröskelvärde för uppsägning av jobb baserat på angivet antal enheter.
percentage	Tröskelvärde för uppsägning av jobb baserat på procentandelen av de totala enheterna.

JobProgress

Objekt

förloppssammanfattning för ett schemalagt jobb.

Name	Typ	Description
completed	integer (int32)	Antalet entiteter som jobbet har slutförts för.
failed	integer (int32)	Antalet entiteter som jobbet har misslyckats för.
pending	integer (int32)	Antalet entiteter som jobbet inte körs för ännu.
total	integer (int32)	Det totala antalet entiteter som jobbet riktar in sig på.

PropertyJobData

Objekt

Datadefinitionen för egenskapsjobbet.

Name	Typ	Description
path	string	Sökvägen till målfunktionen i enhetsmallen.
target	string minLength: 1	Enhetsmallen som definierar målfunktionen för jobbet.
type	string: property	Typ av jobbdata.
value	AnyValue	Det värde som används för att uppdatera målfunktionen, om det finns något.