Help Center/ SecMaster/ API Reference/ SecMaster APIs (V1)/ Classifications & Mappings/ Querying Mapping Details
Updated on 2025-12-18 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Mapping Details

Function

This API is used to query mapping details.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/soc/mappings/mappers/{mapper_id}

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

mapper_id

Yes

String

Classification ID.

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

Response Parameters

Status code: 200

Table 3 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 4 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 5 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 6 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 7 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 querying mapping details.

400

Returned packet for abnormal requests.

Error Codes

See Error Codes.