调用AddSchemaProperty接口为指定实例中的Schema添加字段。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| SchemaId |
string |
是 |
schema id |
profile |
| Property |
object |
否 |
字段 |
|
| DisplayName |
string |
否 |
名称 |
name |
| Description |
string |
否 |
描述信息。 |
- |
| Name |
string |
是 |
名称 |
name |
| DataType |
string |
是 |
数据类型 |
string |
| Pattern |
string |
否 |
正则表达式校验规则 |
* |
| PatternErrorMessage |
string |
否 |
正则表达式校验错误提示信息 |
格式错误 |
| MinLength |
integer |
否 |
最小长度 |
1 |
| MaxLength |
integer |
否 |
最大长度 |
100 |
| Minimum |
number |
否 |
数字最小值 |
1 |
| Maximum |
number |
否 |
数字最大值 |
1 |
| Required |
boolean |
否 |
是否必填 |
false |
| Disabled |
boolean |
否 |
是否被禁用 |
False |
| Array |
boolean |
否 |
是否是数组 |
false |
| ReadOnly |
boolean |
否 |
是否只读 |
true |
| EditorType |
string |
否 |
编辑器类型 |
textbox |
| Attributes |
string |
否 |
扩展属性 |
{\"newName\":\"小桔充电-demo\",\"appId\":\"69FRKB4193W8BYP0\"} |
| DisplayOrder |
integer |
否 |
列表展示顺序 |
10 |
| RequestId |
string |
否 |
请求 ID。 |
03C67DAD-EB26-41D8-949D-9B0C470FB716 |
| InstanceId |
string |
是 |
实例 ID。 |
b0eb2742-f37e-4c67-82d4-25c651c1xxxx |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
AddSchemaPropertyResponse |
||
| RequestId |
string |
请求 ID |
BF268B34-09C2-43FD-BAC4-5D31EA633111 |
| HttpStatusCode |
integer |
HTTP 状态码 |
200 |
| Code |
string |
响应码 |
OK |
| Message |
string |
响应信息。 |
无 |
| Params |
array |
响应参数。 |
|
|
string |
响应参数。 |
无 |
示例
正常返回示例
JSON格式
{
"RequestId": "BF268B34-09C2-43FD-BAC4-5D31EA633111",
"HttpStatusCode": 200,
"Code": "OK",
"Message": "无",
"Params": [
"无"
]
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 404 | NotExists.InstanceId | The specified instance %s does not exist. | 指定的呼叫中心实例不存在。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。