Update File Processing Result

Authorizations

x-ti-app-id

string

header

required

x-ti-secret-code

string

header

required

Body

application/json

workspace_id

string

required

Workspace ID

Example:

1234567890

file_id

string

required

File ID

Example:

202412190001

data

object

required

Full field update.
Note: Even if only updating partial fields, all fields must be included.
If the incoming fields are more than the original fields, the additional fields will be added.
If the incoming fields are fewer than the original fields, the missing fields will be deleted.
If the incoming field values differ from the original field values, the field values will be updated.
If the incoming fields are identical to the original fields, the fields will be preserved.

Show child attributes

data.fields

object[]

Show child attributes

data.fields.key

string

Field name

data.fields.value

string

Field value

data.fields.position

object[]

Position of the field value. Field values may span pages or rows, so they are displayed as arrays.

Show child attributes

data.fields.position.page

integer

Page where the field is located. It is the index of the pages array

data.fields.position.vertices

integer[]

Bounding quadrilateral coordinates of the field value. The image uses the top-left as origin, array values are [top-left x, top-left y, top-right x, top-right y, bottom-right x, bottom-right y, bottom-left x, bottom-left y]

Required array length: 8 elements

Example:

[
  {
    "key": "Invoice Code",
    "value": "3100231130",
    "position": [
      {
        "page": 0,
        "vertices": [0, 0, 100, 0, 100, 100, 0, 100]
      }
    ]
  },
  {
    "key": "Invoice Number",
    "value": "28737000",
    "position": [
      {
        "page": 0,
        "vertices": [0, 0, 100, 0, 100, 100, 0, 100]
      }
    ]
  }
]

data.items

object[][]

Show child attributes

data.items.key

string

Field name

data.items.value

string

Field value

data.items.position

object[]

Position of the field value. Field values may span pages or rows, so they are displayed as arrays.

Show child attributes

data.items.position.page

integer

Page where the field is located. It is the index of the pages array

data.items.position.vertices

integer[]

Required array length: 8 elements

Example:

[
  [
    {
      "key": "Goods and Services Name",
      "value": "＊Electronic Computer＊Microcomputer Host",
      "position": [
        {
          "page": 0,
          "vertices": [0, 0, 100, 0, 100, 100, 0, 100]
        }
      ]
    },
    {
      "key": "Specification Model",
      "value": "DMS-SC68",
      "position": [
        {
          "page": 0,
          "vertices": [0, 0, 100, 0, 100, 0, 100, 0, 100]
        }
      ]
    }
  ],
  [
    {
      "key": "Goods and Services Name",
      "value": "＊Mechanical Computer＊Supercomputer Host",
      "position": [
        {
          "page": 0,
          "vertices": [0, 0, 100, 0, 100, 100, 0, 100]
        }
      ]
    },
    {
      "key": "Specification Model",
      "value": "AN/FSQ-7",
      "position": [
        {
          "page": 0,
          "vertices": [0, 0, 100, 0, 100, 100, 0, 100]
        }
      ]
    }
  ]
]

Response

200 - application/json

Successfully updated file processing result

code

integer

required

Status code

Example:

200

msg

string

required

Status description

result

object

Show child attributes

result.files

object[]

Updated file list

Show child attributes

result.files.workspace_id

string

Workspace ID

Example:

1234567890

result.files.id

string

File ID

Example:

202412190001

API Reference

File Review

Update File Processing Result

Authorizations

Body

Response