Help Center/ SecMaster/ API Reference/ SecMaster APIs (Excluding APIs for Security Analysis V2)/ Classifications & Mappings/ Querying Classifications & Mappings
Updated on 2025-11-14 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Classifications & Mappings

Function

This API is used to query the list of classifications & mappings.

Calling Method

For details, see Calling APIs.

URI

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

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

status

No

String

Status.

name

No

String

Name.

start_time

No

String

Start time.

end_time

No

String

End time.

offset

Yes

Integer

request offset, from 0

limit

Yes

Integer

request limit size

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

total

Integer

tatal count

offset

Integer

request offset, from 0

limit

Integer

request limit size

data

Array of DpeInfo objects

list of informations of DPE
Table 5 DpeInfo

Parameter

Type

Description

id

String

The id, display only

name

String

The name, display only

project_id

String

The id, display only

workspace_id

String

The id, display only

dataclass_id

String

The id, display only

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

The description, display only

update_time

String

Update time

create_time

String

Create time

creator_id

String

Creator id value

creator_name

String

Creator name value

modifier_id

String

Modifier id value

modifier_name

String

Modifier name value

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

Returned object of the classification and mapping list.

400

Returned packet for abnormal requests.

Error Codes

See Error Codes.

Parent Topic: Classifications & Mappings