Editing a Data Object
Function
This API is used to update a data object.
Calling Method
For details, see Calling APIs.
URI
PUT /v1/{project_id}/workspaces/{workspace_id}/soc/{dataclass_name}/{data_object_id}
|
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 |
|
dataclass_name |
Yes |
String |
Name of the data class the association subject data object belongs to. The value must be plural and written in lowercase, for example, "alerts" and "incidents". |
|
data_object_id |
Yes |
String |
ID of the associated data object. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
batch_ids |
No |
Array of strings |
List of IDs for the batch update. |
|
trigger_flag |
No |
Boolean |
Trigger flag. |
|
data_object |
No |
Object |
Data objects. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Error code. |
|
message |
String |
Error message. |
|
success |
Boolean |
Successful or not. |
|
data |
DataObjectDetail object |
Data object details. |
|
Parameter |
Type |
Description |
|---|---|---|
|
create_time |
String |
Recording time, in the ISO 8601 format of "YYYY-MM-DDTHH:mm:ss.ms+Time zone". Time zone refers to where the incident occurred. If this parameter cannot be parsed, the default time zone GMT+8 is used. |
|
data_object |
Object |
Data object. |
|
dataclass_ref |
dataclass_ref object |
Data class object. |
|
format_version |
Integer |
Format version. |
|
id |
String |
Unique identifier of an incident. The value is in UUID format and can contain a maximum of 36 characters. |
|
project_id |
String |
ID of the current project. |
|
update_time |
String |
Update time, in the ISO 8601 format of "YYYY-MM-DDTHH:mm:ss.ms+Time zone". Time zone refers to where the incident occurred. If this parameter cannot be parsed, the default time zone GMT+8 is used. |
|
version |
Integer |
Version. |
|
workspace_id |
String |
ID of the current workspace. |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Unique identifier of a data class. The value is in UUID format and can contain a maximum of 36 characters. |
|
name |
String |
Data class name. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition Error code. Range N/A |
|
message |
String |
Definition Error description. Range N/A |
Example Requests
Edit the name of a data object. The name is demo_new_name.
https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/soc/{dataclass_name}/{data_object_id}
{
"data_object" : {
"name" : "demo_new_name"
}
}
Example Responses
Status code: 200
Object returned upon a successful response.
{
"code" : "00000000",
"message" : "message",
"success" : false,
"data" : {
"create_time" : "2026-01-09T14:33:41.507Z+0800",
"data_object" : {
"create_time" : "2026-01-09T14:33:41.507Z+0800",
"workspace_id" : "0b254664-3ba5-43d3-bf08-bec2df4b6d3c",
"create_by" : "demo_user",
"update_time" : "2026-01-09T14:33:41.798Z+0800",
"project_id" : "81fee81ab75a48a7b38e6586868688e7",
"parent_id" : "0",
"name" : "demo_new_name",
"id" : "c17d411f-a0c0-4645-a90e-7f133aaee10c",
"order_weight" : 0
},
"dataclass_ref" : {
"id" : "11c07979-ed8e-3701-92dc-6377696b844e",
"name" : "Department"
},
"format_version" : 0,
"id" : "c17d411f-a0c0-4645-a90e-7f133aaee10c",
"project_id" : "",
"update_time" : "2026-01-09T14:33:41.798Z+0800",
"version" : 0,
"workspace_id" : ""
}
}
SDK Sample Code
The SDK sample code is as follows.
Edit the name of a data object. The name is demo_new_name.
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 |
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.v1.region.SecMasterRegion; import com.huaweicloud.sdk.secmaster.v1.*; import com.huaweicloud.sdk.secmaster.v1.model.*; public class UpdateDataobjectSolution { 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(); UpdateDataobjectRequest request = new UpdateDataobjectRequest(); request.withWorkspaceId("{workspace_id}"); request.withDataclassName("{dataclass_name}"); request.withDataObjectId("{data_object_id}"); DataObjectBatchUpdateForm body = new DataObjectBatchUpdateForm(); body.withDataObject("{\"name\":\"demo_new_name\"}"); request.withBody(body); try { UpdateDataobjectResponse response = client.updateDataobject(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()); } } } |
Edit the name of a data object. The name is demo_new_name.
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdksecmaster.v1.region.secmaster_region import SecMasterRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdksecmaster.v1 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 = UpdateDataobjectRequest() request.workspace_id = "{workspace_id}" request.dataclass_name = "{dataclass_name}" request.data_object_id = "{data_object_id}" request.body = DataObjectBatchUpdateForm( data_object="{\"name\":\"demo_new_name\"}" ) response = client.update_dataobject(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Edit the name of a data object. The name is demo_new_name.
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v1/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.UpdateDataobjectRequest{} request.WorkspaceId = "{workspace_id}" request.DataclassName = "{dataclass_name}" request.DataObjectId = "{data_object_id}" var dataObjectDataObjectBatchUpdateForm interface{} = "{\"name\":\"demo_new_name\"}" request.Body = &model.DataObjectBatchUpdateForm{ DataObject: &dataObjectDataObjectBatchUpdateForm, } response, err := client.UpdateDataobject(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 |
Object returned upon a successful response. |
|
400 |
Object returned upon a response error. |
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