查询数据对象列表 - ListDatapanelObjects
功能介绍
查询数据对象列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/workspaces/{workspace_id}/soc/datapanel/{dataclass}/data-objects/search
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
content-type |
是 |
String |
参数解释: 内容类型
约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
limit |
否 |
Integer |
分页大小 |
|
offset |
否 |
Integer |
偏移量 |
|
sort_by |
否 |
String |
排序字段:create_time | update_time |
|
order |
否 |
String |
排序方式:DESC | ASC |
|
from_date |
否 |
String |
搜索开始时间,例如:2023-02-20T00:00:00.000Z |
|
to_date |
否 |
String |
搜索结束时间,例如:2023-02-27T23:59:59.999Z |
|
condition |
否 |
condition object |
搜索条件表达式 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
conditions |
否 |
Array of conditions objects |
表达式列表 |
|
logics |
否 |
Array of strings |
表达式名称列表 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
message |
String |
错误信息 |
|
total |
Integer |
总数 |
|
limit |
Integer |
分页大小 |
|
offset |
Integer |
偏移量 |
|
success |
Boolean |
是否成功 |
|
data |
Array of DataObjectDetail objects |
详情列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
create_time |
String |
记录时间,格式ISO8601:YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区,无法解析时区的时间,默认时区填东八区 |
|
dataobject |
Object |
数据对象 |
|
dataclass_ref |
dataclass_ref object |
数据类对象 |
|
format_version |
Integer |
格式版本 |
|
id |
String |
事件唯一标识,UUID格式,最大36个字符 |
|
project_id |
String |
当前项目的id |
|
update_time |
String |
更新时间,格式ISO8601:YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区,无法解析时区的时间,默认时区填东八区 |
|
version |
Integer |
版本 |
|
workspace_id |
String |
当前的工作空间id |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 错误码 取值范围: 不涉及 |
|
message |
String |
参数解释: 错误描述 取值范围: 不涉及 |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
响应成功返回对象 |
|
400 |
响应错误返回对象 |
错误码
请参见错误码。