Modifying a Mapping

Function

Modifying a Mapping

Calling Method

For details, see Calling APIs.

URI

PUT /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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
id	Yes	String	Mapping ID.
name	No	String	Name.
project_id	No	String	Mapping ID.
workspace_id	No	String	Mapping ID.
dataclass_id	Yes	String	Mapping ID.
data_source	No	String	Data source.
status	No	String	Status: enabled or disabled.
description	No	String	Description.
create_time	No	String	Creation time.
creator_id	No	String	Creator ID.
creator_name	No	String	Creator name.
update_time	No	String	Update time.
modifier_id	No	String	Modifier ID.
modifier_name	No	String	Modifier name.
mapper	Yes	DpeMappingDetail object	Mapping information.
classifier	No	DpeClassifyCreate object	Classification creation information.

**Table 4** DpeMappingDetail
Parameter	Mandatory	Type	Description
id	No	String	Mapping ID.
name	No	String	Name.
project_id	No	String	Mapping ID.
workspace_id	No	String	Mapping ID.
dataclass_id	No	String	Mapping ID.
dataclass_name	No	String	Data class name.
mapper_type_id	No	String	Mapping ID.
mapping_id	No	String	Mapping ID.
mapping_info	No	DpeInfo object	Classification information.
create_time	No	String	Creation time.
creator_id	No	String	Creator ID.
creator_name	No	String	Creator name.
update_time	No	String	Update time.
modifier_id	No	String	Modifier ID.
modifier_name	No	String	Modifier name.
mapper_field_list	No	Array of DpeMappingFieldDetail objects	Mapping set.

**Table 5** DpeMappingFieldDetail
Parameter	Mandatory	Type	Description
id	No	String	Mapping ID.
project_id	No	String	Mapping ID.
workspace_id	No	String	Mapping ID.
dataclass_id	No	String	Mapping ID.
mapping_id	No	String	Mapping ID.
mapper_id	No	String	Mapping ID.
default_value	No	String	Default Value
target_key	No	String	Target field.
expression	No	String	Expression.
create_time	No	String	Creation time.
update_time	No	String	Update time.

**Table 6** DpeClassifyCreate
Parameter	Mandatory	Type	Description
id	No	String	Mapping ID.
project_id	No	String	Mapping ID.
workspace_id	No	String	Mapping ID.
dataclass_id	No	String	Mapping ID.
dataclass_name	No	String	Data class name.
mapping_id	No	String	Mapping ID.
direct_classifier	No	String	Direct classification.
direct_classifier_type_id	No	String	Mapping ID.
create_time	No	String	Creation time.
creator_id	No	String	Creator ID.
creator_name	No	String	Creator name.
update_time	No	String	Update time.
modifier_id	No	String	Modifier ID.
modifier_name	No	String	Modifier name.
mapping_info	No	DpeInfo object	Classification information.
classifier_item_list	No	Array of DpeClassifyItemDetail objects	Category set element.

**Table 7** DpeInfo
Parameter	Mandatory	Type	Description
id	No	String	Mapping ID.
name	No	String	Name.
project_id	No	String	Mapping ID.
workspace_id	No	String	Mapping ID.
dataclass_id	No	String	Mapping ID.
dataclass_name	No	String	Data class name.
classifier_id	No	String	Associated classification ID.
status	No	String	Status.
complete_degree	No	String	Progress.
instance_num	No	String	The number of associated instances.
built_in	No	String	Whether the data is built-in.
data_source	No	String	Data source.
description	No	String	Description.
update_time	No	String	Update time.
create_time	No	String	Creation time.
creator_id	No	String	Creator ID.
creator_name	No	String	Creator name.
modifier_id	No	String	Modifier ID.
modifier_name	No	String	Modifier name.

**Table 8** DpeClassifyItemDetail
Parameter	Mandatory	Type	Description
id	No	String	Mapping ID.
classifier_id	No	String	Mapping ID.
classifier_type_id	No	String	Mapping ID.
mapping_id	No	String	Mapping ID.
classifier_order	No	Integer	Classification priority.
expression	No	String	Expression.
create_time	No	String	Creation time.
update_time	No	String	Update time.

Response Parameters

Status code: 200

**Table 9** Response body parameters
Parameter	Type	Description
code	String	Definition Error code. Range N/A
message	String	Definition Error description. Range N/A
data	CreateDpeMappingRequestBody object	Request body for creating a categorical mapping.

**Table 10** CreateDpeMappingRequestBody
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.
data_source	String	Data source.
status	String	Status: enabled or disabled.
description	String	Description.
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	DpeMappingDetail object	Mapping information.
classifier	DpeClassifyCreate object	Classification creation information.

**Table 11** 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.
mapping_id	String	Mapping ID.
mapping_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 12** 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.

**Table 13** DpeClassifyCreate
Parameter	Type	Description
id	String	Mapping ID.
project_id	String	Mapping ID.
workspace_id	String	Mapping ID.
dataclass_id	String	Mapping ID.
dataclass_name	String	Data class name.
mapping_id	String	Mapping ID.
direct_classifier	String	Direct classification.
direct_classifier_type_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.
mapping_info	DpeInfo object	Classification information.
classifier_item_list	Array of DpeClassifyItemDetail objects	Category set element.

**Table 14** 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	String	The number of associated instances.
built_in	String	Whether the data is built-in.
data_source	String	Data source.
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 15** DpeClassifyItemDetail
Parameter	Type	Description
id	String	Mapping ID.
classifier_id	String	Mapping ID.
classifier_type_id	String	Mapping ID.
mapping_id	String	Mapping ID.
classifier_order	Integer	Classification priority.
expression	String	Expression.
create_time	String	Creation time.
update_time	String	Update time.

Status code: 400

**Table 16** Response body parameters
Parameter	Type	Description
code	String	Definition Error code. Range N/A
message	String	Definition Error description. Range N/A

Example Requests

Example for modifying a mapping of a single category

{
  "description" : "Update",
  "mapper" : {
    "mapper_type_id" : "38173e29-ba56-404e-84d7-71ca33d0e416",
    "mapper_field_list" : [ {
      "workspace_id" : "38173e29-ba56-404e-84d7-71ca33d0e416",
      "update_time" : "2022-06-16T10:37:50Z+0800",
      "expression" : {
        "filter" : {
          "conditions" : [ {
            "name" : "c1",
            "data" : [ "title", "==", "xxxx" ],
            "is_context" : false
          } ],
          "logics" : [ "title" ]
        }
      },
      "create_time" : "2022-06-16T10:37:50Z+0800",
      "project_id" : "38173e29-ba56-404e-84d7-71ca33d0e416",
      "mapping_id" : "38173e29-ba56-404e-84d7-71ca33d0e416",
      "target_key" : "alert",
      "default_value" : "alert",
      "id" : "38173e29-ba56-404e-84d7-71ca33d0e416",
      "dataclass_id" : "38173e29-ba56-404e-84d7-71ca33d0e416",
      "mapper_id" : "38173e29-ba56-404e-84d7-71ca33d0e416"
    } ],
    "dataclass_id" : "38173e29-ba56-404e-84d7-71ca33d0e416",
    "workspace_id" : "38173e29-ba56-404e-84d7-71ca33d0e416",
    "project_id" : "38173e29-ba56-404e-84d7-71ca33d0e416",
    "name" : "UpdateMapper",
    "id" : "38173e29-ba56-404e-84d7-71ca33d0e416"
  },
  "classifier" : null,
  "dataclass_id" : "38173e29-ba56-404e-84d7-71ca33d0e416",
  "data_source" : "CFW",
  "workspace_id" : "d7310f19-56d3-4556-b4ea-328a7899a6ba",
  "update_time" : "2022-06-16T10:37:50Z+0800",
  "project_id" : "81fee81ab75a48a7b38e6586868688e7",
  "name" : "UpdateMapper",
  "id" : "96cc63b3-3f8f-4798-be2c-9f3930c14e29",
  "status" : "enabled"
}

Example Responses

Status code: 200

Response to the request for modifying a mapping.

{
  "code" : "00000000",
  "data" : {
    "classifier" : null,
    "data_source" : "CFW",
    "dataclass_id" : "38173e29-ba56-404e-84d7-71ca33d0e416",
    "description" : "description",
    "id" : "96cc63b3-3f8f-4798-be2c-9f3930c14e29",
    "mapper" : {
      "dataclass_id" : "38173e29-ba56-404e-84d7-71ca33d0e416",
      "id" : "59adc124-4f31-4dd9-b8b7-740309d9cce7",
      "mapper_field_list" : [ {
        "default_value" : "alert",
        "expression" : "{\"filter\":{\"conditions\":[{\"name\":\"c1\",\"data\":[\"title\",\"==\",\"xxxx\"],\"is_context\":false}],\"logics\":[\"title\"]}}javascript:void(0);",
        "target_key" : "alert"
      } ],
      "mapper_type_id" : "38173e29-ba56-404e-84d7-71ca33d0e416",
      "name" : "Updatemapper",
      "project_id" : "38173e29-ba56-404e-84d7-71ca33d0e416",
      "workspace_id" : "38173e29-ba56-404e-84d7-71ca33d0e416"
    },
    "name" : "Update",
    "project_id" : "81fee81ab75a48a7b38e6586868688e7",
    "workspace_id" : "70689d1c-e953-458e-8807-6f0b2a789ee9",
    "status" : "enabled"
  },
  "message" : ""
}