Reference 360

Back Next

Update a code value (v2)

Updates a code value in a code list based on the internal ID or alias of the code list. You can directly update code values without creating draft changes or sending your changes for approval.

You can't update code values that are defined as a parent code value in a hierarchical code list. To move a code value to another node within the same hierarchical code list, see Move a code value.

When you update a code value in a hierarchical code list, you don't need to use the parentCode attribute.

PATCH request

To update a code value in a code list, 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 to which you want to update the code values.

The following table describes the attributes in the request body:

Field	Type	Description
action	String	Action to perform on code values. Set to UPDATE .
records	Array	Details of the code value to update.
Name	String	Name for the code value.
Code	String	Code attribute value for the code value.
Description	String	Short description for the code value.
status	String	Optional. Status of the code value in the life cycle.

When you specify attributes in the request body, consider the following guidelines:

The attribute names are case-sensitive.

Use camel case for name and code attributes and lowercase for other fields, such as dependency.

Use string data type for a decimal attribute.

Ensure that you include values for all the fields of an existing code value. If you specify only the field values that you want to update, the REST API updates the specified field values and sets the other field values to null.

To update a code value, ensure that you use the Code attribute value. If you don't use the Code attribute value, the following error appears:

The specified code value does not exist

PATCH response

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

The following table describes the attributes in the response:

Field	Type	Description
successfulRecords	Array	An array that lists the successfully updated code values and their details.
Code	String	Code attribute value for the updated code value.
label	String	Display attribute value for the updated code value.
failedRecords	Array	An array that lists the code values that weren't updated and describes the reasons.
label	String	Display attribute value for the code value that wasn't updated.
Code	String	Code attribute value for the code value that wasn't updated.
errorCauses	-	Error details for the code values that weren't updated.
errorCode	String	Error code for the error type.
errorSummary	String	A short summary that explains why the code values weren't updated.
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 updated successfully.
failedRecordsCount	String	Number of code values that weren't updated.

PATCH example

To update a code value in a code list based on its internal ID

country

, you might use the following request:


PATCH https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/codelists/country/codevalues HTTP/1.1
    Content-Type: application/json
    Accept: application/json
    IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
    
    {
  "action": "UPDATE",
  "records": [
    {
      "Name": "NAME-A",
      "Code": "CODE-A",
      "Description": "DESCRIPTION-A",
      "status": "ActiveKey"
    }
  ]
}

The following sample response shows the report for a successful code value update:


	HTTP/1.1 200 OK
    Content-Type: application/json
    Content-Length: 39    
    {
  "successfulRecords": [
    {
      "Code": "CODE-A",
      "label": "NAME-A"
    }
  ],
  "failedRecords": [],
  "successfulRecordsCount": 1,
  "failedRecordsCount": 0

codelists version 2

Download Guide

Watch

Comments

Reference 360 Homepage

Communities

Knowledge Base

Success Portal