Reference 360

Back Next

Delete code values (v2)

Deletes code values of a code list that you no longer need based on the internal ID or alias of the code list. You can directly delete code values without creating 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 in 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

PATCH request

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

/rdm-service/external/v2/codelists/{codeListKey}/codevalues

The following table describes the parameter in the request:

Parameter	Type	Description
codeListKey	String	Internal ID or alias of the code list that contains the code values to delete.

The following table describes the attributes in the request body:

Field	Type	Description
action	String	Action to perform on code values. Set to DELETE .
records	Array	List of code values to delete. You can delete 50 code values at a time.
Code	String	The code field for the code value.

PATCH response

The response generates a report of code values that were deleted.

The following table describes the attributes in the response body:

Field	Type	Description
successfulRecords	Array	An array that 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	Array	An array that lists the code values that weren't deleted and describes the reasons.
Code	String	Code attribute value for the code value.
label	String	Display attribute value for the code value.
errorCauses	-	Error details for the code values that weren't deleted.
errorCode	String	Error code for the error type.
errorSummary	String	Explains why the code value wasn't deleted.
localizedErrorSummary	String	A short summary that explains the error in the user locale.
errorParameter	String	Parameter that provides details of an error.
successfulRecordsCount	String	Number of code values that were deleted successfully.
failedRecordsCount	String	Number of code values that weren't deleted.

PATCH example

To delete code values in a code list based on its internal ID

country

, you might use the following request body:

PATCH https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/codelists/country/codevalues HTTP/1.1
Content-Type: application/json
Content-Length: 30
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
{
        "action": "DELETE",
        "records": [
            {
                "Code": "CODE-A"
            }
        ]
    }
}

The following sample response shows the deletion report:

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

{
  "successfulRecords": [
    {
      "Code": "CODE-A"
    }
  ],
  "failedRecords": [],
  "successfulRecordsCount": 1,
  "failedRecordsCount": 0
}

codelists version 2

Download Guide

Watch

Comments

Reference 360 Homepage

Communities

Knowledge Base

Success Portal