Updated on 2025-12-18 GMT+08:00

Adding a Classification

Function

This API is used to add a classification.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/mappings/classifiers

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.

Range

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

id

Yes

String

Mapping ID.

name

Yes

String

Name.

dataclass_id

Yes

String

Mapping ID.

data_source

Yes

String

Data source.

description

Yes

String

Description.

classifier

Yes

DpeClassifyCreate object

Classification creation information.

Table 4 DpeClassifyCreate

Parameter

Mandatory

Type

Description

id

No

String

Mapping ID.

project_id

No

String

Mapping ID.

workspace_id

No

String

Mapping ID.

dataclass_id

No

String

Mapping ID.

dataclass_name

No

String

Data class name.

mapping_id

No

String

Mapping ID.

direct_classifier

No

Boolean

Direct classification.

direct_classifier_type_id

No

String

Mapping ID.

create_time

No

String

Creation time.

creator_id

No

String

Creator ID.

creator_name

No

String

Creator name.

update_time

No

String

Update time.

modifier_id

No

String

Modifier ID.

modifier_name

No

String

Modifier name.

mapping_info

No

DpeInfo object

Classification information.

classifier_item_list

No

Array of DpeClassifyItemDetail objects

Category set element.

Table 5 DpeInfo

Parameter

Mandatory

Type

Description

id

No

String

Mapping ID.

name

No

String

Name.

project_id

No

String

Mapping ID.

workspace_id

No

String

Mapping ID.

dataclass_id

No

String

Mapping ID.

dataclass_name

No

String

Data class name.

classifier_id

No

String

Associated classification ID.

status

No

String

Status.

complete_degree

No

String

Progress.

instance_num

No

Integer

The number of associated instances.

description

No

String

Description.

update_time

No

String

Update time.

create_time

No

String

Creation time.

creator_id

No

String

Creator ID.

creator_name

No

String

Creator name.

modifier_id

No

String

Modifier ID.

modifier_name

No

String

Modifier name.

Table 6 DpeClassifyItemDetail

Parameter

Mandatory

Type

Description

id

No

String

Mapping ID.

classifier_id

No

String

Mapping ID.

classifier_type_id

No

String

Mapping ID.

mapping_id

No

String

Mapping ID.

classifier_order

No

Integer

Classification priority.

expression

No

String

Expression.

create_time

No

String

Creation time.

update_time

No

String

Update time.

Response Parameters

Status code: 200

Table 7 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

data

CreateDpeClassifyRequestBody object

Request body for creating a classification mapping.

Table 8 CreateDpeClassifyRequestBody

Parameter

Type

Description

id

String

Mapping ID.

name

String

Name.

dataclass_id

String

Mapping ID.

data_source

String

Data source.

description

String

Description.

classifier

DpeClassifyCreate object

Classification creation information.

Table 9 DpeClassifyCreate

Parameter

Type

Description

id

String

Mapping ID.

project_id

String

Mapping ID.

workspace_id

String

Mapping ID.

dataclass_id

String

Mapping ID.

dataclass_name

String

Data class name.

mapping_id

String

Mapping ID.

direct_classifier

Boolean

Direct classification.

direct_classifier_type_id

String

Mapping ID.

create_time

String

Creation time.

creator_id

String

Creator ID.

creator_name

String

Creator name.

update_time

String

Update time.

modifier_id

String

Modifier ID.

modifier_name

String

Modifier name.

mapping_info

DpeInfo object

Classification information.

classifier_item_list

Array of DpeClassifyItemDetail objects

Category set element.

Table 10 DpeInfo

Parameter

Type

Description

id

String

Mapping ID.

name

String

Name.

project_id

String

Mapping ID.

workspace_id

String

Mapping ID.

dataclass_id

String

Mapping ID.

dataclass_name

String

Data class name.

classifier_id

String

Associated classification ID.

status

String

Status.

complete_degree

String

Progress.

instance_num

Integer

The number of associated instances.

description

String

Description.

update_time

String

Update time.

create_time

String

Creation time.

creator_id

String

Creator ID.

creator_name

String

Creator name.

modifier_id

String

Modifier ID.

modifier_name

String

Modifier name.

Table 11 DpeClassifyItemDetail

Parameter

Type

Description

id

String

Mapping ID.

classifier_id

String

Mapping ID.

classifier_type_id

String

Mapping ID.

mapping_id

String

Mapping ID.

classifier_order

Integer

Classification priority.

expression

String

Expression.

create_time

String

Creation time.

update_time

String

Update time.

Status code: 400

Table 12 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 to the request for adding a classification.

400

Returned packet for abnormal requests.

Error Codes

See Error Codes.