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

Querying the Mapping List

Function

This API is used to query the mapping list.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/mappings/mappers/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

mapping_id

Yes

String

Mapping ID.

workspace_id

No

String

Mapping ID.

project_id

No

String

Mapping ID.

dataclass_id

No

String

Mapping ID.

datasource_instance_id

No

String

Mapping ID.

status

No

String

Status: enabled or disabled.

name

No

String

Name.

has_preprocess_rule

No

Boolean

Whether to configure a preprocessing rule.

start_time

No

String

Start time.

end_time

No

String

End time.

offset

No

Integer

Definition

Offset.

Constraints

0-10000

Range

N/A

Default Value

0

limit

No

Integer

Definition

Current page number.

Constraints

N/A

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

Total number.

offset

Integer

Definition

Offset.

Constraints

0-10000

Range

N/A

Default Value

0

limit

Integer

Definition

Current page number.

Constraints

N/A

data

Array of DpeMappingContent objects

Categorical mapping set.

Table 5 DpeMappingContent

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.

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

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 to the request for querying the mapping list.

400

Returned packet for abnormal requests.

Error Codes

See Error Codes.