On this page

Function
Calling Method
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
Status Codes
Error Codes

Show all

Help Center/ SecMaster/ API Reference/ API/ Data Class Management/ Querying the Data Class List

Querying the Data Class List

Updated on 2024-12-25 GMT+08:00

View PDF

Function

This API is used to query the data class list.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
workspace_id	Yes	String	Workspace ID
dataclass_id	Yes	String	Data class ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Offset
limit	No	Integer	Data volume
name	No	String	Name
is_built_in	No	Boolean	Built-in or Not
field_category	No	String	Field types.
mapping	No	Boolean	Whether to display in other places other the classification and mapping module.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.
content-type	Yes	String	Content type.

Response Parameters

Status code: 200

**Table 4** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID, in the format request_uuid-timestamp-hostname.

**Table 5** Response body parameters
Parameter	Type	Description
field_details	Array of FieldResponseBody objects	list of informations of field
total	Number	Total data volume

**Table 6** FieldResponseBody
Parameter	Type	Description
id	String	Id value
cloud_pack_version	String	Subscribed version.
business_id	String	ID of associated service.
business_type	String	Associated service.
dataclass_name	String	Data class name.
business_code	String	Service code for the field.
field_key	String	Key
name	String	Field name.
description	String	Field description.
default_value	String	Default value.
display_type	String	Display type.
field_type	String	Field type, such as short text, radio, and grid.
extra_json	String	Additional JSON.
field_tooltip	String	Tool tip.
iu_type	String	Input and output types.
used_by	String	Services.
json_schema	String	JSON mode.
is_built_in	Boolean	Whether it is built in SecMaster. The options are - true for built-in and false for outsourced.
case_sensitive	Boolean	Case-sensitive mode. - true Enabled. False Disabled.
read_only	Boolean	Read-only mode. True Enabled. False Disabled.
required	Boolean	Mandatory mode. True Enabled. False Disabled.
searchable	Boolean	Search mode. True Enabled. False Disabled.
visible	Boolean	Visible mode. True Enabled. False Disabled.
maintainable	Boolean	Maintenance mode. True Enabled. False Disabled.
editable	Boolean	Edit mode. True Enabled. False Disabled.
creatable	Boolean	Creation mode. True Enabled. False Disabled.
mapping	Boolean	Whether to display in other places other the classification and mapping module.
target_api	String	Target 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

Status code: 400

**Table 7** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID, in the format request_uuid-timestamp-hostname.

**Table 8** Response body parameters
Parameter	Type	Description
code	String	Error Code
message	String	Error Description

Example Requests

Query the data object relationship list. The offset is 10, and three alerts are queried.

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

Example Responses

Status code: 200

Request succeeded.

{
  "total" : 41,
  "field_details" : [ {
    "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "cloud_pack_version" : "Subscribed version.",
    "business_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "business_type" : "Service type",
    "dataclass_name" : "Business ID",
    "business_code" : "My Field",
    "field_key" : "Key",
    "name" : "Field name.",
    "description" : "Field description.",
    "default_value" : "Default value.",
    "display_type" : "Display type.",
    "field_type" : "shorttext",
    "extra_json" : "{}",
    "field_tooltip" : "Tool tip.",
    "iu_type" : "Input and output types.",
    "used_by" : "Services.",
    "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" : "Target API.",
    "creator_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "creator_name" : "Tom",
    "modifier_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "modifier_name" : "Jerry",
    "create_time" : "2021-01-30T23:00:00Z+0800",
    "update_time" : "2021-01-30T23:00:00Z+0800"
  } ]
}