GetSchema API参考-云联络中心-阿里云-伶鹊(Cloud Contact Center)-阿里云帮助中心

调用GetSchema接口获取指定实例中的Schema及其字段定义。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
SchemaId	string	是	schema id	profile
RequestId	string	否	请求 ID。	03C67DAD-EB26-41D8-949D-9B0C470FB716
InstanceId	string	是	实例 ID	b0eb2742-f37e-4c67-82d4-25c651c1xxxx

返回参数

名称	类型	描述	示例值
	object	GetSchemaResponse
Data	object	数据。
InstanceId	string	实例 ID。	5e0964fd-951c-4e45-b518-d09d4d2db8ca
Id	string	schema id	profile
Description	string	描述	客户profile
Properties	object	字段列表
	object	字段
DisplayName	string	显示名称	姓名
Description	string	描述	name
Name	string	名称	name
DataType	string	数据类型	string
Pattern	string	正则表达式校验规则	^
PatternErrorMessage	string	正则表达式校验错误提示信息	不是有效的email地址
MinLength	integer	最小长度	1
MaxLength	integer	最大长度	10
Minimum	number	数字最小值	1
Maximum	number	数字最大值	10
Required	boolean	是否必填	false
System	boolean	是否是系统字段	false
Disabled	boolean	是否被禁用	false
Array	boolean	是否是数组	false
ReadOnly	boolean	是否只读	false
EditorType	string	编辑器类型	textbox
Attributes	string	扩展属性	{}
DisplayOrder	integer	列表展示顺序	1
CreatedTime	integer	创建时间。格式为 YYYY-MM-DD HH:mm:ss.S。	2021-07-14 10:48:43.0
UpdatedTime	integer	更新时间。格式为 YYYY-MM-DD HH:mm:ss.S。	2021-07-14 10:48:43.0
Creator	string	创建者	tom
CreatedTime	string	创建时间。格式为 YYYY-MM-DD HH:mm:ss.S。	2021-07-14 10:48:43.0
UpdatedTime	string	上次修改的时间。格式为 YYYY-MM-DD HH:mm:ss.S。	2021-07-14 10:48:43.0
Deleted	boolean	是否被删除	false
RequestId	string	请求 ID。	19D09CCC-F298-4124-849A-AFA217819011
HttpStatusCode	integer	HTTP 状态码	200
Code	string	响应码	OK
Message	string	响应信息。	Service abnormal, the instance 0418 is ceased.
Params	array	响应参数。
	string	响应参数。	无

示例

正常返回示例

JSON格式

{
  "Data": {
    "InstanceId": "5e0964fd-951c-4e45-b518-d09d4d2db8ca",
    "Id": "profile",
    "Description": "客户profile",
    "Properties": {
      "key": {
        "DisplayName": "姓名",
        "Description": "name",
        "Name": "name",
        "DataType": "string",
        "Pattern": "^",
        "PatternErrorMessage": "不是有效的email地址",
        "MinLength": 1,
        "MaxLength": 10,
        "Minimum": 1,
        "Maximum": 10,
        "Required": false,
        "System": false,
        "Disabled": false,
        "Array": false,
        "ReadOnly": false,
        "EditorType": "textbox",
        "Attributes": "{}",
        "DisplayOrder": 1,
        "CreatedTime": 0,
        "UpdatedTime": 0,
        "Creator": "tom"
      }
    },
    "CreatedTime": "2021-07-14 10:48:43.0",
    "UpdatedTime": "2021-07-14 10:48:43.0",
    "Deleted": false
  },
  "RequestId": "19D09CCC-F298-4124-849A-AFA217819011",
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Service abnormal, the instance 0418 is ceased.",
  "Params": [
    "无"
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
404	NotExists.InstanceId	The specified instance %s does not exist.	指定的呼叫中心实例不存在。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。