Reference 360

Back Next

Delete code values

Deletes one or multiple code values that you no longer need. When you delete code values using the Delete code values API, you directly delete code values without creating a draft changes or sending your changes for approval.

You cannot delete the following types of code values:

Code values that are defined as a parent code value in a hierarchical code list

Code values that are used as a Reference Data attribute for another code list

Code values that are used as a dependency in another code list

Code values that are part of a value mapping in a crosswalk

Code values that are part of a hierarchy asset

DELETE request

To delete a code value, submit a DELETE request with the following URI:

/rdm-service/external/v1/codelists/<code list ID>/codevalues

The following table describes the attributes in the request:

Field	Type	Description
Codes	String	Comma-separated list of code values by the value in the Code attribute.

DELETE response

The response contains the deletion report. If the delete failed, the report provides failure reasons.

The following table describes the attributes in the response:

Field	Type	Description
numberOfRecordsDeleted	Number	Number of code values that were deleted successfully.
numberOfRecordsFailed	Number	Number of code values that were not deleted.
deletedRecords	-	Lists the code values that were deleted successfully.
Code	String	Code attribute value for deleted code value.
Label	String	Display attribute value for deleted code value.
failedRecords	-	Lists the code values that were not deleted and describes the reasons.
Code	String	Code attribute value for the code value.
label	String	Display attribute value for the code value.
errorCode	String	Error code for the error type.
errorSummary	String	Explains why the code value was not deleted.

The display attribute value represents the code value when the code value appears in other assets in

Reference 360

. For more information, see Display attributes.

DELETE example

To delete code values, you might use the following request:

DELETE https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/codelists/34cea9471fe977f7decef5f5/codevalues HTTP/1.1
Content-Type: application/json
Content-Length: 30
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX


{
  "Codes":[
    "DE",
    "EN"
  ]
}

The following sample response shows the deletion report:

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 345

{
  "deletedRecords":[
    {
      "Code":"DE",
      "label":"DELabel"
    }
  ],
  "failedRecords":[
    {
      "Code":"EN",
      "label":"EnLabel",
      "errorCauses":[
        {
          "errorCode":"RDM.0010209",
          "errorSummary":"The code value is used in a Hierarchy"
        }
      ]
    }
  ],
  "numberOfRecordsDeleted":1,
  "numberOfRecordsFailed":1
}

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Delete code values

Delete code values

DELETE request

DELETE response

DELETE example