Jobs - Get

Service:

IoT Central

API-versie:

2022-07-31

Een taak ophalen op id
Meer informatie over een actieve of voltooide taak op taak-id.

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

URI-parameters

Name	In	Vereist	Type	Description
baseDomain	path	True	string	Het basisdomein voor alle Azure IoT Central-serviceaanvragen.
jobId	path	True	string maxLength: 255 pattern: ^[a-zA-Z0-9_-]*$	Unieke id van de taak.
subdomain	path	True	string	Het subdomein van de toepassing.
api-version	query	True	string	De versie van de API die wordt aangeroepen.

Antwoorden

Name	Type	Description
200 OK	Job	Geslaagd
Other Status Codes	Error	Er is een foutbericht ontvangen van de IoT Central-service. Kopteksten x-ms-error-code: string

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Get a job by ID

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

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"
}

Definities

Name	Description
CloudPropertyJobData	De gegevens van de cloudeigenschapstaak.
CommandJobData	De opdrachttaakgegevensdefinitie.
DeviceTemplateMigrationJobData	De gegevensdefinitie van de apparaatsjabloonmigratietaak.
Error	De antwoordfoutdefinitie.
ErrorDetails	De gedetailleerde informatie over de fout.
Job	De taakdefinitie.
JobBatch	De taakbatchdefinitie.
JobBatchType	Of batchverwerking wordt uitgevoerd op een opgegeven aantal apparaten of een percentage van het totale aantal apparaten.
JobCancellationThreshold	De definitie van de drempelwaarde voor taakannulering.
JobCancellationThresholdType	Of de annuleringsdrempel per opgegeven aantal apparaten of een percentage van het totale aantal apparaten is.
JobProgress	voortgangsoverzicht voor een geplande taak.
PropertyJobData	De definitie van de eigenschapstaakgegevens.

CloudPropertyJobData

Object

De gegevens van de cloudeigenschapstaak.

Name	Type	Description
path	string	Het pad naar de doelmogelijkheid in de apparaatsjabloon.
target	string minLength: 1	De apparaatsjabloon waarmee de doelmogelijkheid voor de taak wordt gedefinieerd.
type	string: cloudProperty	Type taakgegevens.
value	AnyValue	De waarde die wordt gebruikt om de doelmogelijkheid bij te werken, indien van toepassing.

CommandJobData

Object

De opdrachttaakgegevensdefinitie.

Name	Type	Description
path	string	Het pad naar de doelmogelijkheid in de apparaatsjabloon.
target	string minLength: 1	De apparaatsjabloon waarmee de doelmogelijkheid voor de taak wordt gedefinieerd.
type	string: command	Type taakgegevens.
value	AnyValue	De waarde die wordt gebruikt om de doelmogelijkheid bij te werken, indien van toepassing.

DeviceTemplateMigrationJobData

Object

De gegevensdefinitie van de apparaatsjabloonmigratietaak.

Name	Type	Description
template	string minLength: 1	De doelapparaatsjabloon waarnaar apparaten worden gemigreerd.
type	string: deviceTemplateMigration	Type taakgegevens.

Error

Object

De antwoordfoutdefinitie.

Name	Type	Description
error	ErrorDetails	Foutdetails voor de huidige aanvraag.

ErrorDetails

Object

De gedetailleerde informatie over de fout.

Name	Type	Description
code	string	Foutcode.
message	string	Details van foutbericht.
requestId	string	Correlatie-id voor huidige aanvraag.
time	string (date-time-rfc1123)	Het tijdstip waarop de foutaanvraag is mislukt.

Job

Object

De taakdefinitie.

Name	Type	Description
batch	JobBatch	De batchconfiguratie voor de taak.
cancellationThreshold	JobCancellationThreshold	De annuleringsdrempel voor de taak.
data	JobData[]: CloudPropertyJobData[] CommandJobData[] DeviceTemplateMigrationJobData[] PropertyJobData[]	De mogelijkheden die worden bijgewerkt door de taak en de waarden waarmee ze worden bijgewerkt.
description	string	Gedetailleerde beschrijving van de taak.
displayName	string	Weergavenaam van de taak.
end	string (date-time)	De eindtijd van de taak
group	string	De id van de apparaatgroep waarop de taak moet worden uitgevoerd.
id	string	Unieke id van de taak.
organizations	string[]	Lijst met organisaties van de taak, slechts één organisatie wordt momenteel ondersteund, meerdere organisaties worden binnenkort ondersteund.
progress	JobProgress	De voortgangsstatistieken van de taak.
scheduledJobId	string	Id van de geplande taakdefinitie die deze taak heeft gemaakt.
start	string (date-time)	De begintijd van de taak
status	string	Geeft aan of de taak wordt gestart, uitgevoerd, enzovoort.

JobBatch

Object

De taakbatchdefinitie.

Name	Type	Description
type	JobBatchType	Of batchverwerking wordt uitgevoerd op een opgegeven aantal apparaten of een percentage van het totale aantal apparaten.
value	number	Het aantal of het percentage apparaten waarop batchverwerking wordt uitgevoerd.

JobBatchType

Inventarisatie

Of batchverwerking wordt uitgevoerd op een opgegeven aantal apparaten of een percentage van het totale aantal apparaten.

Waarde	Description
number	Job Batching op basis van het aantal apparaten.
percentage	Op jobbatches gebaseerd percentage van het totale toegepaste apparaat.

JobCancellationThreshold

Object

De definitie van de drempelwaarde voor taakannulering.

Name	Type	Description
batch	boolean	Of de annuleringsdrempel per batch of op de algehele taak van toepassing is.
type	JobCancellationThresholdType	Of de annuleringsdrempel per opgegeven aantal apparaten of een percentage van het totale aantal apparaten is.
value	number	Het aantal of het percentage apparaten waarop de annuleringsdrempel wordt toegepast.

JobCancellationThresholdType

Inventarisatie

Of de annuleringsdrempel per opgegeven aantal apparaten of een percentage van het totale aantal apparaten is.

Waarde	Description
number	Drempelwaarde voor het annuleren van taken op basis van het opgegeven aantal apparaten.
percentage	Drempelwaarde voor het annuleren van taken op basis van het percentage van het totale aantal apparaten.

JobProgress

Object

voortgangsoverzicht voor een geplande taak.

Name	Type	Description
completed	integer (int32)	Het aantal entiteiten waarvoor de taak is voltooid.
failed	integer (int32)	Het aantal entiteiten waarvoor de taak is mislukt.
pending	integer (int32)	Het aantal entiteiten waarvoor de taak nog niet wordt uitgevoerd.
total	integer (int32)	Het totale aantal entiteiten waarop de taak betrekking heeft.

PropertyJobData

Object

De definitie van de eigenschapstaakgegevens.

Name	Type	Description
path	string	Het pad naar de doelmogelijkheid in de apparaatsjabloon.
target	string minLength: 1	De apparaatsjabloon waarmee de doelmogelijkheid voor de taak wordt gedefinieerd.
type	string: property	Type taakgegevens.
value	AnyValue	De waarde die wordt gebruikt om de doelmogelijkheid bij te werken, indien van toepassing.