List Job Documents - List Job Documents

서비스:: Health Data

API 버전:: 2024-11-15

작업 내에서 처리된 문서를 나열합니다.
리소스 목록 작업 템플릿입니다.

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 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string (uri)	식별 해제 서비스의 URL입니다.
name	path	True	string minLength: 3 maxLength: 36 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_]+[a-zA-Z0-9]$	작업의 이름입니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.
continuationToken	query		string	이전 쿼리를 계속하기 위한 토큰입니다.
maxpagesize	query		integer (int32)	페이지당 결과 항목의 최대 수입니다.

요청 헤더

Name	필수	형식	Description
x-ms-client-request-id		string (uuid)	요청에 대한 불투명하고 전역적으로 고유한 클라이언트 생성 문자열 식별자입니다.

응답

Name	형식	Description
200 OK	PagedDeidentificationDocumentDetails	요청이 성공했습니다. 헤더 x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	예기치 않은 오류 응답입니다. 헤더 x-ms-error-code: string

Name

형식

Description

200 OK

PagedDeidentificationDocumentDetails

요청이 성공했습니다.

헤더

x-ms-client-request-id: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

예기치 않은 오류 응답입니다.

헤더

x-ms-error-code: string

보안

AadToken

Azure Active Directory OAuth2 흐름

형식: oauth2
Flow: accessCode
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
토큰 URL: https://login.microsoftonline.com/common/oauth2/token

범위

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

예제

List processed documents within a job.

샘플 요청

HTTP

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

샘플 응답

상태 코드:: 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=="
}

정의

Name	Description
Azure.Core.Foundations.Error	오류 개체입니다.
Azure.Core.Foundations.ErrorResponse	오류 세부 정보가 포함된 응답입니다.
Azure.Core.Foundations.InnerError	오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Azure REST API 지침에 따라 - https://aka.ms/AzureRestApiGuidelines#handling-errors.
DeidentificationDocumentDetails	작업의 단일 문서에 대한 세부 정보입니다.
DeidentificationDocumentLocation	문서의 위치입니다.
OperationState	문서의 상태입니다.
PagedDeidentificationDocumentDetails	DeidentificationDocumentDetails 항목의 페이징된 컬렉션

Azure.Core.Foundations.Error

Object

오류 개체입니다.

Name	형식	Description
code	string	서버에서 정의한 오류 코드 집합 중 하나입니다.
details	Azure.Core.Foundations.Error[]	이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
innererror	Azure.Core.Foundations.InnerError	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.
target	string	오류의 대상입니다.

Azure.Core.Foundations.ErrorResponse

Object

오류 세부 정보가 포함된 응답입니다.

Name	형식	Description
error	Azure.Core.Foundations.Error	오류 개체입니다.

Azure.Core.Foundations.InnerError

Object

오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Azure REST API 지침에 따라 - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	형식	Description
code	string	서버에서 정의한 오류 코드 집합 중 하나입니다.
innererror	Azure.Core.Foundations.InnerError	내부 오류입니다.

DeidentificationDocumentDetails

Object

작업의 단일 문서에 대한 세부 정보입니다.

Name	형식	Description
error	Azure.Core.Foundations.Error	문서가 실패하면 오류가 발생합니다.
id	string	문서 세부 정보의 ID입니다.
input	DeidentificationDocumentLocation	입력 위치입니다.
output	DeidentificationDocumentLocation	출력 위치입니다.
status	OperationState	문서의 상태입니다.

DeidentificationDocumentLocation

Object

문서의 위치입니다.

Name	형식	Description
etag	string	이 리소스의 엔터티 태그입니다.
location	string (uri) maxLength: 1024	스토리지에 있는 문서의 위치입니다.

OperationState

열거형

문서의 상태입니다.

값	Description
NotStarted	작업이 시작되지 않았습니다.
Running	작업이 진행 중입니다.
Succeeded	작업이 성공적으로 완료되었습니다.
Failed	작업이 실패했습니다.
Canceled	사용자가 작업을 취소했습니다.

PagedDeidentificationDocumentDetails

Object

DeidentificationDocumentDetails 항목의 페이징된 컬렉션

Name	형식	Description
nextLink	string (uri)	항목의 다음 페이지에 대한 링크
value	DeidentificationDocumentDetails[]	이 페이지의 DeidentificationDocumentDetails 항목