Delen via


Jobs - Get

Een taak ophalen op id
Meer informatie over een actieve of voltooide taak per 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

Unieke id van de taak.

Regex-patroon: ^[a-zA-Z0-9_-]*$

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

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

Voorbeeldrespons

{
  "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 taakgegevensdefinitie van de opdracht.

DeviceTemplateMigrationJobData

De gegevensdefinitie van de migratietaak van de apparaatsjabloon.

Error

De antwoordfoutdefinitie.

ErrorDetails

De gedetailleerde informatie van 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 is per opgegeven aantal apparaten of een percentage van het totale aantal apparaten.

JobProgress

voortgangsoverzicht voor een geplande taak.

PropertyJobData

De definitie van de eigenschapstaakgegevens.

CloudPropertyJobData

De gegevens van de cloudeigenschapstaak.

Name Type Description
path

string

Het pad naar de doelmogelijkheid in de apparaatsjabloon.

target

string

De apparaatsjabloon die de doelmogelijkheid voor de taak definieert.

type string:

cloudProperty

Type van de taakgegevens.

value

AnyValue

De waarde die wordt gebruikt om de doelmogelijkheid bij te werken, indien van toepassing.

CommandJobData

De taakgegevensdefinitie van de opdracht.

Name Type Description
path

string

Het pad naar de doelmogelijkheid in de apparaatsjabloon.

target

string

De apparaatsjabloon die de doelmogelijkheid voor de taak definieert.

type string:

command

Type van de taakgegevens.

value

AnyValue

De waarde die wordt gebruikt om de doelmogelijkheid bij te werken, indien van toepassing.

DeviceTemplateMigrationJobData

De gegevensdefinitie van de migratietaak van de apparaatsjabloon.

Name Type Description
template

string

De doelapparaatsjabloon waarnaar apparaten worden gemigreerd.

type string:

deviceTemplateMigration

Type van de taakgegevens.

Error

De antwoordfoutdefinitie.

Name Type Description
error

ErrorDetails

Foutdetails voor de huidige aanvraag.

ErrorDetails

De gedetailleerde informatie van de fout.

Name Type Description
code

string

Foutcode.

message

string

Details van foutbericht.

requestId

string

Correlatie-id voor huidige aanvraag.

time

string

Het tijdstip waarop de foutaanvraag is mislukt.

Job

De taakdefinitie.

Name Type Description
batch

JobBatch

De batchconfiguratie voor de taak.

cancellationThreshold

JobCancellationThreshold

De annuleringsdrempel voor de taak.

data JobData[]:

De mogelijkheden die door de taak worden bijgewerkt en de waarden waarmee ze worden bijgewerkt.

description

string

Gedetailleerde beschrijving van de taak.

displayName

string

Weergavenaam van de taak.

end

string

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, er wordt momenteel slechts één organisatie ondersteund, meerdere organisaties worden binnenkort ondersteund.

progress

JobProgress

De voortgangsstatistieken van de taak.

scheduledJobId

string

Id van de geplande taakdefinitie waarmee deze taak is gemaakt.

start

string

De begintijd van de taak

status

string

Geeft aan of de taak wordt gestart, uitgevoerd, enzovoort.

JobBatch

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

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

Name Type Description
number

string

Taakbatch uitvoeren op basis van het aantal apparaten.

percentage

string

Op taakbatch gebaseerd percentage van het totale aantal toegepaste apparaten.

JobCancellationThreshold

De definitie van de drempelwaarde voor taakannulering.

Name Type Description
batch

boolean

Of de annuleringsdrempel per batch of de algehele taak wordt toegepast.

type

JobCancellationThresholdType

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

value

number

Het aantal of het percentage apparaten waarop de annuleringsdrempelwaarde wordt toegepast.

JobCancellationThresholdType

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

Name Type Description
number

string

Drempelwaarde voor het annuleren van taken op basis van het opgegeven aantal apparaten.

percentage

string

Drempelwaarde voor het annuleren van taken op basis van het percentage van het totale aantal apparaten.

JobProgress

voortgangsoverzicht voor een geplande taak.

Name Type Description
completed

integer

Het aantal entiteiten waarvoor de taak is voltooid.

failed

integer

Het aantal entiteiten waarvoor de taak is mislukt.

pending

integer

Het aantal entiteiten waarvoor de taak nog niet wordt uitgevoerd.

total

integer

Het totale aantal entiteiten waarop de taak is gericht.

PropertyJobData

De definitie van de eigenschapstaakgegevens.

Name Type Description
path

string

Het pad naar de doelmogelijkheid in de apparaatsjabloon.

target

string

De apparaatsjabloon die de doelmogelijkheid voor de taak definieert.

type string:

property

Type van de taakgegevens.

value

AnyValue

De waarde die wordt gebruikt om de doelmogelijkheid bij te werken, indien van toepassing.