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

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

現在手動確認ステージにあるアクティブなトランザクションを追跡する。
アクティブなトランザクションの手動確認用リンクを取得する。
完了したトランザクションの結果ファイルをダウンロードする。
すでに取得済みのものを管理することなく、完了済みトランザクションを完了順に受け取る。

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	キーと値の文字列のペアからなるトランザクションパラメーターの一覧。これらのパラメーターにより、追加のユーザー情報 (例: クライアント名) を指定できます。パラメーターは次の形式で指定する必要があります: `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	ページネーションの上限値。このパラメーターは必須です。指定可能な値は 1 ～ 1000 です。

サンプルリクエスト:

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/active"
-H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/active"
-H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/active"
-H "Authorization: Bearer token"

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 リクエストを送信します。サンプルリクエスト：

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"

レスポンスには、次のようなコードが含まれます。

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "Processing",
  "manualReviewLink": "https://vantage-us.abbyy.com/api/publicapi/v1/verify?documentIds=9838448d-72ae-4e9a-b071-2bb16f732e46",
  "sourceFiles": [
    {
      "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
      "name": "Invoice07.JPG"
    }
  ]
}

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "Processing",
  "manualReviewLink": "https://vantage-eu.abbyy.com/api/publicapi/v1/verify?documentIds=9838448d-72ae-4e9a-b071-2bb16f732e46",
  "sourceFiles": [
    {
      "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
      "name": "Invoice07.JPG"
    }
  ]
}

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "Processing",
  "manualReviewLink": "https://vantage-au.abbyy.com/api/publicapi/v1/verify?documentIds=9838448d-72ae-4e9a-b071-2bb16f732e46",
  "sourceFiles": [
    {
      "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
      "name": "Invoice07.JPG"
    }
  ]
}

manualReviewLink キーには、手動確認クライアントの Web インターフェイスへのリンクと、手動確認が必要な場合の Vantage アクセストークンが含まれます。このリンクとトークンを使用して、特定のトランザクションの分類および field の抽出結果を確認および修正できます。提供されたリンクは 168 時間有効で、有効期限後は同じ方法で新しいリンクを作成して取得し、さらに 168 時間利用する必要があります。詳しくは、手動確認の統合を参照してください。

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

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

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

Parameter	Description
TransactionStatus	トランザクションのステータス。指定可能な値は次のとおりです。 - Processed - Cancelled - 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	ページネーションの上限値。必須のパラメーターです。指定可能な値は 1 ～ 1000 です。

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

{
  "items": [
    {
      "status": "Processed",
      "pageCount": 1,
      "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"
        }
      ],
      "skillId": "3f6b1c2a-8d4e-4f5a-9b0c-7e1d2a3b4c5d",
      "skillVersion": 1,
      "documentCount": 1
    },
    {
      "status": "Processed",
      "pageCount": 2,
      "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"
        }
      ],
      "skillId": "3f6b1c2a-8d4e-4f5a-9b0c-7e1d2a3b4c5d",
      "skillVersion": 2,
      "documentCount": 1
    },
    {
      "status": "Processed",
      "pageCount": 2,
      "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"
        }
      ],
      "skillId": "3f6b1c2a-8d4e-4f5a-9b0c-7e1d2a3b4c5d",
      "skillVersion": 2,
      "documentCount": 1
    },
    {
      "status": "Processed",
      "pageCount": 2,
      "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"
        }
      ],
      "skillId": "3f6b1c2a-8d4e-4f5a-9b0c-7e1d2a3b4c5d",
      "skillVersion": 2,
      "documentCount": 1
    },
    {
      "status": "Processed",
      "pageCount": 2,
      "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"
        }
      ],
      "skillId": "3f6b1c2a-8d4e-4f5a-9b0c-7e1d2a3b4c5d",
      "skillVersion": 2,
      "documentCount": 1
    }
  ],
  "totalItemCount": 5
}

完了したトランザクションの取得

transactions/completed リソースは指定した期間内の完了したトランザクションをすべて返すため、結果を収集する連携処理では、どのトランザクションを既に処理済みかを自前で記録しておく必要があります。transactions/pending-pickup リソースを使えば、このような管理は不要です。このリソースは、まだ削除していない完了済みトランザクションを完了順に返し、削除したトランザクションはリストから外れます。一般的な取得ループは次のとおりです。

transactions/pending-pickup に GET リクエストを送信します。
返された各トランザクションについて、結果ファイルをダウンロードします。source files と結果ファイルのダウンロードを参照してください。
transactions/<transaction_id> への DELETE リクエストでトランザクションを削除します。これにより、ピックアップ一覧から除外されます。
レスポンスに nextCursor が含まれている場合は、そのカーソルを指定して手順 1 から繰り返し、次のページを取得します。nextCursor が空の場合は、リストの末尾に到達しています。ポーリング間隔だけ待機してから、カーソルを指定せずに再度実行してください。

リクエストでは、次のパラメータを指定します。

Parameter	Description
Limit	1 ページで返すトランザクションの最大数。指定可能な値: 1～1000。
Cursor	前回のレスポンスで返された `nextCursor` の値。省略すると、削除されていない最も古い完了済みトランザクションから開始します。カーソルは内容を解釈しない文字列として扱ってください。
Status	トランザクションのステータス。指定可能な値は次のとおりです。 - Processed - Cancelled - Failed 値を指定しない場合は、これらすべてのステータスのトランザクションが返されます。複数のステータスで絞り込むには、値をカンマで区切ります。
SkillId	Skill の識別子。値を指定しない場合は、利用可能なすべての Skill が対象となり、Skill のすべてのバージョンのトランザクションが返されます。

リクエスト例:

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/pending-pickup?Limit=100&Status=Processed" \
  -H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/pending-pickup?Limit=100&Status=Processed" \
  -H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/pending-pickup?Limit=100&Status=Processed" \
  -H "Authorization: Bearer token"

レスポンスには、完了済みトランザクションと次ページ用のカーソルが含まれます。

{
  "items": [
    {
      "transactionId": "fc9920fe-f788-47f8-9972-b767493faed9",
      "status": "Processed",
      "finishedTimeUtc": "2026-06-10T12:34:56Z"
    },
    {
      "transactionId": "c0dd3e08-f295-4c6c-b919-31eaa67817cc",
      "status": "Failed",
      "finishedTimeUtc": "2026-06-10T12:35:02Z"
    }
  ],
  "nextCursor": "Q3Vyc29yRXhhbXBsZQ=="
}

次のページを取得するには、リクエストにカーソルを渡します。

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/pending-pickup?Limit=100&Cursor=Q3Vyc29yRXhhbXBsZQ==" \
  -H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/pending-pickup?Limit=100&Cursor=Q3Vyc29yRXhhbXBsZQ==" \
  -H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/pending-pickup?Limit=100&Cursor=Q3Vyc29yRXhhbXBsZQ==" \
  -H "Authorization: Bearer token"

ピックアップ連携を構築する際は、次の点に留意してください。

配信は「最低1回」です。 完了したトランザクションは必ず1回以上一覧に現れますが、DELETEリクエストから実際に削除されるまでの数分間など、状況によっては同じ transactionId が複数回現れることがあります。処理済みの識別子を保存しておき、再度現れたものはスキップしてください。
有効期限が切れる前に結果を取得してください。 トランザクションがピックアップ一覧に残るのは、そのデータがVantageに保持されている間だけです。取得前にデータ保持ポリシーによってトランザクションが削除された場合、一覧には表示されなくなります。過去の記録はReporting APIから引き続き参照できます。
権限。 このリクエストは、transactions/completed と同様に、認証されたユーザーがアクセス権限を持つSkillのトランザクションのみを返します。
ポーリング間隔。 ピックアップ一覧はプル型のみです。連続的に呼び出すのではなく、結果が必要になる頻度に合わせたスケジュールでポーリングしてください。一般的な指針については、ポーリングを参照してください。

Overview

Developer Guide

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

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

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

完了したトランザクションの取得

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

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

​完了したトランザクションの取得

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

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

完了したトランザクションの取得