メインコンテンツへスキップ
トランザクションおよびファイルの登録パラメータは、追加のユーザー情報（たとえば、クライアント名、ドキュメント種別、ファイルのソース情報）を提供するために設計された、キーと値のstringペアで構成されるパラメータです。これらはトランザクション本体またはそのdocumentsとともに処理側へ渡されます。これらのパラメータはすべてのワーカーから利用でき、さまざまな運用シナリオで使用できます。
  • ABBYY Vantage を使用するプログラムは、レポート作成やカスタム処理手順の作成（例: クライアント別にカウンターパーティのデータ カタログをフィルタリング）を目的として、各トランザクションにエンドクライアント属性を付与します。
  • Scanning Station クライアント（またはトランザクションの別の起点）からは、ドキュメント バッチの登録パラメータ（外部相関IDなど）を渡すことができます。
登録パラメータは Vantage API を使用して設定できます。
  1. 空のトランザクションを作成する場合、または launch メソッドでトランザクションを初期化する場合。これを行うには、以下の例のように transactions リソースに POST リクエストを送信します。
POST https://your-server/api/publicapi/v1/transactions
または 
POST https://your-server/api/publicapi/v1/transactions/launch?skillId=skill-id
リクエスト本文で登録用のParameterを指定し、次のコマンドを実行します: Windows の場合: 
curl -X POST "https://your-server/api/publicapi/v1/transactions" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json" \
-d "{\"skillId\":\"123\"}" \
   "registrationParameters": [
     {
       "key": "key1",
       "value": "value1"
     }
   ]
Linux の場合： 
curl -X POST 'https://your-server/api/publicapi/v1/transactions' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: application/json' \
-d '{"skillId":"123"}' \
   'registrationParameters': [
     {
       'key': 'key1',
       'value': 'value1'
     }
   ]
  1. トランザクションまたは Document にファイルをアップロードする場合。次の例のように、transactions/<transaction-id>/files リソースに POST リクエストを送信します。
POST https://your-server/api/publicapi/v1/transactions/transaction-id/files
リクエストボディで登録用のParameterを指定し、次のコマンドを実行します。 Windows の場合： 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/files" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Model={
   \"files\": [
     {
       \"index\": 0,
       \"imageProcessingOptions\": {
         \"autoCrop\": \"Default\",
         \"autoOrientation\": \"Default\"
       },
       \"registrationParameters\": [
         {
           \"key\": \"key1\",
           \"value\": \"value1\"
         }
       ]
     }
   ]
}" \
-F "Files=@testImage.tif;type=image/tiff"
Linux の場合: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/files' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Model={
   "files": [
     {
       "index": 0,
       "imageProcessingOptions": {
         "autoCrop": "Default",
         "autoOrientation": "Default"
       },
       "registrationParameters": [
         {
           "key": "key1",
           "value": "value1"
         }
       ]
     }
   ]
}' \
-F 'Files=@testImage.tif;type=image/tiff'
重要 キー・値タイプの Parameter は最大10個まで設定できます。キーの Parameter は最大128文字、値の Parameter は最大256文字まで指定できます。これらの Parameter の値は一度設定すると変更できません。
登録 Parameter の値は次の場所で読み取れます:
  • Custom activity のスクリプト内、
  • Output activity の External Export スクリプト内、
  • ビジネスルール内。
Vantage API を使用して、登録 Parameter の値を次の方法で取得できます:
  1. transactions/<transaction-id>/registrationParameters リソースに対して registrationParameters メソッドを呼び出す:
GET https://your-server/api/publicapi/v1/transactions/transaction-id/registrationParameters/
レスポンスは次のようになります： 
[
  {
    "key": "key1",
    "value": "value1"
  }
]
  1. アップロードされるファイルと同時に値をJSON形式で取得するには、transactions/<transaction-id>/files/<file-id>/download リソースに対して download メソッドを呼び出します。
GET https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download