List Job Documents - List Job Documents

Service:: Health Data

Version d'API:: 2024-11-15

Répertoriez les documents traités au sein d’un travail.
Modèle d’opération de liste de ressources.

GET {endpoint}/jobs/{name}/documents?api-version=2024-11-15

Avec des paramètres facultatifs:

GET {endpoint}/jobs/{name}/documents?api-version=2024-11-15&maxpagesize={maxpagesize}&continuationToken={continuationToken}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)	URL de votre service de dé-identification.
name	path	True	string minLength: 3 maxLength: 36 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$	Nom d’un travail.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.
continuationToken	query		string	Jeton pour continuer une requête précédente.
maxpagesize	query		integer (int32)	Nombre maximal d’éléments de résultat par page.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-request-id		string (uuid)	Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Réponses

Nom	Type	Description
200 OK	PagedDeidentificationDocumentDetails	La demande a réussi. En-têtes x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Nom

Type

Description

200 OK

PagedDeidentificationDocumentDetails

La demande a réussi.

En-têtes

x-ms-client-request-id: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Réponse d’erreur inattendue.

En-têtes

x-ms-error-code: string

Sécurité

AadToken

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: accessCode
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
URL du jeton: https://login.microsoftonline.com/common/oauth2/token

Étendues

Nom	Description
https://deid.azure.com/.default

Exemples

List processed documents within a job.

Exemple de requête

HTTP

GET {endpoint}/jobs/job_smith_documents_1/documents?api-version=2024-11-15&maxpagesize=10&continuationToken=K1JJRDpzOEtaQWZabUQrQUNBQUFBQUFBQUFBQT09I1JUOjEjVFJDOjEwI0ZQQzpBZ0VBQUFBTUFDUUFBQUFBQUE9PQ==

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "input": {
        "location": "https://blobtest.blob.core.windows.net/container/documents/patient_doc_1",
        "etag": "0x8DB638EEA0CC717"
      },
      "status": "Failed",
      "error": {
        "code": "FileNotFound",
        "message": "File was moved after job started.",
        "target": "SourceFile",
        "details": []
      }
    }
  ],
  "nextLink": "https://deidtest.api.deid.azure.com/jobs/00000000-0000-0000-0000-000000000000/documents?maxpagesize=10&continuationToken=K1JJRDpzOEtaQWZabUQrQUNBQUFBQUFBQUFBQT09I1JUOjEjVFJDOjEwI0ZQQzpBZ0VBQUFBTUFDUUFBQUFBQUE9PQ=="
}

Définitions

Nom	Description
Azure.Core.Foundations.Error	Objet d’erreur.
Azure.Core.Foundations.ErrorResponse	Réponse contenant les détails de l’erreur.
Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux directives de l’API REST Azure : https://aka.ms/AzureRestApiGuidelines#handling-errors.
DeidentificationDocumentDetails	Détails d’un document unique dans un travail.
DeidentificationDocumentLocation	Emplacement d’un document.
OperationState	État du document.
PagedDeidentificationDocumentDetails	Collection paginée d’éléments DeidentificationDocumentDetails

Azure.Core.Foundations.Error

Object

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	Azure.Core.Foundations.Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	Azure.Core.Foundations.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.
target	string	Cible de l’erreur.

Azure.Core.Foundations.ErrorResponse

Object

Réponse contenant les détails de l’erreur.

Nom	Type	Description
error	Azure.Core.Foundations.Error	Objet d’erreur.

Azure.Core.Foundations.InnerError

Object

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux directives de l’API REST Azure : https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
innererror	Azure.Core.Foundations.InnerError	Erreur interne.

DeidentificationDocumentDetails

Object

Détails d’un document unique dans un travail.

Nom	Type	Description
error	Azure.Core.Foundations.Error	Erreur lors de l’échec du document.
id	string	ID des détails du document.
input	DeidentificationDocumentLocation	Emplacement de l’entrée.
output	DeidentificationDocumentLocation	Emplacement de la sortie.
status	OperationState	État du document.

DeidentificationDocumentLocation

Object

Emplacement d’un document.

Nom	Type	Description
etag	string	Balise d’entité pour cette ressource.
location	string (uri) maxLength: 1024	Emplacement du document dans le stockage.

OperationState

Énumération

État du document.

Valeur	Description
NotStarted	L’opération n’a pas démarré.
Running	L’opération est en cours.
Succeeded	L’opération s’est terminée avec succès.
Failed	L’opération a échoué.
Canceled	L’opération a été annulée par l’utilisateur.

PagedDeidentificationDocumentDetails

Object

Collection paginée d’éléments DeidentificationDocumentDetails

Nom	Type	Description
nextLink	string (uri)	Lien vers la page suivante des éléments
value	DeidentificationDocumentDetails[]	Éléments DeidentificationDocumentDetails sur cette page