List Job Documents - List Job Documents

Service:

Health Data

API-versie:

2024-11-15

Verwerkte documenten in een taak weergeven.
Bewerkingssjabloon voor resourcelijst.

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

Met optionele parameters:

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string (uri)	Url van uw service voor de identificatie.
name	path	True	string minLength: 3 maxLength: 36 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$	De naam van een taak.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.
continuationToken	query		string	Token om door te gaan met een vorige query.
maxpagesize	query		integer (int32)	Het maximum aantal resultaatitems per pagina.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string (uuid)	Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Antwoorden

Name	Type	Description
200 OK	PagedDeidentificationDocumentDetails	De aanvraag is voltooid. Kopteksten x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Beveiliging

AadToken

De Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: accessCode
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiken

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

Voorbeelden

List processed documents within a job.

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

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

Definities

Name	Description
Azure.Core.Foundations.Error	Het foutobject.
Azure.Core.Foundations.ErrorResponse	Een antwoord met foutdetails.
Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie over de fout. Volgens de Azure REST API-richtlijnen - . https://aka.ms/AzureRestApiGuidelines#handling-errors
DeidentificationDocumentDetails	Details van één document in een taak.
DeidentificationDocumentLocation	Locatie van een document.
OperationState	Status van het document.
PagedDeidentificationDocumentDetails	Gepaginade verzameling DeidentificationDocumentDetails-items

Azure.Core.Foundations.Error

Object

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Azure.Core.Foundations.Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Object

Een antwoord met foutdetails.

Name	Type	Description
error	Azure.Core.Foundations.Error	Het foutobject.

Azure.Core.Foundations.InnerError

Object

Een object met meer specifieke informatie over de fout. Volgens de Azure REST API-richtlijnen - . https://aka.ms/AzureRestApiGuidelines#handling-errors

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	Azure.Core.Foundations.InnerError	Interne fout.

DeidentificationDocumentDetails

Object

Details van één document in een taak.

Name	Type	Description
error	Azure.Core.Foundations.Error	Fout bij mislukt document.
id	string	Id van de documentdetails.
input	DeidentificationDocumentLocation	Locatie voor de invoer.
output	DeidentificationDocumentLocation	Locatie voor de uitvoer.
status	OperationState	Status van het document.

DeidentificationDocumentLocation

Object

Locatie van een document.

Name	Type	Description
etag	string	De entiteitstag voor deze resource.
location	string (uri) maxLength: 1024	Locatie van document in opslag.

OperationState

Inventarisatie

Status van het document.

Waarde	Description
NotStarted	De bewerking is niet gestart.
Running	De bewerking wordt uitgevoerd.
Succeeded	De bewerking is voltooid.
Failed	De bewerking is mislukt.
Canceled	De bewerking is geannuleerd door de gebruiker.

PagedDeidentificationDocumentDetails

Object

Gepaginade verzameling DeidentificationDocumentDetails-items

Name	Type	Description
nextLink	string (uri)	De koppeling naar de volgende pagina met items
value	DeidentificationDocumentDetails[]	De DeidentificationDocumentDetails-items op deze pagina