Reference 360

Back Next

Create a code value

Creates a code value in a code list.

PATCH request

To create a code value in a code list, submit a PATCH request with the following URI:

/rdm-service/external/v1/codelists/{listIdentifier}/codevalues

The following table describes the parameter in the request:

Parameter	Type	Description
listIdentifier	String	ID of the code list that the code values belong to.

The following table describes the attributes in the request:

Field	Type	Description
action	String	Action to perform on code values. Value is CREATE .
records	Array	List of code values to create.
Name	String	Name of the field.
Code	String	The code field of the code value to create.
Description	String	Description of the code value.
status	String	Optional. Status of the code value.
parentCode	String	Code value of the parent node.

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.

When you add a node to a parent code value in a hierarchical code list, use the parentCode attribute.

When you create a code value with data quality rule associations assigned to a Code attribute and set the value of the code attribute within a code list, the rule statement overrides the value.

PATCH response

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

The following table describes the attributes in the response:

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

PATCH example

To create a code value in a code list, you might use the following request:


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

The following sample response shows the error report for a failed code value creation:


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

   {
    "successfulRecords": [],
    "failedRecords": [
        {
            "label": "NAME-A",
            "errorCauses": [
                {
                    "errorCode": "RDM.0010045",
                    "errorSummary": "The code value already exists in the code list.",
                    "errorParameter": {
                        "Code": "CODE-A"
                    }
                }
            ],
            "Code": "CODE-A"
        }
    ],
    "successfulRecordsCount": 0,
    "failedRecordsCount": 1
}

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Create a code value

Create a code value

PATCH request

PATCH response

PATCH example