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

Modifying the Status of a Mapping

Function

This API is used to modifying the status of a categorical mapping.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/workspaces/{workspace_id}/soc/mappings/{mapping_id}/status

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

mapping_id

Yes

String

ID of mapper

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

Yes

String

Status: enabled or disabled.

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

data

UpdateDpeInfoStatusRequestBody object

Request body for updating the classification mapping status.

Table 5 UpdateDpeInfoStatusRequestBody

Parameter

Type

Description

status

String

Status: enabled or disabled.

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

Status code: 200

Response to the request for enabling or disabling a categorical mapping.

{
  "code" : 0,
  "data" : {
    "dpe_id" : 999999999999,
    "project_id" : 999999999999,
    "status" : "DISABLED",
    "workspace_id" : 999999999999
  },
  "message" : "",
  "request_id" : "",
  "success" : true
}

Status Codes

Status Code

Description

200

Response to the request for enabling or disabling a categorical mapping.

400

Returned packet for abnormal requests.

Error Codes

See Error Codes.