Creating a Layout Field

Function

This API is used to create a layout field.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/workspaces/{workspace_id}/soc/layouts/fields

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Range N/A Default Value N/A
workspace_id	Yes	String	Definition Workspace ID. Constraints N/A Range N/A Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token Constraints N/A Range N/A Default Value N/A
content-type	Yes	String	Definition Content type. application/json;charset=UTF-8: common API request type Constraints N/A Range application/json;charset=UTF-8 Default Value N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Field name.
field_key	Yes	String	Field key.
description	No	String	Field description.
layout_id	No	String	layout id.
wizard_id	No	String	ID of the page associate with the field.
aopworkflow_id	No	String	ID of the workflow associated with the field.
aopworkflow_version_id	No	String	ID of the workflow version associated with the field.
playbook_id	No	String	ID of the playbook associated with the field.
playbook_version_id	No	String	ID of the playbook version associated with the field.
default_value	No	String	Default value.
display_type	No	String	Display type.
field_type	No	String	Field type, such as shorttext, radio, and grid.
extra_json	No	String	Additional JSON.
field_tooltip	No	String	Tool tips.
json_schema	No	String	JSON.
readonly	No	Boolean	Read-only mode. true: read-only. false: non-read-only.
required	No	Boolean	Whether the parameter is mandatory. true: Mandatory. false: Optional.
searchable	No	Boolean	Searchable or not. true: Searchable. false: Not searchable.
visible	No	Boolean	Visible or not. true: Visible. false: Invisible.
maintainable	No	Boolean	Maintainable or not. true: Maintainable. false: Not maintainable.
editable	No	Boolean	Editable or not. true: Editable. false: Not editable.
creatable	No	Boolean	Creatable or not. true: Yes. false: No.
boa_version	No	String	BOA base version.

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
id	String	Id value
cloud_pack_id	String	Subscription ID.
cloud_pack_name	String	Subscription package name.
dataclass_id	String	dataclass id.
cloud_pack_version	String	Subscription package version.
field_key	String	Field key.
name	String	Field name.
description	String	Field description.
en_description	String	Field description (en).
default_value	String	Default value.
en_default_value	String	Default value (en).
field_type	String	Field type, such as shorttext, radio, and grid.
extra_json	String	Additional JSON.
field_tooltip	String	Tool tips.
en_field_tooltip	String	Tool tips (en).
json_schema	String	JSON.
is_built_in	Boolean	Built-in or not. true: Built-in; false: Custom.
read_only	Boolean	Read-only mode. true: read-only. 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.
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
wizard_id	String	ID of the page associate with the field.
aopworkflow_id	String	ID of the workflow associated with the field.
aopworkflow_version_id	String	ID of the workflow version associated with the field.
playbook_id	String	ID of the playbook associated with the field.
playbook_version_id	String	ID of the playbook version associated with the field.
boa_version	String	BOA base version.
version	String	SecMaster edition.