トランザクションの一覧を取得する

アクティブまたは完了したすべてのトランザクションの一覧は、次の目的で使用できます。

現在手動確認ステージにあるアクティブなトランザクションを追跡する。
アクティブなトランザクションの手動確認用リンクを取得する。
完了したトランザクションの結果ファイルをダウンロードする。

Vantage API を使用して、トランザクションの ID とともに一覧を取得できます。より高度なフィルターを適用するには、Skill Monitor を使用できます。

アクティブなトランザクションの一覧

アクティブなトランザクションの一覧を取得するには、transactions/active リソースに GET リクエストを送信します。リクエスト本文では、次のパラメーターを指定します。

Parameter	Description
StageType	トランザクションのステージ。指定可能な値は次のとおりです。 - ManuaReview - CustomActivity - Automatic (ユーザー操作が不要なすべてのステージ。例: field の抽出)
StageName	特定のアクションの名前 (ManualReview ステージでのみ使用) 。
SkillId	Skill の識別子。値を指定しない場合は、利用可能なすべての Skill が対象になります。
SkillVersion	Skill のバージョン。値を指定しない場合は、利用可能な Skill のすべてのバージョンが対象になります。
StartDate	最も早いトランザクションの作成時刻 (UTC 形式で指定する必要があります) 。
EndDate	最も遅いトランザクションの作成時刻 (UTC 形式で指定する必要があります) 。この値を指定しない場合は、現在の UTC 時刻が使用されます。
TransactionParameters	キーと値の string のペアからなるトランザクションパラメーターの一覧。これらのパラメーターにより、追加のユーザー情報 (例: クライアント名) を指定できます。パラメーターは次の形式で指定する必要があります: `TransactionParameters={“key”: “string_1”,”value”:”string”}&TransactionParameters={“key”: “string_2”,”value”:”string”}`
DocumentParameters	キーと値の string のペアからなるドキュメントパラメーターの一覧。これらのパラメーターにより、追加のドキュメント情報 (例: ファイル名) を指定できます。パラメーターは次の形式で指定する必要があります: `DocumentParameters={“key”: “string_1”,”value”:”string”}&DocumentParameters={“key”: “string_2”,”value”:”string”}`
Offset	ページングのオフセット。このパラメーターのデフォルト値は 0 です。
Limit	ページングの上限値。このパラメーターは必須です。このパラメーターのデフォルト値は 0 です。

サンプルリクエスト: Skill識別子が指定されたリクエストに対するレスポンスには、次のようなJSONファイルが含まれます。

{
  "items": [
    {
      "stage": "ManualReview",
      "stageName": "Review",
      "seqId": 13758,
      "transactionId": "56a50415-fe1d-4493-81ba-97ff07e3ffce",
      "createTimeUtc": "2023-09-11T13:53:30.633Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "App",
          "value": "PublicAPI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "Index",
          "value": "0"
        },
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "BillofLading_1.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "PublicAPI"
        }
      ],
      "skillId": "workspace.default.processing",
      "skillVersion": 18,
      "documentCount": 1
    }
  ],
  "totalItemCount": 7
}

ステージとアクションが指定されたリクエストに対するレスポンスには、すべてのアクティブなトランザクションを含む、次のようなJSONファイルが返されます。

{
  "items": [
    {
      "stage": "ManualReview",
      "stageName": "Review2",
      "seqId": 13852,
      "transactionId": "e646754e-d854-4b21-af91-58cb63ead7a6",
      "createTimeUtc": "2023-09-11T14:04:37.97Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "App",
          "value": "PublicAPI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "Index",
          "value": "0"
        },
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "BillofLading_1.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "PublicAPI"
        }
      ],
      "documentCount": 1
    }
  ],
  "totalItemCount": 2
}

現在アクティブなトランザクションに対して、手動確認クライアントリンクを取得することも可能です。これを行うには、リクエスト URI にトランザクション識別子を含めて、transactions/<transaction_id> リソースに対して GET リクエストを送信します。サンプルリクエスト：レスポンスには、次のようなコードが含まれます。 manualReviewLink キーには、手動確認クライアントの Web インターフェイスへのリンクと、手動確認が必要な場合の Vantage アクセストークンが含まれます。このリンクとトークンを使用して、特定のトランザクションの分類および field の抽出結果を確認および修正できます。提供されたリンクは 168 時間有効で、有効期限後は同じ方法で新しいリンクを作成して取得し、さらに 168 時間利用する必要があります。詳しくは、手動確認の統合を参照してください。

このリンク経由で認証されたユーザーは、他の文書やトランザクションを閲覧または変更することはできません。

完了したトランザクションの一覧

完了したトランザクションの一覧を取得するには、transactions/completed リソースに対して GET リクエストを送信します。リクエストボディでは、次のパラメーターを指定します。

Parameter	Description
TransactionStatus	トランザクションのステータス。指定可能な値は次のとおりです。 - Processed - Canceled - Failed
SkillId	Skill の識別子。値が指定されていない場合、利用可能なすべての Skill が対象となります。
SkillVersion	Skill のバージョン。値が指定されていない場合、利用可能なすべての Skill のバージョンが対象となります。
StartDate	最も早いトランザクションの作成時刻 (UTC 形式で指定する必要があります) 。
EndDate	最も遅いトランザクションの作成時刻 (UTC 形式で指定する必要があります) 。この値が指定されていない場合は、現在の UTC 時刻が使用されます。
TransactionParameters	キーと値の文字列ペアで構成されるトランザクションパラメーターの一覧。このパラメーターにより、追加のユーザー情報 (例: 顧客名) を指定できます。パラメーターは次の形式で指定する必要があります: `TransactionParameters={“key”: “string_1”,”value”:”string”}&TransactionParameters={“key”: “string_2”,”value”:”string”}`
DocumentParameters	キーと値の文字列ペアで構成されるドキュメントパラメーターの一覧。このパラメーターにより、追加のドキュメント情報 (例: ファイル名) を指定できます。パラメーターは次の形式で指定する必要があります: `DocumentParameters={“key”: “string_1”,”value”:”string”}&DocumentParameters={“key”: “string_2”,”value”:”string”}`
Offset	ページネーションのオフセット。このパラメーターの既定値は 0 です。
Limit	ページネーションの上限値。必須のパラメーターです。このパラメーターの既定値は 0 です。

レスポンスには、すべての完了したトランザクションと、次の例のような処理されたページ数を含む JSON ファイルが返されます。

{
  "items": [
    {
      "status": "FinishedSuccessfully",
      "pageCount": 1,
      "seqId": 13705,
      "transactionId": "fc9920fe-f788-47f8-9972-b767493faed9",
      "createTimeUtc": "2023-09-11T13:47:50.273Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "App",
          "value": "PublicAPI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "Index",
          "value": "0"
        },
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "BillofLading_1.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "PublicAPI"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 29842,
      "transactionId": "c0dd3e08-f295-4c6c-b919-31eaa67817cc",
      "createTimeUtc": "2023-09-12T19:28:01.27Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed _1_.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 36254,
      "transactionId": "8391871e-abf5-41bc-8a66-1059418a3843",
      "createTimeUtc": "2023-09-13T08:53:41.9Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed _1_.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 36632,
      "transactionId": "7f7cd557-a03e-42e3-a454-e7981e8e9fc0",
      "createTimeUtc": "2023-09-13T09:35:27.48Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 36663,
      "transactionId": "c9b3cd4d-d90f-48be-adc2-99985ece4e11",
      "createTimeUtc": "2023-09-13T09:38:29.573Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "documentCount": 1
    }
  ],
  "totalItemCount": 5
}

​アクティブなトランザクションの一覧

​完了したトランザクションの一覧

アクティブなトランザクションの一覧

完了したトランザクションの一覧