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 參數

名稱	位於	必要	類型	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)	每個頁面的結果項目數目上限。

要求標頭

名稱	必要	類型	Description
x-ms-client-request-id		string (uuid)	要求不透明、全域唯一、用戶端產生的字串標識碼。

回應

名稱	類型	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

範圍

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

定義

名稱	Description
Azure.Core.Foundations.Error	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

error 物件。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	Azure.Core.Foundations.Error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	Azure.Core.Foundations.InnerError	物件，包含與目前對象有關錯誤更具體的資訊。
message	string	錯誤的人類可讀取表示法。
target	string	錯誤的目標。

Azure.Core.Foundations.ErrorResponse

Object

包含錯誤詳細數據的回應。

名稱	類型	Description
error	Azure.Core.Foundations.Error	error 物件。

Azure.Core.Foundations.InnerError

Object

物件，包含有關錯誤的更特定資訊。 根據 Azure REST API 準則 - https://aka.ms/AzureRestApiGuidelines#handling-errors。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
innererror	Azure.Core.Foundations.InnerError	內部錯誤。

DeidentificationDocumentDetails

Object

作業中單一檔的詳細數據。

名稱	類型	Description
error	Azure.Core.Foundations.Error	檔失敗時發生錯誤。
id	string	檔詳細數據的識別碼。
input	DeidentificationDocumentLocation	輸入的位置。
output	DeidentificationDocumentLocation	輸出的位置。
status	OperationState	檔的狀態。

DeidentificationDocumentLocation

Object

檔的位置。

名稱	類型	Description
etag	string	此資源的實體標籤。
location	string (uri) maxLength: 1024	記憶體中檔的位置。

OperationState

列舉型別

檔的狀態。

值	Description
NotStarted	作業尚未啟動。
Running	作業正在進行中。
Succeeded	作業已順利完成。
Failed	作業失敗。
Canceled	使用者已取消作業。

PagedDeidentificationDocumentDetails

Object

DeidentificationDocumentDetails 專案的分頁集合

名稱	類型	Description
nextLink	string (uri)	專案下一頁的連結
value	DeidentificationDocumentDetails[]	此頁面上的 DeidentificationDocumentDetails 專案