跳转到主要内容
处理事务和文件的注册参数由键值字符串对组成，用于提供附加的用户信息（例如客户名称、文档类型以及文件来源信息）。它们会随处理事务或该事务中的 documents 一起传递进行处理。这些参数对所有工作节点可用，并可用于各类生产场景：
  • 使用 ABBYY Vantage 的程序会为每个处理事务附加终端客户属性，以便编制报告并创建自定义处理流程（例如按客户筛选对方数据目录（data catalog））。
  • 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'
重要！ 最多可使用 10 个键值对类型的 Parameter，其中键的长度最多为 128 个字符，值的长度最多为 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. 通过调用 transactions/<transaction-id>/files/<file-id>/download 资源的 download 方法，在上传文件的同时以 JSON 格式获取这些值：
GET https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download