调用ListDocuments接口查询指定实例中的文档列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| SchemaId |
string |
是 |
schema id |
profile |
| SearchPattern |
string |
否 |
搜索条件表达式 |
支持Lucene搜索语法 |
| Sorts |
array<object> |
否 |
自定义排序值 |
|
|
object |
否 |
自定义排序值 |
||
| PropertyName |
string |
否 |
字段名 |
name |
| Order |
string |
否 |
排序顺序。取值：
|
desc |
| NextPageToken |
string |
否 |
下一个分页 token |
eyJ0YWJsZUlkIjoiY2Y2MTQxYjA5NDY0NDUxMzk5YjFjMTA5YTMxZWNkMzEiLCJ0b2tlbiI6IjAwMDAwMDAwMDAwNzAzNzcifQ== |
| PageSize |
integer |
否 |
分页大小 |
2 |
| RequestId |
string |
否 |
请求 ID |
EAF3C248-E123-441B-A545-B6CD02E98EED |
| InstanceId |
string |
是 |
实例 ID。 |
d278629c-c687-4aa3-b044-4fe9b012e7ef |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
ListDocumentsResponse |
||
| Data |
object |
数据。 |
|
| Schema |
object |
scheme |
|
| InstanceId |
string |
实例 ID。 |
87b12784-8ce2-40b6-b21f-c49cb3b5501e |
| Id |
string |
schame id |
profile |
| Description |
string |
描述信息 |
- |
| Properties |
object |
字段列表 |
|
|
object |
字段 |
||
| DisplayName |
string |
字段名称 |
name |
| Description |
string |
描述 |
- |
| Name |
string |
名称 |
name |
| DataType |
string |
数据类型 |
string |
| Pattern |
string |
正则表达式 |
* |
| PatternErrorMessage |
string |
正则表达式错误提示 |
格式错误 |
| MinLength |
integer |
最小长度 |
1 |
| MaxLength |
integer |
最大长度 |
1 |
| Minimum |
number |
最小值 |
1 |
| Maximum |
number |
最大值 |
1 |
| 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 |
创建时间。采用 ISO 8601 格式，时区为 UTC。。采用 ISO 8601 格式，时区为 UTC。。采用 ISO 8601 格式，时区为 UTC。 |
2020-10-14T09:53:53Z |
| UpdatedTime |
integer |
更新时间。采用 ISO 8601 格式，时区为 UTC。。采用 ISO 8601 格式，时区为 UTC。。采用 ISO 8601 格式，时区为 UTC。 |
2020-10-14T09:53:53Z |
| Creator |
string |
创建者 |
tom |
| CreatedTime |
string |
创建时间。采用 ISO 8601 格式，时区为 UTC。 |
2020-10-14T09:53:53Z |
| UpdatedTime |
string |
更新时间。采用 ISO 8601 格式，时区为 UTC。 |
2020-10-14T09:53:53Z |
| Deleted |
boolean |
是否被删除 |
false |
| Documents |
array<object> |
文档列表 |
|
|
object |
文档内容 |
{} |
|
| TotalCount |
integer |
总条目数。 |
1 |
| NextPageToken |
string |
下一页标识。 |
54d1a616d95a4a01ba58967a9115b649 |
| RequestId |
string |
请求 ID。 |
7BEEA660-A45A-45E3-98CC-AFC65E715C23 |
| HttpStatusCode |
integer |
HTTP 状态码 |
200 |
| Code |
string |
响应码。 |
OK |
| Message |
string |
响应信息 |
无 |
| Params |
array |
响应参数。 |
|
|
string |
响应参数。 |
无 |
示例
正常返回示例
JSON格式
{
"Data": {
"Schema": {
"InstanceId": "87b12784-8ce2-40b6-b21f-c49cb3b5501e",
"Id": "profile",
"Description": "-",
"Properties": {
"key": {
"DisplayName": "name",
"Description": "-",
"Name": "name",
"DataType": "string",
"Pattern": "*",
"PatternErrorMessage": "格式错误",
"MinLength": 1,
"MaxLength": 1,
"Minimum": 1,
"Maximum": 1,
"Required": false,
"System": false,
"Disabled": false,
"Array": false,
"ReadOnly": false,
"EditorType": "textbox",
"Attributes": "{}",
"DisplayOrder": 1,
"CreatedTime": 0,
"UpdatedTime": 0,
"Creator": "tom"
}
},
"CreatedTime": "2020-10-14T09:53:53Z",
"UpdatedTime": "2020-10-14T09:53:53Z\n",
"Deleted": false
},
"Documents": [
{}
],
"TotalCount": 1,
"NextPageToken": "54d1a616d95a4a01ba58967a9115b649"
},
"RequestId": "7BEEA660-A45A-45E3-98CC-AFC65E715C23",
"HttpStatusCode": 200,
"Code": "OK",
"Message": "无",
"Params": [
"无"
]
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 404 | NotExists.InstanceId | The specified instance %s does not exist. | 指定的呼叫中心实例不存在。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。