HTTP リクエスト
GET https://api-{location-id}.flexicapture.com/v2/task/{id}
{location-id} は、ご使用のサポートされているロケーションに置き換えてください。
パス パラメーター
| パラメーター | 型 | 説明 |
|---|---|---|
id | path, string | 必須。タスクID。 |
レスポンス
CaptureTask のインスタンスが含まれます。
{
"id": "string",
"number": "string",
"verification_id": "string",
"type": "ic",
"properties": {
"property_name": "string"
},
"email": "string",
"account": "string",
"application": "string",
"created": "YYYY-MM-DDT00:00:00.000",
"started": "YYYY-MM-DDT00:00:00.000",
"action_required": "YYYY-MM-DDT00:00:00.000",
"billed": "YYYY-MM-DDT00:00:00.000",
"delivered": "YYYY-MM-DDT00:00:00.000",
"deleted": "YYYY-MM-DDT00:00:00.000",
"progress": 0,
"status": "Submitted",
"is_deleted": true,
"is_demo": true,
"is_billed": true,
"documents_count": 0,
"pages_count": 0,
"documents": [
{
"files": {},
"data": {},
"is_moved": true
}
]
}
CaptureTask
| field | 型 | 説明 |
|---|---|---|
id | string | 必須。一意のタスクID。 |
number | string | 必須。タスク番号。 |
verification_id | string | 必須。このIDは、verification ページ (https://{cloud-host}/verification/{verification_id}) を開くために使用されます。 |
type | string | 必須。タスクタイプ。サポートされる型: ic: 請求書取り込み、dc: ドキュメント取り込み。 |
properties | object | 任意。処理設定またはカスタム登録パラメーター。名前と値のペアを任意の数だけ指定できます。 |
email | string | 必須。タスクの作成に使用したメールアドレス。 |
account | string | 必須。タスクの作成に使用したアカウントID。 |
application | string | 必須。タスクの作成に使用したアプリケーションID。 |
created | string ($date-time) | 必須。タスクの作成日。 |
started | string ($date-time) | 任意。タスクの開始日。 |
action_required | string ($date-time) | 任意。タスクが WaitForAction ステータスになった日付。 |
billed | string ($date-time) | 任意。タスクの請求日。 |
delivered | string ($date-time) | 任意。タスクの完了日。 |
deleted | string ($date-time) | 任意。データの削除日。 |
progress | number ($double) | 必須。タスク全体の進捗。 |
status | string | 必須。タスクのステータス。使用可能なステータス: Submitted, InProgress, WaitForAction, Done, Failed, Canceled。 |
is_deleted | boolean | 必須。タスクデータが削除されたかどうかを示します。 |
is_demo | boolean | 必須。タスクがデモアプリケーションで作成されたかどうかを示します。 |
is_billed | boolean | 必須。タスクが請求済みかどうかを示します。 |
documents_count | integer ($int32) | 任意。タスク内のドキュメント数。 |
pages_count | integer ($int32) | 任意。タスク内のページ数。 |
documents[] | object (DataCaptureDocumentModel) | 必須。タスク内のドキュメント。 |
DataCaptureDocumentModel
| field | 型 | 説明 |
|---|---|---|
files | object (DataCaptureFileLinkModel) | 必須。ドキュメントにリンクされているファイルのリスト。 |
data | string | 任意。ドキュメントのデータ。 |
is_moved | boolean | 必須。Verification中にドキュメントが削除されたかどうか。 |
DataCaptureFileLinkModel
| field | 型 | 説明 |
|---|---|---|
id | string | 必須。ファイル ID。 |
token | string | 必須。ファイルのアクセストークン。 |
name | string | 必須。ファイル名。 |