文档首页/ 安全云脑 SecMaster/ API参考/ API/ 数据类管理/ 查询字段列表
更新时间：2024-12-13 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询字段列表

功能介绍

查询字段列表

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/workspaces/{workspace_id}/soc/dataclasses/{dataclass_id}/fields

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目id

workspace_id

是

String

工作空间id

dataclass_id

是

String

数据类id
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

偏移量

limit

否

Integer

数据量

name

否

String

名称查询

is_built_in

否

Boolean

是否内置

field_category

否

String

字段分类

mapping

否

Boolean

是否展示在分类映射外的其他地方

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）

content-type

是

String

内容类型

响应参数

状态码： 200

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为：request_uuid-timestamp-hostname
表5 响应Body参数

参数

参数类型

描述

field_details

Array of FieldResponseBody objects

list of informations of field

total

Number

数据总量
表6 FieldResponseBody

参数

参数类型

描述

id

String

Id value

cloud_pack_version

String

订阅包版本

business_id

String

关联业务id

business_type

String

关联业务

dataclass_name

String

数据类名称

business_code

String

字段业务编码

field_key

String

字段key

name

String

字段名称

description

String

字段描述

default_value

String

默认值

display_type

String

显示类型

field_type

String

字段类型，如shorttext,radio,grid等

extra_json

String

附加json

field_tooltip

String

工具提示

iu_type

String

输入输出类型

used_by

String

使用业务

json_schema

String

json模式

is_built_in

Boolean

是否内置，true内置，false非内置

case_sensitive

Boolean

大小写敏感，true敏感，false不敏感

read_only

Boolean

只读模式，true只读，false非只读

required

Boolean

是否必填，true必填，false非必填

searchable

Boolean

可搜索，true可搜索，false非可搜索

visible

Boolean

可见，true可见，false非可见

maintainable

Boolean

可维护，true可维护，false非可维护

editable

Boolean

可编辑，true可编辑，false非可编辑

creatable

Boolean

可创建，true可创建，false非可创建

mapping

Boolean

是否展示在分类映射外的其他地方

target_api

String

目标api

creator_id

String

Creator id value

creator_name

String

Creator name value

modifier_id

String

Modifier id value

modifier_name

String

Modifier name value

create_time

String

Create time

update_time

String

Update time

状态码： 400

表7 响应Header参数

参数

参数类型

描述

X-request-id

String

请求ID,格式为：request_uuid-timestamp-hostname
表8 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误描述

请求示例

查询字段列表，偏移量为10，查询3条

{
  "limit" : 3,
  "offset" : 10
}

响应示例

状态码： 200

请求成功

{
  "total" : 41,
  "field_details" : [ {
    "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "cloud_pack_version" : "订阅包版本",
    "business_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "business_type" : "业务类型",
    "dataclass_name" : "业务id",
    "business_code" : "My Field",
    "field_key" : "字段key",
    "name" : "字段名称",
    "description" : "字段描述",
    "default_value" : "默认值",
    "display_type" : "显示类型",
    "field_type" : "shorttext",
    "extra_json" : "{}",
    "field_tooltip" : "工具提示",
    "iu_type" : "输入输出类型",
    "used_by" : "使用业务",
    "json_schema" : "{}",
    "is_built_in" : false,
    "case_sensitive" : false,
    "read_only" : false,
    "required" : false,
    "searchable" : false,
    "visible" : false,
    "maintainable" : false,
    "editable" : false,
    "creatable" : false,
    "mapping" : true,
    "target_api" : "目标api",
    "creator_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "creator_name" : "张三",
    "modifier_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "modifier_name" : "李四",
    "create_time" : "2021-01-30T23:00:00Z+0800",
    "update_time" : "2021-01-30T23:00:00Z+0800"
  } ]
}

状态码

状态码

描述

200

请求成功

400

查询数据类列表错误返回body体

错误码

请参见错误码。

父主题： 数据类管理

相关文档