外观
查询字段定义详情
GET
/v1/fieldDefinitions/get
授权
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
查询参数
fieldId*
类型
必填string
响应
OK
*/*
JSON "code": 0, "data": { "id": 0, "fieldId": "string", "attributeKey": "string", "displayName": "string", "valueType": "string", "cardinality": "string", "optionSourceType": "string", "optionSourceId": "string", "optionsList": [ { "value": "string", "label": "string", "sortOrder": 0, "deprecated": true } ], "applicableTargets": [ "string" ], "required": true, "defaultValue": "string", "validationRule": "string", "listVisible": true, "system": true, "sortOrder": 0, "description": "string", "status": "string", "capabilities": { "additionalProperties": { "effect": "string", "value": "string" } }, "createTime": "string", "updateTime": "string" }, "ts": 0, "rid": "string", "msg": "string", "success": true
{
}