Help Center/ SecMaster/ API Reference/ SecMaster APIs (V1)/ Classifications & Mappings/ Adding a Mapping

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

Online Debugging

CLI Examples

View PDF

Adding a Mapping

Function

This API is used to add a mapping.

Calling Method

For details, see Calling APIs.

URI

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

**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	No	String	Name.
project_id	No	String	Mapping ID.
workspace_id	No	String	Mapping ID.
dataclass_id	Yes	String	Mapping ID.
data_source	No	String	Data source.
status	No	String	Status: enabled or disabled.
description	No	String	Description.
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.
mapper	Yes	DpeMappingDetail object	Mapping information.

**Table 4** DpeMappingDetail
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.
mapper_type_id	No	String	Mapping ID.
dpe_info	No	DpeInfo object	Classification information.
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.
mapper_field_list	No	Array of DpeMappingFieldDetail objects	Mapping set.

**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** DpeMappingFieldDetail
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.
mapping_id	No	String	Mapping ID.
mapper_id	No	String	Mapping ID.
default_value	No	String	Default Value
target_key	No	String	Target field.
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	DpeMappingDetail object	Mapping information.

**Table 8** DpeMappingDetail
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.
mapper_type_id	String	Mapping ID.
dpe_info	DpeInfo object	Classification information.
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.
mapper_field_list	Array of DpeMappingFieldDetail objects	Mapping set.

**Table 9** 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 10** DpeMappingFieldDetail
Parameter	Type	Description
id	String	Mapping ID.
project_id	String	Mapping ID.
workspace_id	String	Mapping ID.
dataclass_id	String	Mapping ID.
mapping_id	String	Mapping ID.
mapper_id	String	Mapping ID.
default_value	String	Default Value
target_key	String	Target field.
expression	String	Expression.
create_time	String	Creation time.
update_time	String	Update time.

Status code: 400

**Table 11** 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 mapping.
400	Returned packet for abnormal requests.

Error Codes

See Error Codes.

Parent topic: Classifications & Mappings

Previous topic: Querying Classification Details

Next topic: Querying the Mapping List

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.