Skip to content

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

GET
/v1/documents/getFormSchema

参数

请求头参数

Authorization*

访问令牌以 Bearer 方案在 HTTP Authorization 请求头携带。请在此填入完整值(含 Bearer 前缀),例如:Bearer <accessToken>

类型
string
必填
示例"Bearer <accessToken>"
X-Atk-User-Token

强通道(可选):以某已签发的 atkonbase 用户会话 token 调用,ACL 解析与操作归属走该用户。与弱通道 X-Atk-Act-As-Source(-Id) 互斥——同时携带返回业务码 101008。两个 SDK 均由 client 侧拦截器统一注入(actAsToken()),此处仅为门户演练暴露。

类型
string
X-Atk-Act-As-Source

弱通道(可选):外部身份来源标识,须与 X-Atk-Act-As-Source-Id 成对携带,缺一返回业务码 101009。仅当该 Client 的 act_as_user_allowed=true 时生效,否则静默降级为 APP_ONLY;与强通道互斥。两个 SDK 均由 client 侧拦截器统一注入(actAsSource()),此处仅为门户演练暴露。

类型
string
X-Atk-Act-As-Source-Id

弱通道(可选):外部身份在其来源系统内的 ID,须与 X-Atk-Act-As-Source 成对携带,缺一返回业务码 101009

类型
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