Jobs - ImportJobs GetById

Service:

Azure Digital Twins

API Version:

2023-10-31

Récupère un travail d’importation. Codes d’état :

• 200 OK
• 404 Introuvable
  • ImportJobNotFound : la tâche d’importation est introuvable.

GET https://digitaltwins-hostname/jobs/imports/{id}?api-version=2023-10-31

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
id	path	True	string	ID du travail d’importation. L’ID est unique dans le service et respecte la casse.
api-version	query	True	string	Version de l’API demandée.

En-tête de la demande

Nom	Obligatoire	Type	Description
traceparent		string	Identifie la demande dans un système de suivi distribué.
tracestate		string	Fournit des informations d’identification de trace spécifiques au fournisseur et est un complément à traceparent.

Réponses

Nom	Type	Description
200 OK	ImportJob	Succès
Other Status Codes	ErrorResponse	Réponse par défaut. Headers x-ms-error-code: string

Sécurité

oauth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0

Exemples

Get an import job by id

Sample Request

HTTP

GET https://digitaltwins-hostname/jobs/imports/importjob1?api-version=2023-10-31

Sample Response

Status code:

200

{
  "id": "importjob1",
  "inputBlobUri": "path to input blob",
  "outputBlobUri": "path to output blob",
  "createdDateTime": "2022-01-01T00:00:00.0000000+00:00",
  "lastActionDateTime": "2022-01-01T00:01:00.0000000+00:00",
  "finishedDateTime": "2022-01-01T00:01:00.0000000+00:00",
  "purgeDateTime": "2022-01-31T00:01:00.0000000+00:00",
  "status": "succeeded"
}

Définitions

Nom	Description
Error	Définition de l’erreur.
ErrorResponse	Réponse d’erreur.
ImportJob	Tâche qui contient une référence aux opérations à effectuer, aux résultats et aux métadonnées d’exécution.
InnerError	Une description de l’erreur plus spécifique que celle fournie par l’erreur contenante.
status	État du travail.

Error

Définition de l’erreur.

Nom	Type	Description
code	string	Code d’erreur spécifique au service qui sert de sous-état pour le code d’erreur HTTP.
details	Error[]	Détails de l’erreur interne.
innererror	InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.

ErrorResponse

Réponse d’erreur.

Nom	Type	Description
error	Error	Détails de l’erreur.

ImportJob

Tâche qui contient une référence aux opérations à effectuer, aux résultats et aux métadonnées d’exécution.

Nom	Type	Description
createdDateTime	string	Heure de début du travail. L’horodatage est au format RFC3339 : yyyy-MM-ddTHH:mm:ssZ.
error	Error	Détails des erreurs qui se sont produites lors de l’exécution du travail d’importation.
finishedDateTime	string	Heure de fin du travail. L’horodatage est au format RFC3339 : yyyy-MM-ddTHH:mm:ssZ.
id	string	Identificateur du travail d’importation.
inputBlobUri	string	Chemin d’accès à l’objet blob de stockage Azure d’entrée qui contient le ou les fichiers décrivant les opérations à effectuer dans le travail.
lastActionDateTime	string	La dernière fois que le service a effectué une action à partir du travail. L’horodatage est au format RFC3339 : yyyy-MM-ddTHH:mm:ssZ.
outputBlobUri	string	Chemin d’accès à l’objet blob de stockage Azure de sortie qui contiendra les erreurs et les journaux de progression du travail d’importation.
purgeDateTime	string	Heure à laquelle le travail sera purgé par le service du système. L’horodatage est au format RFC3339 : yyyy-MM-ddTHH:mm:ssZ.
status	status	État du travail.

InnerError

Une description de l’erreur plus spécifique que celle fournie par l’erreur contenante.

Nom	Type	Description
code	string	Un code d’erreur plus spécifique que celui fourni par l’erreur contenante.
innererror	InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.

status

État du travail.

Nom	Type	Description
cancelled	string
cancelling	string
failed	string
notstarted	string
running	string
succeeded	string