Reference 360

Back Next

Move a code value (v2)

Moves a code value to another node within a hierarchical code list without locking the code list. You can directly move code values without creating draft changes or sending your changes for approval..

PATCH request

To move a code value to another node within the same hierarchical 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 a hierarchical code list that you want to update.

The following table describes the attributes in the request body:

Field	Type	Description
action	String	Action to perform on code values. Set to MOVE .
records	Array	Details of the code value to move.
Code	String	Code attribute value for the code value.
parentCode	String	Optional. Code value of the parent node to which you want to move the code value. By default, Reference 360 adds the specified code values to the parent node of the hierarchy.

PATCH response

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

The following table describes the attributes in the response body:

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

PATCH example

To move a code value to another node within a hierarchical 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": "MOVE",
        "records": [
            {
                "Code": "CODE-A",
                "parentCode": "CODE-B"
            }
        ]
    }
}

The following sample response shows the report for moved code values:


    HTTP/1.1 200 OK
    Location: /subset/71253be5deb0e7d4974935e0/cursor
    Content-Type: application/json
    Content-Length: 39    

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

codelists version 2

Download Guide

Watch

Comments

Reference 360 Homepage

Communities

Knowledge Base

Success Portal