Skip to content

按文档获取表单 Schema(含资源级模板字段、遗留字段、当前值;带 sourceType 字段标识来源)

GET
/v1/documents/getFormSchema

授权

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

查询参数

docId*
类型
string
必填

响应

OK

*/*
JSON
{
  
"code": 0,
  
"data": {
  
  
"typeId": "string",
  
  
"typeName": "string",
  
  
"templateGroups": [
  
  
  
{
  
  
  
  
"templateId": "string",
  
  
  
  
"templateName": "string",
  
  
  
  
"source": "string",
  
  
  
  
"fields": [
  
  
  
  
  
{
  
  
  
  
  
  
"fieldId": "string",
  
  
  
  
  
  
"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,
  
  
  
  
  
  
"required": true,
  
  
  
  
  
  
"defaultValue": "string",
  
  
  
  
  
  
"validationRule": "string",
  
  
  
  
  
  
"sortOrder": 0,
  
  
  
  
  
  
"capabilities": {
  
  
  
  
  
  
  
"additionalProperties": {
  
  
  
  
  
  
  
  
"effect": "string",
  
  
  
  
  
  
  
  
"value": "string"
  
  
  
  
  
  
  
}
  
  
  
  
  
  
},
  
  
  
  
  
  
"value": {
  
  
  
  
  
  
},
  
  
  
  
  
  
"values": [
  
  
  
  
  
  
  
{
  
  
  
  
  
  
  
}
  
  
  
  
  
  
],
  
  
  
  
  
  
"sourceType": "string",
  
  
  
  
  
  
"sourceTemplateId": "string",
  
  
  
  
  
  
"sourceTemplateName": "string"
  
  
  
  
  
}
  
  
  
  
]
  
  
  
}
  
  
],
  
  
"legacyFields": [
  
  
  
{
  
  
  
  
"fieldId": "string",
  
  
  
  
"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,
  
  
  
  
"required": true,
  
  
  
  
"defaultValue": "string",
  
  
  
  
"validationRule": "string",
  
  
  
  
"sortOrder": 0,
  
  
  
  
"capabilities": {
  
  
  
  
  
"additionalProperties": {
  
  
  
  
  
  
"effect": "string",
  
  
  
  
  
  
"value": "string"
  
  
  
  
  
}
  
  
  
  
},
  
  
  
  
"value": {
  
  
  
  
},
  
  
  
  
"values": [
  
  
  
  
  
{
  
  
  
  
  
}
  
  
  
  
],
  
  
  
  
"sourceType": "string",
  
  
  
  
"sourceTemplateId": "string",
  
  
  
  
"sourceTemplateName": "string"
  
  
  
}
  
  
]
  
},
  
"ts": 0,
  
"rid": "string",
  
"msg": "string",
  
"success": true
}

试验场

服务器
授权
请求头
变量

示例

技术支持 VitePress OpenAPI