查询数据类列表
功能介绍
查询数据类列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/dataclasses
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目id |
|
workspace_id |
是 |
String |
工作空间id |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
偏移量 |
|
limit |
否 |
Integer |
数据量 |
|
name |
否 |
String |
名称查询 |
|
business_code |
否 |
String |
业务编码 |
|
description |
否 |
String |
描述 |
|
is_built_in |
否 |
Boolean |
是否内置 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） |
|
content-type |
是 |
String |
内容类型 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为：request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
dataclass_details |
Array of DataClassResponseBody objects |
数据类详情 |
|
total |
Number |
数据总量 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
数据类ID |
|
create_time |
String |
创建时间 |
|
update_time |
String |
更新时间 |
|
creator_id |
String |
创建者ID |
|
creator_name |
String |
创建者名称 |
|
modifier_id |
String |
修改者ID |
|
modifier_name |
String |
修改这名称 |
|
cloud_pack_version |
String |
订阅包版本 |
|
region_id |
String |
区域ID |
|
project_id |
String |
租户ID |
|
workspace_id |
String |
工作空间ID |
|
domain_id |
String |
domain id |
|
name |
String |
数据类名称 |
|
business_code |
String |
数据类业务编码 |
|
description |
String |
数据类描述 |
|
is_built_in |
Boolean |
是否内置，true内置，false非内置 |
|
parent_id |
String |
父级id |
|
type_num |
Number |
子类型数量 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为：request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
message |
String |
错误描述 |
请求示例
查询数据类列表，偏移量为10，查询3条
{
"limit" : 3,
"offset" : 10
}
响应示例
状态码：200
请求成功
{
"total" : 41,
"dataclass_details" : [ {
"id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"create_time" : "2021-01-30T23:00:00Z+0800",
"update_time" : "2021-01-30T23:00:00Z+0800",
"creator_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"creator_name" : "张三",
"modifier_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"modifier_name" : "李四",
"cloud_pack_version" : "订阅包版本",
"region_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"domain_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"name" : "证据",
"business_code" : "Evidence",
"description" : "我的数据类描述",
"is_built_in" : false,
"parent_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"type_num" : 9
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功 |
|
400 |
查询数据类列表错误返回body体 |
错误码
请参见错误码。
