获取文档筛选字段定义

GET

/v1/documents/getFilterFields

授权

apiKey

类型

API Key (header: Authorization)

参数

请求头参数

X-Atk-User-Token

强通道：系统自签的不透明用户会话 token，用于 Client 代表用户调用。 与 X-Atk-Act-As-Source / X-Atk-Act-As-Source-Id 互斥，同时携带服务端返回 400 INVALID_DELEGATION_HEADERS。

类型

string

X-Atk-Act-As-Source

弱通道：身份 source 主张（要求 Client 已开启 actAsAllowed）。 必须与 X-Atk-Act-As-Source-Id 成对携带，缺一服务端返回 400 INCOMPLETE_ACT_AS_HEADERS；与 X-Atk-User-Token 互斥，同时携带服务端返回 400 INVALID_DELEGATION_HEADERS。

类型

string

X-Atk-Act-As-Source-Id

弱通道：身份 sourceId 主张（要求 Client 已开启 actAsAllowed）。 必须与 X-Atk-Act-As-Source 成对携带，缺一服务端返回 400 INCOMPLETE_ACT_AS_HEADERS；与 X-Atk-User-Token 互斥，同时携带服务端返回 400 INVALID_DELEGATION_HEADERS。

类型

string

查询参数

documentTypeId*

类型

string

必填

响应

OK

Content-Type

*/*

{

  

"code": 0,

  

"data": [

  

  

{

  

  

  

"attributeKey": "string",

  

  

  

"displayName": "string",

  

  

  

"valueType": "string",

  

  

  

"cardinality": "string",

  

  

  

"optionSourceType": "string",

  

  

  

"options": [

  

  

  

  

{

  

  

  

  

  

"value": "string",

  

  

  

  

  

"label": "string",

  

  

  

  

  

"sortOrder": 0,

  

  

  

  

  

"deprecated": true

  

  

  

  

}

  

  

  

],

  

  

  

"termSetId": "string",

  

  

  

"termSetCode": "string",

  

  

  

"termSetHierarchical": true

  

  

}

  

],

  

"ts": 0,

  

"rid": "string",

  

"msg": "string",

  

"success": true

}

GET

/v1/documents/getFilterFields

试验场

服务器

授权

apiKey

请求头

X-Atk-User-Token

X-Atk-Act-As-Source

X-Atk-Act-As-Source-Id

变量

键

值

documentTypeId*

示例

技术支持 VitePress OpenAPI