Jobs - Get

Service:: IoT Central

Version d'API:: 2022-07-31

Obtenir un travail par ID
Obtenez des détails sur un travail en cours d’exécution ou terminé par ID de travail.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
baseDomain	path	True	string	Domaine de base pour toutes les demandes de service Azure IoT Central.
jobId	path	True	string maxLength: 255 pattern: ^[a-zA-Z0-9_-]*$	ID unique du travail.
subdomain	path	True	string	Sous-domaine de l’application.
api-version	query	True	string	Version de l’API appelée.

Réponses

Nom	Type	Description
200 OK	Job	Succès
Other Status Codes	Error	Réponse d’erreur reçue du service IoT Central. En-têtes x-ms-error-code: string

Nom

Type

Description

200 OK

Job

Succès

Other Status Codes

Error

Réponse d’erreur reçue du service IoT Central.

En-têtes

x-ms-error-code: string

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Get a job by ID

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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"
}

Définitions

Nom	Description
CloudPropertyJobData	Données du travail de propriété cloud.
CommandJobData	Définition des données du travail de commande.
DeviceTemplateMigrationJobData	Définition de données du travail de migration de modèle d’appareil.
Error	Définition de l’erreur de réponse.
ErrorDetails	Informations détaillées de l’erreur.
Job	Définition du travail.
JobBatch	Définition du lot de travaux.
JobBatchType	Indique si le traitement par lots est effectué sur un nombre spécifié d’appareils ou un pourcentage du nombre total d’appareils.
JobCancellationThreshold	Définition du seuil d’annulation du travail.
JobCancellationThresholdType	Indique si le seuil d’annulation est défini par un nombre spécifié d’appareils ou un pourcentage du nombre total d’appareils.
JobProgress	résumé de progression d’un travail planifié.
PropertyJobData	Définition des données du travail de propriété.

CloudPropertyJobData

Object

Données du travail de propriété cloud.

Nom	Type	Description
path	string	Chemin d’accès à la fonctionnalité cible dans le modèle d’appareil.
target	string minLength: 1	Modèle d’appareil qui définit la fonctionnalité cible du travail.
type	string: cloudProperty	Type des données de travail.
value	AnyValue	Valeur utilisée pour mettre à jour la fonctionnalité cible, le cas échéant.

CommandJobData

Object

Définition des données du travail de commande.

Nom	Type	Description
path	string	Chemin d’accès à la fonctionnalité cible dans le modèle d’appareil.
target	string minLength: 1	Modèle d’appareil qui définit la fonctionnalité cible du travail.
type	string: command	Type des données de travail.
value	AnyValue	Valeur utilisée pour mettre à jour la fonctionnalité cible, le cas échéant.

DeviceTemplateMigrationJobData

Object

Définition de données du travail de migration de modèle d’appareil.

Nom	Type	Description
template	string minLength: 1	Modèle d’appareil cible vers lequel les appareils seront migrés.
type	string: deviceTemplateMigration	Type des données de travail.

Error

Object

Définition de l’erreur de réponse.

Nom	Type	Description
error	ErrorDetails	Détails de l’erreur pour la requête actuelle.

ErrorDetails

Object

Informations détaillées de l’erreur.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Détails du message d’erreur.
requestId	string	ID de corrélation pour la requête actuelle.
time	string (date-time-rfc1123)	Heure à laquelle la demande d’erreur a échoué.

Job

Object

Définition du travail.

Nom	Type	Description
batch	JobBatch	Configuration de traitement par lots pour le travail.
cancellationThreshold	JobCancellationThreshold	Seuil d’annulation du travail.
data	JobData[]: CloudPropertyJobData[] CommandJobData[] DeviceTemplateMigrationJobData[] PropertyJobData[]	Fonctionnalités mises à jour par le travail et les valeurs avec lesquelles elles sont mises à jour.
description	string	Description détaillée du travail.
displayName	string	Nom complet du travail.
end	string (date-time)	Heure de fin du travail
group	string	ID du groupe d’appareils sur lequel exécuter le travail.
id	string	ID unique du travail.
organizations	string[]	Liste des organisations du travail, une seule organisation est prise en charge aujourd’hui, plusieurs organisations seront bientôt prises en charge.
progress	JobProgress	Statistiques de progression du travail.
scheduledJobId	string	ID de la définition de travail planifiée qui a créé ce travail.
start	string (date-time)	Heure de début du travail
status	string	Indique si le travail démarre, s’exécute, etc.

JobBatch

Object

Définition du lot de travaux.

Nom	Type	Description
type	JobBatchType	Indique si le traitement par lots est effectué sur un nombre spécifié d’appareils ou un pourcentage du nombre total d’appareils.
value	number	Nombre ou pourcentage d’appareils sur lesquels le traitement par lots est effectué.

JobBatchType

Énumération

Indique si le traitement par lots est effectué sur un nombre spécifié d’appareils ou un pourcentage du nombre total d’appareils.

Valeur	Description
number	Traitement par lots basé sur le nombre d’appareils.
percentage	Pourcentage basé sur le traitement par lots de travaux du nombre total d’appareils appliqués.

JobCancellationThreshold

Object

Définition du seuil d’annulation du travail.

Nom	Type	Description
batch	boolean	Indique si le seuil d’annulation s’applique par lot ou au travail global.
type	JobCancellationThresholdType	Indique si le seuil d’annulation est défini par un nombre spécifié d’appareils ou un pourcentage du nombre total d’appareils.
value	number	Nombre ou pourcentage d’appareils sur lesquels le seuil d’annulation est appliqué.

JobCancellationThresholdType

Énumération

Indique si le seuil d’annulation est défini par un nombre spécifié d’appareils ou un pourcentage du nombre total d’appareils.

Valeur	Description
number	Seuil d’annulation du travail en fonction du nombre spécifié d’appareils.
percentage	Seuil d’annulation du travail en fonction du pourcentage d’appareils totaux.

JobProgress

Object

résumé de progression d’un travail planifié.

Nom	Type	Description
completed	integer (int32)	Nombre d’entités pour lesquelles le travail est terminé.
failed	integer (int32)	Nombre d’entités pour lesquelles le travail a échoué.
pending	integer (int32)	Nombre d’entités pour lesquelles le travail n’est pas encore en cours d’exécution.
total	integer (int32)	Nombre total d’entités ciblées par le travail.

PropertyJobData

Object

Définition des données du travail de propriété.

Nom	Type	Description
path	string	Chemin d’accès à la fonctionnalité cible dans le modèle d’appareil.
target	string minLength: 1	Modèle d’appareil qui définit la fonctionnalité cible du travail.
type	string: property	Type des données de travail.
value	AnyValue	Valeur utilisée pour mettre à jour la fonctionnalité cible, le cas échéant.

Partager via

Jobs - Get

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

Get a job by ID

Exemple de requête

Exemple de réponse

Définitions

CloudPropertyJobData

CommandJobData

DeviceTemplateMigrationJobData

Error

ErrorDetails

Job

JobBatch

JobBatchType

JobCancellationThreshold

JobCancellationThresholdType

JobProgress

PropertyJobData