メインコンテンツへスキップ

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

すべてのアクティブまたは完了したトランザクションの一覧は、次の用途に利用できます：
  • 現在、手動確認ステージにあるアクティブなトランザクションを追跡する
  • アクティブなトランザクションの手動確認用リンクを取得する
  • 完了したトランザクションの結果ファイルをダウンロードする
Vantage API を使用して、識別子付きのトランザクション一覧を取得できます。より高度なフィルタを適用するには、Skill Monitor を使用できます。

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

アクティブなトランザクションの一覧を取得するには、transactions/active リソースに GET リクエストを送信します。 リクエスト本文で、以下のパラメーターを指定します。
Parameter説明
StageTypeトランザクションのステージ。
指定可能な値は次のとおりです：
- ManualReview
- CustomActivity
- Automatic（ユーザー操作を必要としないすべてのステージ。例：field の抽出）
StageName特定のアクション名（ManualReview ステージのみ）。
SkillIdSkill の識別子。
値を指定しない場合、利用可能なすべての Skill が対象となります。
SkillVersionSkill のバージョン。
値を指定しない場合、利用可能なすべてのバージョンが対象となります。
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 です。
サンプルリクエスト（Windows）: 
curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/active"
-H "Authorization: Bearer token"
他の地域でもご利用いただけます： 
# 北米
curl -X GET "https://vantage-us.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"
サンプルリクエスト（Linux）： 
curl -X GET 'https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/active' \
  -H 'Authorization: Bearer token'
他のリージョンでも利用可能です： 
# 北米
curl -X GET 'https://vantage-us.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": "レビュー",
      "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 リクエストを送信します。 サンプルリクエスト（Windows）: 
curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
  -H "Authorization: Bearer token"
他の地域でも利用可能です： 
# 北米
curl -X GET "https://vantage-us.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"
サンプルリクエスト（Linux）： 
curl -X GET 'https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id' \
  -H 'Authorization: Bearer token'
他の地域でもご利用いただけます： 
# 北米
curl -X GET 'https://vantage-us.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-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-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": "処理中",
  "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 キーには、手動確認が必要な場合、Manual Review クライアントのWebインターフェースへのリンクと Vantage のアクセス トークンが含まれます。このリンクとトークンを使用して、特定のトランザクションの分類および field 抽出結果を確認・修正できます。提供されるリンクの有効期限は168時間で、期限後は同じ方法で新しいリンクを作成して取得し、さらに168時間使用してください。詳細は、手動確認の統合を参照してください。
このリンクで認可されたユーザーは、他の documents やトランザクションを閲覧または変更することはできません。

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

完了したトランザクションの一覧を取得するには、transactions/completed リソースに GET リクエストを送信します。 リクエスト本文で、次のパラメーターを指定します:
Parameter説明
TransactionStatusトランザクションのステータス。
指定可能な値:
- Processed
- Canceled
- Failed
SkillIdSkill の識別子。
値を指定しない場合、利用可能なすべての Skill が対象になります。
SkillVersionSkill のバージョン。
値を指定しない場合、利用可能な Skill のすべてのバージョンが対象になります。
StartDate最も早いトランザクションの作成時刻（UTC 形式で指定）。
EndDate最も遅いトランザクションの作成時刻（UTC 形式で指定）。
この値を指定しない場合、現在の UTC 時刻が使用されます。
TransactionParametersキーと値の string のペアで構成されるトランザクションの Parameter の一覧。これらのパラメーターは追加のユーザー情報（例: クライアント名）を提供します。
Parameter は次の形式で指定します: TransactionParameters={“key”: “string_1”,”value”:”string”}&TransactionParameters={“key”: “string_2”,”value”:”string”}
DocumentParametersキーと値の string のペアで構成されるドキュメントの Parameter の一覧。これらのパラメーターは追加のドキュメント情報（例: ファイル名）を提供します。
Parameter は次の形式で指定します: 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
}