List Job Documents - List Job Documents

Service:: Health Data

API Version:: 2024-11-15

List processed documents within a job.
Resource list operation template.

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string (uri)	Url of your De-identification Service.
name	path	True	string minLength: 3 maxLength: 36 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$	The name of a job.
api-version	query	True	string minLength: 1	The API version to use for this operation.
continuationToken	query		string	Token to continue a previous query.
maxpagesize	query		integer (int32)	The maximum number of result items per page.

Request Header

Name	Required	Type	Description
x-ms-client-request-id		string (uuid)	An opaque, globally-unique, client-generated string identifier for the request.

Responses

Name	Type	Description
200 OK	PagedDeidentificationDocumentDetails	The request has succeeded. Headers x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Name

Type

Description

200 OK

PagedDeidentificationDocumentDetails

The request has succeeded.

Headers

x-ms-client-request-id: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

An unexpected error response.

Headers

x-ms-error-code: string

Security

AadToken

The Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

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

Examples

List processed documents within a job.

Sample request

HTTP

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

Sample response

Status code:: 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=="
}

Definitions

Name	Description
Azure.Core.Foundations.Error	The error object.
Azure.Core.Foundations.ErrorResponse	A response containing error details.
Azure.Core.Foundations.InnerError	An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.
DeidentificationDocumentDetails	Details of a single document in a job.
DeidentificationDocumentLocation	Location of a document.
OperationState	Status of the document.
PagedDeidentificationDocumentDetails	Paged collection of DeidentificationDocumentDetails items

Azure.Core.Foundations.Error

Object

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Azure.Core.Foundations.Error[]	An array of details about specific errors that led to this reported error.
innererror	Azure.Core.Foundations.InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

Azure.Core.Foundations.ErrorResponse

Object

A response containing error details.

Name	Type	Description
error	Azure.Core.Foundations.Error	The error object.

Azure.Core.Foundations.InnerError

Object

An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	Azure.Core.Foundations.InnerError	Inner error.

DeidentificationDocumentDetails

Object

Details of a single document in a job.

Name	Type	Description
error	Azure.Core.Foundations.Error	Error when document fails.
id	string	Id of the document details.
input	DeidentificationDocumentLocation	Location for the input.
output	DeidentificationDocumentLocation	Location for the output.
status	OperationState	Status of the document.

DeidentificationDocumentLocation

Object

Location of a document.

Name	Type	Description
etag	string	The entity tag for this resource.
location	string (uri) maxLength: 1024	Location of document in storage.

OperationState

Enumeration

Status of the document.

Value	Description
NotStarted	The operation has not started.
Running	The operation is in progress.
Succeeded	The operation has completed successfully.
Failed	The operation has failed.
Canceled	The operation has been canceled by the user.

PagedDeidentificationDocumentDetails

Object

Paged collection of DeidentificationDocumentDetails items

Name	Type	Description
nextLink	string (uri)	The link to the next page of items
value	DeidentificationDocumentDetails[]	The DeidentificationDocumentDetails items on this page