Updated on 2025-11-14 GMT+08:00

Querying Classification & Mapping Functions

Function

This API is used to query functions used for classifications and mappings.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/soc/mappings/functions

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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

compare_list

Array of DpeCompareFunctionDetail objects

informations of compare function

operation_list

Array of DpeOperateFunctionDetail objects

informations of operate function

Table 4 DpeCompareFunctionDetail

Parameter

Type

Description

name

String

Name.

classify

String

NORMAL: general method. STRING: string method. NUMBER: number method. DATE date method.

description

String

Description.

example

String

example

comparefunc

String

Comparison method key.

Table 5 DpeOperateFunctionDetail

Parameter

Type

Description

name

String

Name.

classify

String

NORMAL: general method. STRING: string method. NUMBER: number method. DATE date method.

description

String

Description.

example

String

example

operationfunc

String

Conversion method key.

params

Array of Params objects

list of params

Table 6 Params

Parameter

Type

Description

key

String

DPE ID

value

String

DPE ID

description

String

Description.

example

String

example

mandatory

Boolean

Mandatory or not.

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 body for querying the classification and mapping list.

400

Returned packet for abnormal requests.

Error Codes

See Error Codes.