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
|
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
|
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. Constraints N/A Range Default Value N/A |
|
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
|
Parameter |
Type |
Description |
|---|---|---|
|
X-request-id |
String |
Request ID. Format: request_uuid-timestamp-hostname. |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Field ID. |
|
cloud_pack_id |
String |
Subscription ID. |
|
cloud_pack_name |
String |
Subscription package name. |
|
dataclass_id |
String |
Data class 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. |
|
creator_name |
String |
Creator name. |
|
modifier_id |
String |
Modifier ID. |
|
modifier_name |
String |
Modifier name. |
|
create_time |
String |
Creation 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. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
X-request-id |
String |
Request ID. Format: request_uuid-timestamp-hostname. |
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition Error code. Range N/A |
|
message |
String |
Definition Error description. Range N/A |
Example Requests
Request for creating a layout field.
{
"layout_id" : "8f7b3080-e528-440b-99c6-44252f149643",
"visible" : false,
"editable" : false,
"default_value" : "test",
"creatable" : false,
"required" : false,
"searchable" : false,
"display_type" : "treeInteract",
"field_key" : "tree",
"readonly" : false,
"name" : "test_yRn2n",
"extra_json" : "{\"name\":\"tree\",\"field_key\":\"tree\",\"editableInCurSpace\":false}",
"maintainable" : false,
"boa_version" : "v3"
}
Example Responses
Status code: 200
Request succeeded.
{
"boa_version" : "v3",
"creatable" : false,
"create_time" : "2025-12-20T11:12:30Z+0800",
"creator_id" : "7cdfd39950744fc1aff40555a94310f4",
"creator_name" : "SCC_InfrastructureSecurityService",
"default_value" : "test",
"editable" : false,
"extra_json" : "eyJuYW1lIjoi5qCRIiwiZmllbGRfa2V5IjoidHJlZSIsImVkaXRhYmxlSW5DdXJTcGFjZSI6ZmFsc2V9",
"field_key" : "tree",
"id" : "91c6674c-3e6e-422d-841e-036a0890801e",
"is_built_in" : false,
"maintainable" : false,
"name" : "test_yRn2n",
"required" : false,
"searchable" : false,
"update_time" : null,
"visible" : false
}
SDK Sample Code
The SDK sample code is as follows.
Request for creating a layout field.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.secmaster.v2.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v2.*; import com.huaweicloud.sdk.secmaster.v2.model.*; public class CreateLayoutFieldSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); SecMasterClient client = SecMasterClient.newBuilder() .withCredential(auth) .withRegion(SecMasterRegion.valueOf("<YOUR REGION>")) .build(); CreateLayoutFieldRequest request = new CreateLayoutFieldRequest(); request.withWorkspaceId("{workspace_id}"); CreateLayoutFieldRequestBody body = new CreateLayoutFieldRequestBody(); body.withBoaVersion("v3"); body.withCreatable(false); body.withEditable(false); body.withMaintainable(false); body.withVisible(false); body.withSearchable(false); body.withRequired(false); body.withReadonly(false); body.withExtraJson("{"name":"tree","field_key":"tree","editableInCurSpace":false}"); body.withDisplayType("treeInteract"); body.withDefaultValue("test"); body.withLayoutId("8f7b3080-e528-440b-99c6-44252f149643"); body.withFieldKey("tree"); body.withName("test_yRn2n"); request.withBody(body); try { CreateLayoutFieldResponse response = client.createLayoutField(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Request for creating a layout field.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksecmaster.v2.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateLayoutFieldRequest() request.workspace_id = "{workspace_id}" request.body = CreateLayoutFieldRequestBody( boa_version="v3", creatable=False, editable=False, maintainable=False, visible=False, searchable=False, required=False, readonly=False, extra_json="{"name":"tree","field_key":"tree","editableInCurSpace":false}", display_type="treeInteract", default_value="test", layout_id="8f7b3080-e528-440b-99c6-44252f149643", field_key="tree", name="test_yRn2n" ) response = client.create_layout_field(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Request for creating a layout field.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := secmaster.NewSecMasterClient( secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateLayoutFieldRequest{} request.WorkspaceId = "{workspace_id}" boaVersionCreateLayoutFieldRequestBody:= "v3" creatableCreateLayoutFieldRequestBody:= false editableCreateLayoutFieldRequestBody:= false maintainableCreateLayoutFieldRequestBody:= false visibleCreateLayoutFieldRequestBody:= false searchableCreateLayoutFieldRequestBody:= false requiredCreateLayoutFieldRequestBody:= false readonlyCreateLayoutFieldRequestBody:= false extraJsonCreateLayoutFieldRequestBody:= "{"name":"tree","field_key":"tree","editableInCurSpace":false}" displayTypeCreateLayoutFieldRequestBody:= "treeInteract" defaultValueCreateLayoutFieldRequestBody:= "test" layoutIdCreateLayoutFieldRequestBody:= "8f7b3080-e528-440b-99c6-44252f149643" request.Body = &model.CreateLayoutFieldRequestBody{ BoaVersion: &boaVersionCreateLayoutFieldRequestBody, Creatable: &creatableCreateLayoutFieldRequestBody, Editable: &editableCreateLayoutFieldRequestBody, Maintainable: &maintainableCreateLayoutFieldRequestBody, Visible: &visibleCreateLayoutFieldRequestBody, Searchable: &searchableCreateLayoutFieldRequestBody, Required: &requiredCreateLayoutFieldRequestBody, Readonly: &readonlyCreateLayoutFieldRequestBody, ExtraJson: &extraJsonCreateLayoutFieldRequestBody, DisplayType: &displayTypeCreateLayoutFieldRequestBody, DefaultValue: &defaultValueCreateLayoutFieldRequestBody, LayoutId: &layoutIdCreateLayoutFieldRequestBody, FieldKey: "tree", Name: "test_yRn2n", } response, err := client.CreateLayoutField(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Request succeeded. |
|
400 |
Failure response. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot