Querying the Field List

Function

This API is used to query the field 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	Search by name.
is_built_in	No	Boolean	Built-in or not.
field_category	No	String	Field category.
mapping	No	Boolean	Whether to display in other places except the category mapping area.

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 the user 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. 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	Subscription package version.
business_id	String	ID of the associated service.
business_type	String	Associated services.
dataclass_name	String	Data class name.
business_code	String	Business code of the field.
field_key	String	Field 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 shorttext, radio, and grid.
extra_json	String	Additional JSON.
field_tooltip	String	Tool tips.
iu_type	String	Input and output type.
used_by	String	Related service.
json_schema	String	JSON.
is_built_in	Boolean	Built-in or not. true: Built in; false: Not built in.
case_sensitive	Boolean	true: Case sensitive; false: Case insensitive
read_only	Boolean	Read-only mode. The value can be true (read-only) or false (non-read-only).
required	Boolean	Whether the parameter is mandatory. true: Mandatory; false: Optional.
searchable	Boolean	Searchable or not. true: Searchable; false: Not searchable.
visible	Boolean	Visible or not. true: Visible; false: Invisible.
maintainable	Boolean	Maintainable or not. true: Maintainable; false: Not maintainable.
editable	Boolean	Editable or not. true: Editable; false: Not editable.
creatable	Boolean	Creatable or not. true: Yes; false: No
mapping	Boolean	Whether to display in other places except the category mapping area.
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. 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 field list. Offset: 10. Quantity: 3.

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

Example Responses

Status code: 200

Request succeeded.

{
  "total" : 41,
  "field_details" : [ {
    "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "cloud_pack_version" : "Subscription package version.",
    "business_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "business_type" : "Service type.",
    "dataclass_name" : "Service ID.",
    "business_code" : "My Field",
    "field_key" : "Field key.",
    "name" : "Field name.",
    "description" : "Field description.",
    "default_value" : "Default value.",
    "display_type" : "Display type.",
    "field_type" : "shorttext",
    "extra_json" : "{}",
    "field_tooltip" : "Tool tips.",
    "iu_type" : "Input and output type.",
    "used_by" : "Related service.",
    "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" : "Peter",
    "create_time" : "2021-01-30T23:00:00Z+0800",
    "update_time" : "2021-01-30T23:00:00Z+0800"
  } ]
}