メインコンテンツへスキップ
トランザクションおよびファイル登録Parameterは、追加のユーザー情報（例：クライアント名、ドキュメントタイプ、ファイルソース情報）を提供するために設計された、キーと値の文字列ペアで構成されるParameterです。これらはトランザクションまたはトランザクション内のdocumentsと共に処理のために渡されます。これらのParameterはすべてのワーカーで利用可能であり、さまざまな本番環境のシナリオで使用できます：
  • ABBYY Vantage を使用するプログラムは、レポート作成やカスタム処理手順の作成（例: 顧客ごとに取引先データ カタログをフィルタリングするなど）の目的で、各トランザクションにエンドクライアント属性を付与します。
  • Scanning Station クライアント（またはトランザクションの別の送信元）は、Document バッチの登録用 Parameter（外部相関 ID など）を渡すことができます。
登録パラメータは Vantage API を使用して設定できます。
  1. 空のトランザクションを作成する場合や launch メソッドを使用してトランザクションを初期化する場合は、以下の例のように transactions リソースに POST リクエストを送信します。
POST https://your-server/api/publicapi/v1/transactions
or 
POST https://your-server/api/publicapi/v1/transactions/launch?skillId=skill-id
リクエストボディで登録パラメータを指定し、次のコマンドを実行します: 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
リクエストボディで登録パラメータを指定し、次のコマンドを実行します: 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 "[email protected];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 '[email protected];type=image/tiff'
重要: key-value 型の Parameter は最大 10 個まで設定でき、key の Parameter には最大 128 文字、value の Parameter には最大 256 文字まで指定できます。これらの Parameter の値は、一度設定すると変更できません。
登録Parameterの値を読み取ることができます:
  • カスタム アクティビティ スクリプト内では、
  • Output アクティビティの 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/&lt;transaction-id&gt;/files/&lt;file-id&gt;/download リソースに対して download メソッドを呼び出します。
GET https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download