List Job Documents - List Job Documents
Auflisten verarbeiteter Dokumente innerhalb eines Auftrags.
Ressourcenlistenvorgangsvorlage.
GET {endpoint}/jobs/{name}/documents?api-version=2024-11-15
GET {endpoint}/jobs/{name}/documents?api-version=2024-11-15&maxpagesize={maxpagesize}&continuationToken={continuationToken}
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
endpoint
|
path | True |
string (uri) |
URL Ihres Deidentifikationsdiensts. |
name
|
path | True |
string minLength: 3maxLength: 36 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$ |
Der Name eines Auftrags. |
api-version
|
query | True |
string minLength: 1 |
Die API-Version, die für diesen Vorgang verwendet werden soll. |
continuation
|
query |
string |
Token zum Fortsetzen einer vorherigen Abfrage. |
|
maxpagesize
|
query |
integer (int32) |
Die maximale Anzahl von Ergebniselementen pro Seite. |
Anforderungsheader
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
x-ms-client-request-id |
string (uuid) |
Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Die Anforderung ist erfolgreich. Header x-ms-client-request-id: string |
|
Other Status Codes |
Unerwartete Fehlerantwort. Header x-ms-error-code: string |
Sicherheit
AadToken
Der Azure Active Directory OAuth2-Fluss
Typ:
oauth2
Ablauf:
accessCode
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Token-URL:
https://login.microsoftonline.com/common/oauth2/token
Bereiche
Name | Beschreibung |
---|---|
https://deid.azure.com/.default |
Beispiele
List processed documents within a job.
Beispielanforderung
GET {endpoint}/jobs/job_smith_documents_1/documents?api-version=2024-11-15&maxpagesize=10&continuationToken=K1JJRDpzOEtaQWZabUQrQUNBQUFBQUFBQUFBQT09I1JUOjEjVFJDOjEwI0ZQQzpBZ0VBQUFBTUFDUUFBQUFBQUE9PQ==
Beispiel für eine Antwort
{
"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=="
}
Definitionen
Name | Beschreibung |
---|---|
Azure. |
Das Fehlerobjekt. |
Azure. |
Eine Antwort, die Fehlerdetails enthält. |
Azure. |
Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. |
Deidentification |
Details zu einem einzelnen Dokument in einem Auftrag. |
Deidentification |
Speicherort eines Dokuments. |
Operation |
Status des Dokuments. |
Paged |
Paged-Auflistung von DeidentificationDocumentDetails-Elementen |
Azure.Core.Foundations.Error
Das Fehlerobjekt.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Eine serverdefinierte Gruppe von Fehlercodes. |
details |
Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben. |
|
innererror |
Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler. |
|
message |
string |
Eine lesbare Darstellung des Fehlers. |
target |
string |
Das Ziel des Fehlers. |
Azure.Core.Foundations.ErrorResponse
Eine Antwort, die Fehlerdetails enthält.
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
Azure.Core.Foundations.InnerError
Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Eine serverdefinierte Gruppe von Fehlercodes. |
innererror |
Innerer Fehler. |
DeidentificationDocumentDetails
Details zu einem einzelnen Dokument in einem Auftrag.
Name | Typ | Beschreibung |
---|---|---|
error |
Fehler, wenn das Dokument fehlschlägt. |
|
id |
string |
ID der Dokumentdetails. |
input |
Position für die Eingabe. |
|
output |
Position für die Ausgabe. |
|
status |
Status des Dokuments. |
DeidentificationDocumentLocation
Speicherort eines Dokuments.
Name | Typ | Beschreibung |
---|---|---|
etag |
string |
Das Entitätstag für diese Ressource. |
location |
string (uri) maxLength: 1024 |
Speicherort des Dokuments im Speicher. |
OperationState
Status des Dokuments.
Wert | Beschreibung |
---|---|
Canceled |
Der Vorgang wurde vom Benutzer abgebrochen. |
Failed |
Fehler beim Vorgang. |
NotStarted |
Der Vorgang wurde nicht gestartet. |
Running |
Der Vorgang wird ausgeführt. |
Succeeded |
Der Vorgang wurde erfolgreich abgeschlossen. |
PagedDeidentificationDocumentDetails
Paged-Auflistung von DeidentificationDocumentDetails-Elementen
Name | Typ | Beschreibung |
---|---|---|
nextLink |
string (uri) |
Der Link zur nächsten Seite von Elementen |
value |
Die Elemente "DeidentificationDocumentDetails" auf dieser Seite |