Skip to main content
GET
/
api
/
app-api
/
sip
/
platform
/
v2
/
category
/
fields
/
list
Get File Category Fields List
curl --request GET \
  --url https://docflow.textin.ai/api/app-api/sip/platform/v2/category/fields/list \
  --header 'x-ti-app-id: <api-key>' \
  --header 'x-ti-secret-code: <api-key>'
{
  "code": 200,
  "msg": "<string>",
  "result": {
    "fields": [
      {
        "name": "Invoice Code",
        "description": "Invoice code description",
        "prompt": "<string>",
        "use_prompt": true,
        "alias": [
          "<string>"
        ],
        "identity": "<string>",
        "multi_value": true,
        "duplicate_value_distinct": true,
        "transform_settings": {
          "datetime_settings": {
            "format": "yyyy-MM-dd HH:mm:ss"
          },
          "enumerate_settings": {
            "items": [
              "<string>"
            ]
          },
          "regex_settings": {
            "match": "^\\d{4}-\\d{2}-\\d{2}$",
            "replace": "$1-$2-$3"
          },
          "mismatch_action": {
            "default_value": "<string>"
          }
        },
        "id": "1234567890"
      }
    ],
    "tables": [
      {
        "id": "1234567890",
        "name": "Table1",
        "description": "Table description",
        "fields": [
          {
            "name": "Invoice Code",
            "description": "Invoice code description",
            "prompt": "<string>",
            "use_prompt": true,
            "alias": [
              "<string>"
            ],
            "identity": "<string>",
            "multi_value": true,
            "duplicate_value_distinct": true,
            "transform_settings": {
              "datetime_settings": {
                "format": "yyyy-MM-dd HH:mm:ss"
              },
              "enumerate_settings": {
                "items": [
                  "<string>"
                ]
              },
              "regex_settings": {
                "match": "^\\d{4}-\\d{2}-\\d{2}$",
                "replace": "$1-$2-$3"
              },
              "mismatch_action": {
                "default_value": "<string>"
              }
            },
            "id": "1234567890"
          }
        ]
      }
    ]
  }
}

Authorizations

​
x-ti-app-id
string
header
required
​
x-ti-secret-code
string
header
required

Query Parameters

​
workspace_id
string
required

Workspace ID

Example:

"1234567890"

​
category_id
string
required

File category ID

Example:

"1234567890"

Response

200 - application/json

Successfully retrieved file category fields list

​
code
integer
required

Status code

Example:

200

​
msg
string
required

Status description

​
result
object