Help Center/ SecMaster/ API Reference/ SecMaster APIs (Excluding APIs for Security Analysis V2)/ General Security Application/ Creating a Data Object
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Creating a Data Object

Function

This API is used to create data objects.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/{dataclass_name}

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

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".

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

format_version

No

Integer

Version of the aligned template. The default value is 1.

name

No

String

Name.

type

No

String

Description.

trigger_flag

No

Boolean

Trigger flag.

data_object

No

Array of objects

Data object list.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

[items]

Array of DataObjectCreateUpdateResponse objects

Returned ID list.
Table 5 DataObjectCreateUpdateResponse

Parameter

Type

Description

id

String

Unique ID.

event_id

String

Unique incident ID.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Response for creating data objects.

400

Error response

Error Codes

See Error Codes.