Reference 360 > Reference 360 REST API > codelists version 2
  

codelists version 2

Use this resource to retrieve the details of a code list, a code value, and the crosswalks associated to a code list based on its internal ID or alias. You can also unlock code lists locked by other users.
Note: To identify a code list based on its name, use the codelists version 1 REST APIs.

Unlock a code list (v2)

Unlocks a code list that's locked by another user.
Note: To use the API, you require the Informatica Intelligent Cloud Services Reference 360 Administrator role.

PUT request

To unlock a code list, submit a PUT request with the following URI:
/rdm-service/external/v2/codelists/<code list ID>/unlock
Note: You can find the ID of assets in Reference 360 or use REST APIs to retrieve the IDs. For more information, see Asset IDs.

PUT response

A 202 accepted response is returned.

PUT example

To unlock a code list, you might use the following request:
PUT https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/codelists/653a20e37659bf7eceecafa5/unlock HTTP/1.1
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
The following sample response shows the accepted response:
HTTP/1.1 202 Accepted

Create a code value (v2)

Creates a code value in a code list that has an internal ID or alias configured. You can directly create code values without creating draft changes or sending your changes for approval.

PATCH request

To create 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 add code values.
The following table describes the attributes in the request body:
Attributes
Type
Description
action
String
Action to perform on code values. Set to CREATE.
records
Array
Details of the code value to create.
Name
String
Name for the code value.
Code
String
Code attribute value for the code value.
Description
String
Optional. Short description for the code value.
status
String
Optional. Status of the code value in the life cycle.
parentCode
String
Optional. Code value of the parent node to which you want to add the new code value a child node.
When you add a node to a parent code value in a hierarchical code list, use the parentCode attribute.
When you don't specify the parentCode attribute, Reference 360 adds the specified code values to the parent node of the hierarchy.
When you specify attributes in the request body, consider the following guidelines:
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 body:
Attributes
Type
Description
successfulRecords
Array
An array that lists the successfully created code values and their details.
Code
String
Code attribute value for the created code value.
label
String
Display attribute value for the created code value.
failedRecords
Array
An array that 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 weren't created.
errorCode
String
Error code for the error type.
errorSummary
String
A short summary that explains why the code values weren't created.
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 created successfully.
failedRecordsCount
String
Number of code values that weren't created.

PATCH example

To create 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": "CREATE",
"records": [
{
"Name": "NAME-A",
"Code": "CODE-A",
"Description": "DESCRIPTION-A",
"status": "ActiveKey",
"parentCode": "STEM"
}
]
}
The following sample response shows the report for a successful code value creation:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 39

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

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:
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

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
}

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:

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.
Note: 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
}

Get code value details (v2)

Retrieves the details of a code value in a code list based on the internal ID or alias of the code list.

GET request

To retrieve the details of a code value, submit a GET request with the following URI and specify the code:
/rdm-service/external/v2/codelists/{codeListKey}/codevalues?Code={code}
The following table describes the parameter in the request body:
Parameter
Type
Description
codeListKey
String
Internal ID or alias of the code list that contains the code value.
Code
String
The code field for the code value.

GET response

The response contains the details of the code value.
The following table describes the attributes in the response body:
Field
Type
Description
codelistId
String
ID of the code list that contains the code value.
internalId
String
Internal ID of the code list that contains the code value.
alias
String
Alias of the code list that contains the code value.
businessId
Business ID of the code value.
codeValueFields
Array
Lists the attribute field values for the code value.
Code
String
The code field for the code value.
Name
String
The name field for the code value.

GET example

To retrieve the first page of code values in a code list based on its internal ID country, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/codelists/country/codevalues?Code=CODE-A HTTP/1.1
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
The following sample response shows the details of a code value:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 237

[
{
"codelistId": "67e2590c022698651e1964c8",
"internalId": "code1",
"alias": "alias1",
"businessId": "RDM0000123",
"codeValueFields": {
"Code": "CODE-A",
"Name": "NAME-A"
}
}
]

Get latest modified code values by time range (v2)

Retrieves the latest modified code values in a code list that were created or updated during the specified period based on the internal ID or alias.
By default, the request returns the first 100 code values. To retrieve more code values or to view the next page of code values, use the query parameters. You can retrieve a maximum of 10,000 code values in a request.

GET request

To retrieve the code values in a code list that were created or updated during the specified period based on the internal ID or alias, submit a GET request with the following URI:
/rdm-service/external/v2/codelists/{codeListKey}/modifications?from=<from>&to=<to>[&pageSize=<page size>&page=<page number>]
The following table describes the parameter in the URI:
Parameter
Type
Description
codeListKey
String
Internal ID or alias of the code list from which you are retrieving the code values.
from
String
Start date and time of the time range, which is inclusive. Time range must be in the following ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'. For example, you might use 2019-12-12T14:04:04Z.
to
String
End date and time of the time range, which is exclusive. Time range must be in the following ISO-8601 format: yyyy-MM-dd’T’HH:mm:ss’Z'. For example, you might use 2019-12-15T14:04:04Z.
page
Integer
Optional. Page number to display. Default is 0.
pageSize
Integer
Optional. Number of records to display per page. Default value is 100. Maximum value is 10000.

GET response

The response contains data about the created or updated code lists.
The following table describes the attributes in the response body:
Field
Type
Description
page
Number
Page from which the response was retrieved.
pageSize
Number
Number of records displayed per page.
totalNumberOfElements
Number
Total number of records found.
numberOfElements
Number
Number of records returned in the current page.
lastPage
Boolean
Indicates whether the current page is the last page in the total result.
firstPage
Boolean
Indicates whether the current page is the first page in the total result.
content
Array
Includes the list of code values.
status
String
Status of the code list.
dependency
String
ID of the code value specified as the dependency.
lastUpdateDate
String
Date when the code value was last updated.
changeType
String
Type of change made to the code list. Values are MODIFIED and DELETED.
effectiveDate
String
Date when the code list became effective.
codeValueFields
Object
Includes the attribute definition for code values.

GET example

To retrieve the first page of code values in a code list that were created or updated during a specific time period based on its internal ID country , you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/codelists/country/codevalues/modifications?from=2019-12-11T13:29:55Z&to=2019-12-12T13:29:55Z&page=0&pageSize=100 HTTP/1.1
Accept: application/json
The following sample response shows the first page of modified code lists:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 282
{
"pageSize": 1,
"page": 0,
"totalNumberOfElements": 1000,
"numberOfElements": 1,
"lastPage": false,
"firstPage": true,
"content": [
{
"status": "Draft",
"dependency": "870d2e1b6cd2249aa48dc5db",
"lastUpdateDate": "2019-12-11T13:29:55Z",
"changeType": "MODIFIED",
"effectiveDate": "2017-04-01",
"codeValueFields": {
"Name": "NAME-A"
}
}
]
}

Get modified code value relationships in hierarchy by time range (v2)

Retrieves code value relationships in a hierarchy that were created or updated during the specified period based on the internal ID or alias. Use the API to retrieve changes to code value relationships, such as code values that moved in the hierarchy and code values added under a parent code value for code lists with internal IDs or aliases.
By default, the request returns the first 100 code values. To retrieve more code values or to view the next page of code values, use the query parameters.

GET request

To retrieve the modified code values in a hierarchical code list for a time range, submit a GET request with the following URI:
/rdm-service/external/v2/codelists/{codeListKey}/codevalues/hierarchy/modifications?from=<from>&to=<to>[&pageSize=<page size>&page=<page number>
]
The following table lists the query parameters in the URI:
Parameter
Type
Description
codeListKey
String
Internal ID or alias of the code list from which you are retrieving the code values.
from
String
Start date and time of the time range, which is inclusive. Time range must be in the following ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'. For example, you might use 2019-12-12T14:04:04Z.
to
String
End date and time of the time range, which is exclusive. Time range must be in the following ISO-8601 format: yyyy-MM-dd’T’HH:mm:ss’Z'. For example, you might use 2019-12-15T14:04:04Z.
page
Integer
Optional. Page number to display. Default is 0.
pageSize
Integer
Optional. Number of records to display per page. Default value is 100. Maximum value is 10000.

GET response

The response contains data about the created or updated code value relationships for the specified time range.
The following table describes the attributes in the response body:
Field
Type
Description
page
Number
Page from which the response was retrieved.
pageSize
Number
Number of records displayed per page.
totalNumberOfElements
Number
Total number of records found.
numberOfElements
Number
Number of records returned in the current page.
lastPage
Boolean
Indicates whether the current page is the last page in the total result.
firstPage
Boolean
Indicates whether the current page is the first page in the total result.
content
Array
Includes the list of code values.
lastUpdateDate
String
Date when the code value was last updated.
parentCode
String
Code value of the parent node.
childCode
String
Code value of the child node.

GET example

To retrieve the first page of code values relationships that were created or updated during a specific time period based on its internal ID country, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/codelists/country/codevalues/hierarchy/modifications?from=2019-12-11T13:29:55Z&to=2019-12-12T13:29:55Z&page=0&pageSize=100 HTTP/1.1
Accept: application/json
Host: localhost:8080
The following sample response shows the first page of code value relationships that were created or updated during a specific time period:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 261

{
"pageSize":1,
"page":0,
"totalNumberOfElements":1000,
"numberOfElements":1,
"lastPage":false,
"firstPage":true,
"content":[
{
"lastUpdateDate":"2019-12-11T13:29:55Z",
"parentCode":"USA",
"childCode":"NY"
}
]
}
Note: If the code list is in draft state, some code value relationships might appear in the API response even though the code value relationships have not changed in the specified time range. For example, if you move a code value in a draft code list, the last update date of the code value updates to the date on which the code value was moved in the draft code list. The moved code value in draft code list might now meet the specified time range criteria.

Get modified code lists by time range (v2)

Retrieve the modified code lists for a time range based on an internal ID or alias. Modified code lists include code lists that users published or code values that users directly imported during the time range.
By default, the request returns the first 100 records. To retrieve more records or to view the next page of records, use the query parameters. You can retrieve a maximum of 10000 records in a request.

GET request

To retrieve the modified code lists for a time range based on an internal ID or alias, submit a GET request with the following URI:
/rdm-service/external/v2/codelists/modifications?from=<from>&to=<to>
To specify the page number and page size, submit a GET request with the following query parameters appended to the URI:
/rdm-service/external/v2/codelists/modifications?from=<from>&to=<to>&pageSize=<page size>&page=<page number>

GET request query parameters

You can append query parameters to the URI to specify the time range, page number, and page size.
Parameter
Description
from
Start date and time of the time range, which is inclusive. Time range must be in the following ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'. For example, you might use 2019-12-12T14:04:04Z.
to
End date and time of the time range, which is exclusive. Time range must be in the following ISO-8601 format: yyyy-MM-dd’T’HH:mm:ss’Z'. For example, you might use 2019-12-15T14:04:04Z.
page
Optional. Page number to display. Default is 0.
pageSize
Optional. Number of records to display per page. Default value is 100. Maximum value is 10000.

GET response

The response contains data about the modified code lists.
The following table describes the attributes in the response body:
Field
Type
Description
page
Number
Page from which the response was retrieved.
pageSize
Number
Number of records displayed per page.
totalNumberOfElements
Number
Total number of records found.
numberOfElements
Number
Number of records returned in the current page.
lastPage
Boolean
Indicates whether the current page is the last page in the total result.
firstPage
Boolean
Indicates whether the current page is the first page in the total result.
content
Array
Includes the list of code values.
id
String
Included in the content object.
ID of the code list.
updateDate
String
Included in the content object.
Last updated date of the change.
changeType
String
Included in the content object.
Type of change made to the code list. Values are DIRECT_IMPORT and PUBLISH_DRAFT.
internalId
String
Unique identifier of the code list.
alias
String
Alternative identifier of the code list.

GET example

To retrieve the first page of modified code lists for a time range based on the internal ID or alias, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/codelists/modifications?from=2019-12-11T13:29:55Z&to=2019-12-12T13:29:55Z&page=0&pageSize=100 HTTP/1.1
Accept: application/json
The following sample response shows the first page of modified code lists:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 282

{
"pageSize":100,
"page":0,
"totalNumberOfElements":1000,
"numberOfElements":1,
"lastPage":true,
"firstPage":true,
"content":[
{
"id":"3f23f14a44bae0f6e2bb8aa2",
"updateDate":"2019-12-11T13:29:55Z",
"changeType":"DIRECT_IMPORT"
"internalId": "isocountry",
"alias": "al_isocountry"
}
]
}

Get code list details (v2)

Retrieves the details of a code list, such as the properties, status, structure definition, and attributes based on an internal ID or alias.

GET request

To retrieve the details of a code list based on an internal ID or alias, submit a GET request with the following URI:
/rdm-service/external/v2/codelists/{codeListKey}

GET response

The response contains the details of the specified code list.
The following table describes the attributes in the response body:
Field
Type
Description
id
String
ID of the asset. For more information, see Asset IDs.
internalId
String
Unique identifier of the code list.
alias
String
Alternative identifier of the code list.
rdsDetails
-
Includes details for the reference data set.
id
String
ID of the reference data set.
internalID
String
Unique identifier of the reference data set.
alias
String
Alternative identifier of the reference data set.
name
String
Name of the code list.
description
String
Optional. Description of the code list.
version
String
Optional. Version of the code list.
application
String
Optional. Application that uses the code list.
hierarchical
Boolean
Optional. Indicates whether code lists in the reference data set inherit the hierarchical structure definition.
levels
Number
Optional. Number of hierarchical levels supported in the code lists associated with the reference data set.
If hierarchical is false or levels are not provided, value is 1. If levels are unlimited, value is -1.
domain
String
Optional. Domain of the asset.
confidentiality
String
Optional. Confidentiality of the asset.
priority
String
Optional. Priority of the asset.
status
String
Optional. Status of the asset.
effectiveDate
String
Optional. Date the asset became effective.
approvedById
String
Optional. ID of the approver of the asset.
approvedByName
String
Optional. User name of the user who approved the asset.
approvedOn
String
Optional. Date the asset was approved.
displayColumns
String
Optional. List of display columns used as labels for code values. Default is name.
codeValueFields
-
Includes the attribute definition for code values in the reference data set.
name
String
Name of the field.
origin
String
Origin of the definition of the field.
datatype
String
Datatype of the field. Values are String, Integer, Decimal, Boolean, Date, or Reference.
mandatory
Boolean
Indicates whether the attribute is required.
labels
Array
Includes list of display names for the fields from the target code list.
language
String
Language in which the field name is displayed.
value
String
Value for the field.
relatedRdsDetails
Array
Includes details of the related reference data set.
id
String
ID of the reference data set. For more information, see Asset IDs.
internalId
String
Unique identifier of the reference data set.
alias
String
Alternative identifier of the reference data set.
relatedListDetails
Array
Includes details of the related code list.
id
String
ID of the code list. For more information, see Asset IDs.
internalId
String
Unique identifier of the code list.
alias
String
Alternative identifier of the code list.
displayColumns
Optional. List of display fields used as labels for the code list.
language
String
Language in which the field name is displayed.
value
String
Value for the field.
dependencyDef
-
Optional. Includes the definition of the asset specified as the dependency.
rdsDetails
-
Includes details for the reference data set.
id
String
Asset ID of the reference data set. For more information, see Asset IDs.
internalID
String
Unique identifier of the reference data set.
externalContacts
Array
Includes details of the external contacts to send notifications.
contactName
String
Name of the contact.
contactType
String
Type of contact, such as email or SMS.
contactDetail
String
Details of contact, such as email address or phone number.
externalUrls
Array
Includes details of the external URLs of the code list.
urlName
String
Name of the external URL.
urlLink
String
Link for the external URL.
Note: You can find the ID of assets in Reference 360 or use REST APIs to retrieve the IDs. For more information, see Asset IDs.

GET example

To retrieve the details of a code list based on an internal ID or alias, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/codelists/sap_country HTTP/1.1
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
The following sample response shows the details of a code list:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1284

{
"id": "e0f3e8e73466a98e71b1731b",
"internalId": "sap_country",
"rdsDetails": {
"id": "Unit Term",
"internalId": "unit_term",
"alias": "units"
},
"name": "Units",
"description": "Code list for units",
"version": "2.0",
"application": "UN recommendation 20",
"hierarchical": false,
"levels": 1,
"domain": "International standards",
"confidentiality": "private",
"priority": "Prio1",
"status": "Draft",
"effectiveDate": "2017-04-01",
"approvedOn": "2017-03-01",
"displayColumns": [
"Name",
"Code"
],
"codeValueFields": [
{
"name": "Name",
"origin": "TERM",
"datatype": "String",
"mandatory": false,
"labels": [
{
"language": "en",
"value": "Name"
}
]
},
{
"name": "Code",
"origin": "TERM",
"datatype": "String",
"mandatory": true,
"labels": [
{
"language": "en",
"value": "Code"
}
]
},
{
"name": "Description",
"origin": "TERM",
"datatype": "String",
"mandatory": false,
"labels": [
{
"language": "en",
"value": "Description"
}
]
},
{
"name": "refField2",
"origin": "CODELIST",
"datatype": "Reference",
"mandatory": true,
"relatedRdsDetails": {
"id": "907cea2cca037950cd1ad67a",
"internalId": "relSetInternalId2",
"alias": "relSetAliasId2"
},
"relatedListDetails": {
"id": "5449217342ac9d487f389b47",
"internalId": "relListInternalId2",
"alias": "relListAliasId2"
},
"displayColumns": [
"column5"
],
"labels": [
{
"language": "en",
"value": "refField2"
}
]
},
{
"name": "achronym",
"origin": "CODELIST",
"datatype": "String",
"mandatory": false,
"labels": [
{
"language": "en",
"value": "achronym"
}
]
}
],
"dependencyDef": {
"rdsDetails": {
"id": "UnitSystemTerm",
"internalId": "unitsystemterm",
"alias": "unit_system_term"
},
"codeListDetails": {
"id": "UnitSystems",
"internalId": "unitsystems",
"alias": "unit_systems"
},
"displayColumns": [
"Name"
]
},
"externalContacts": [
{
"contactName": "Test Name",
"contactType": "SMS",
"contactDetail": "+49 - 7867564543"
},
{
"contactName": "Test Name1",
"contactType": "EMAIL",
"contactDetail": "test@info.com"
}
],
"externalUrls": [
{
"urlName": "TestUrlName",
"urlLink": "https://abc.com"
},
{
"urlName": "TestUrlName1",
"urlLink": "https://abc1.com"
}
]
}

Get history of a code list by time range (v2)

Retrieves all the change events of a code list for a specific time range based on an internal ID or alias.

GET request

To retrieve all the change events of a code list for a specific time range based on an internal ID or alias, submit a GET request with the following URI:
/rdm-service/external/v2/codelists/{assetKey}/summary/audit

GET request query parameters

You can append query parameters to the URI to specify the time range, page number, page size, and modification type.
The following table describes the request query parameters:
Parameter
Description
assetKey
Internal ID or alias of a code list.
from
Start date and time of the time range, which is inclusive. Time range must be in the following ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'. For example, you might use 2019-12-12T14:04:04Z.
to
End date and time of the time range, which is exclusive. Time range must be in the following ISO-8601 format: yyyy-MM-dd’T’HH:mm:ss’Z'. For example, you might use 2019-12-15T14:04:04Z.
page
Optional. Page number to display. Default is 0.
pageSize
Optional. Number of records to display per page. Default value is 100. Maximum value is 10000.
modificationType
Optional. Type of modification. Value can be CREATE, UPDATE, or DELETE.

GET response

The response contains the change events of a code list for a specific time range.
The following table describes the attributes in the response body:
Attribute
Type
Description
pageSize
Number
Number of records displayed per page.
page
Number
Page from which the response was retrieved.
numberOfElements
Number
Number of records returned in the current page.
lastPage
Boolean
Indicates whether the current page is the last page in the total result.
firstPage
Boolean
Indicates whether the current page is the first page in the total result.
content
Array
Includes the list of modification events.
asset
Object
Includes details about the code list.
id
String
ID of the code list.
name
String
Name of the code list.
internalId
String
Unique identifier of the code list.
alias
String
Alternative identifier of the code list.
assetType
String
Type of the code list.
modificationType
String
The type of change made to the code list.
fieldChanges
Object
Includes details about the previous and new values of the fields with changes.
attributeChanges
Object
Includes details about the previous and new values of the attributes with changes.
eventTime
String
The date and time when the code list was last updated.
userName
String
The user name of the user who initiated the modification.
application
String
Optional. Application that uses the code list.
approvedById
String
Optional. ID of the approver of the asset.
approvedByName
String
Optional. User name of the user who approved the asset.
approvedOn
String
Optional. Date the asset was approved.
description
String
Optional. Description of asset.
effectiveDate
String
Optional. Date the asset became effective.
status
String
Optional. Status of the asset.
version
String
Optional. Version of the code list.

GET example

To retrieve all the change events of a code list for a specific time range based on the internal ID or alias, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/codelists/ent_numeric/summary/audit?from=2023-01-01T00:00:00Z&to=2024-01-01T00:00:00Z HTTP/1.1
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
The following sample response shows the change events of the code list from 2023-01-01T00:00:00Z to 2024-01-01T00:00:00Z:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 4991

{
"pageSize": 100,
"page": 0,
"numberOfElements": 8,
"lastPage": true,
"firstPage": true,
"content": [
{
"asset": {
"id": "6407014f5b243e32c4b02ce3",
"name": "ISO 3166-1 numeric",
"internalId": "ent_numeric",
"alias": "als_ent_numeric",
"assetType": "CODELIST"
},
"modificationType": "UPDATE",
"eventTime": "2023-03-07T09:23:35Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "6407014f5b243e32c4b02ce3",
"name": "ISO 3166-1 numeric",
"internalId": "ent_numeric",
"alias": "als_ent_numeric",
"assetType": "CODELIST"
},
"modificationType": "UPDATE",
"fieldChanges": {
"additionalDescription": {
"newValue": "(ISO 3166-1)"
},
"application": {
"newValue": {
"key": "EnterpriseKey",
"label": "Enterprise"
}
},
"approvedById": {
"newValue": "2L0DXgAOiCObZDT7Yql02R"
},
"approvedByName": {
"newValue": "integration-test-planner"
},
"approvedOn": {
"newValue": "2023-03-08"
},
"description": {
"newValue": "Numeric Codes for Countries"
},
"effectiveDate": {
"newValue": "2023-03-06"
},
"status": {
"newValue": {
"key": "ActiveKey",
"label": "Active"
}
},
"version": {
"newValue": "1"
}
},
"eventTime": "2023-03-07T09:23:34Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "6407014f5b243e32c4b02ce3",
"name": "ISO 3166-1 numeric",
"internalId": "ent_numeric",
"alias": "als_ent_numeric",
"assetType": "CODELIST"
},
"modificationType": "UPDATE",
"attributeChanges": {
"NumericCode": {
"name": {
"newValue": "NumericCode"
},
"type": {
"newValue": "String"
},
"required": {
"newValue": "false"
}
}
},
"eventTime": "2023-03-07T09:19:29Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "6407014f5b243e32c4b02ce3",
"name": "ISO 3166-1 numeric",
"internalId": "ent_numeric",
"alias": "als_ent_numeric",
"assetType": "CODELIST"
},
"modificationType": "UPDATE",
"attributeChanges": {
"NumericCode": {
"name": {
"newValue": "NumericCode"
},
"type": {
"newValue": "String"
},
"required": {
"newValue": "false"
}
}
},
"eventTime": "2023-03-07T09:19:27Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "6407014f5b243e32c4b02ce3",
"name": "ISO 3166-1 numeric",
"internalId": "ent_numeric",
"alias": "als_ent_numeric",
"assetType": "CODELIST"
},
"modificationType": "UPDATE",
"eventTime": "2023-03-07T09:18:19Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "6407014f5b243e32c4b02ce3",
"name": "ISO 3166-1 numeric",
"internalId": "ent_numeric",
"alias": "als_ent_numeric",
"assetType": "CODELIST"
},
"modificationType": "UPDATE",
"eventTime": "2023-03-07T09:18:17Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "6407014f5b243e32c4b02ce3",
"name": "ISO 3166-1 numeric",
"internalId": "ent_numeric",
"alias": "als_ent_numeric",
"assetType": "CODELIST"
},
"modificationType": "UPDATE",
"eventTime": "2023-03-07T09:18:09Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "6407014f5b243e32c4b02ce3",
"name": "ISO 3166-1 numeric",
"internalId": "ent_numeric",
"alias": "als_ent_numeric",
"assetType": "CODELIST"
},
"modificationType": "CREATE",
"fieldChanges": {
"displayColumns": {
"newValue": [
"Name"
]
},
"hierarchical": {
"newValue": "false"
},
"levels": {
"newValue": "1"
},
"name": {
"newValue": "ISO 3166-1 numeric"
},
"termId": {
"newValue": "6407004f6b19964cc917c7bf"
}
},
"attributeChanges": {
"Alpha2Code": {
"name": {
"newValue": "Alpha2Code"
},
"type": {
"newValue": "String"
},
"required": {
"newValue": "false"
}
},
"Alpha3Code": {
"name": {
"newValue": "Alpha3Code"
},
"type": {
"newValue": "String"
},
"required": {
"newValue": "false"
}
},
"Code": {
"name": {
"newValue": "Code"
},
"type": {
"newValue": "String"
},
"required": {
"newValue": "true"
}
},
"Description": {
"name": {
"newValue": "Description"
},
"type": {
"newValue": "String"
},
"required": {
"newValue": "false"
}
},
"Name": {
"name": {
"newValue": "Name"
},
"type": {
"newValue": "String"
},
"required": {
"newValue": "true"
}
}
},
"eventTime": "2023-03-07T09:18:07Z",
"userName": "integration-test-admin"
}
]
}

Get crosswalks for a code list (v2)

Retrieves the crosswalks associated to a code list and the summary information for each crosswalk based on an internal ID or alias.

GET request

To retrieve all crosswalks associated to a code list based on an internal ID or alias, submit a GET request with the following URI:
/rdm-service/external/v2/codelists/{codeListKey}/crosswalks

GET request query parameters

The following table describes the parameter in the request:
Parameter
Type
Description
codeListKey
String
Internal ID or alias of a code list of the crosswalk.

GET response

The response contains the crosswalks associated to the code list.
The following table describes the attributes in the response body:
Field
Type
Description
id
String
ID of the code list. For more information, see Asset IDs.
internalId
String
Unique identifier of the code list.
description
String
Optional. Description of the code list.
status
String
Optional. Status of the code list.
confidentiality
String
Optional. Confidentiality of the code list.
effectiveDate
String
Optional. Date when the code list became effective.
approvedOn
String
Optional. Date when the code list was approved.
sourceCodeListDetails
Object
Includes details of the source code list to which the crosswalk is associated.
id
String
ID of the source code list to which the crosswalk is associated.
targetCodeListDetails
Object
Includes details of the target code list to which the crosswalk is associated.
id
String
ID of the target code list to which the crosswalk is associated.
Note: You can find the ID of assets in Reference 360 or use REST APIs to retrieve the IDs. For more information, see Asset IDs.

GET example

To retrieve the crosswalks associated to a code list based on an internal ID or alias, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/codelists/internalId/crosswalks HTTP/1.1
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
The following sample response shows the crosswalks associated to a code list:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 514
[
{
"id": "af5dc4d0d7ada6609985ab33",
"internalId": "internalId",
"description": "Sample Crosswalk 1",
"status": "active",
"sourceCodeListDetails": {
"id": "85812f48d51aac9513b7df4e"
},
"targetCodeListDetails": {
"id": "3dd16657bab79b6d60eab2ff"
}
},
{
"id": "3536aeb4364a4afabca8eadd",
"internalId": "internalId2",
"description": "Sample Crosswalk 2",
"status": "inactive",
"confidentiality": "private",
"effectiveDate": "2007-04-01",
"approvedOn": "2017-03-01",
"sourceCodeListDetails": {
"id": "85812f48d51aac9513b7df4e"
},
"targetCodeListDetails": {
"id": "c4a1387ef17d161d3a3c2575"
}
}
]

Get latest modified code values by time range (v2)

Retrieves the latest modified code values in a code list for a time range based on an internal ID or alias.
By default, the request returns the first 100 records. To retrieve more records or to view the next page of records, use the query parameters. You can retrieve a maximum of 10000 records in a request.

GET request

To retrieve the latest modified code values in a code list for a time range based on an internal ID or alias, submit a GET request with the following URI:
/rdm-service/external/v2/codelists/{codeListKey}/codevalues/modifications
To specify the page number and page size, submit a GET request with the following query parameters appended to the URI:
/rdm-service/external/v2/codelists/{codeListKey}/codevalues/modifications?from=<from>&to=<to>[&pageSize=<page size>&page=<page number>]
The following table describes the parameter in the URI:
Parameter
Description
codeListKey
Internal ID or alias of the code list from which you are retrieving the code values.
from
Start date and time of the time range, which is inclusive. Time range must be in the following ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'. For example, you might use 2019-12-12T14:04:04Z.
to
End date and time of the time range, which is exclusive. Time range must be in the following ISO-8601 format: yyyy-MM-dd’T’HH:mm:ss’Z'. For example, you might use 2019-12-15T14:04:04Z.
page
Optional. Page number to display. Default is 0.
pageSize
Optional. Number of records to display per page. Default value is 100. Maximum value is 10000.

GET response

The response contains details about the latest modified code values.
The following table describes the attributes in the response body:
Field
Type
Description
page
Number
Page from which the response was retrieved.
pageSize
Number
Number of records displayed per page.
totalNumberOfElements
Number
Total number of records found.
numberOfElements
Number
Number of records returned in the current page.
lastPage
Boolean
Indicates whether the current page is the last page in the total result.
firstPage
Boolean
Indicates whether the current page is the first page in the total result.
content
Array
Includes the list of code values.
status
String
Status of the code list.
dependency
String
ID of the code value specified as the dependency.
lastUpdateDate
String
Date when the code value was last updated.
changeType
String
Type of change made to the code list. Values are MODIFIED and DELETED.
effectiveDate
String
Date when the code list became effective.
codeValueFields
Object
Includes the attribute definition for code values.

GET example

To retrieve the first page of the latest modified code values for a time range based on an internal ID or alias, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/codelists/country/codevalues/modifications?from=2019-12-11T13:29:55Z&to=2019-12-12T13:29:55Z&page=0&pageSize=100 HTTP/1.1
Accept: application/json
The following sample response shows the first page of the latest modified code values:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 412

{
"pageSize":100,
"page":0,
"totalNumberOfElements":1000,
"numberOfElements":1,
"lastPage":false,
"firstPage":true,
"content":[
{
"status":"Draft",
"dependency":"f9b48b61fbeb3b491a69bd44",
"lastUpdateDate":"2019-12-11T13:29:55Z",
"changeType":"MODIFIED",
"effectiveDate":"2017-04-01",
"codeValueFields":{
"Description": "C5",
"Code": "C8",
"Name": "N8"
}
}
]
}

Get history of code value hierarchies by time range (v2)

Retrieves all the change events of code value hierarchies for a specific time range based on an internal ID or alias.

GET request

To retrieve all the change events of code value hierarchies for a specific time range based on an internal ID or alias, submit a GET request with the following URI:
/rdm-service/external/v2/codelists/{codeListKey}/codevalues/hierarchy/audit

GET request query parameters

You can append query parameters to the URI to specify the time range, page number, page size, and modification type.
The following table describes the query parameters:
Parameter
Description
codeListKey
Internal ID or alias of the code list from which you are retrieving the code values.
from
Start date and time of the time range, which is inclusive. Time range must be in the following ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'. For example, you might use 2019-12-12T14:04:04Z.
to
End date and time of the time range, which is exclusive. Time range must be in the following ISO-8601 format: yyyy-MM-dd’T’HH:mm:ss’Z'. For example, you might use 2019-12-15T14:04:04Z.
page
Optional. Page number to display. Default is 0.
pageSize
Optional. Number of records to display per page. Default value is 100. Maximum value is 10000.
modificationType
Optional. Type of modification. Value can be CREATE or DELETE.

GET response

The response contains the change events of code value hierarchies for a specific time range.
The following table describes the attributes in the response body:
Attribute
Type
Description
page
Number
Page from which the response was retrieved.
pageSize
Number
Number of records displayed per page.
numberOfElements
Number
Number of records returned in the current page.
lastPage
Boolean
Indicates whether the current page is the last page in the total result.
firstPage
Boolean
Indicates whether the current page is the first page in the total result.
content
Array
Includes the list of modification events.
asset
Object
Includes details about the code values of the code list.
id
String
ID of the code list. For more information, see Asset IDs.
internalId
String
Unique identifier of the code list.
alias
String
Alternative identifier of the code list.
assetType
String
Type of the asset. The value is CODELIST.
modificationType
String
The type of change made to the code values of the code list.
eventTime
String
The date and time the code values were last updated.
userName
String
The user name of the user who initiated the modification.

GET example

To retrieve all the change events of code value hierarchies for a specific time range based on an internal ID or alias, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/codelists/cl_country/codevalues/hierarchy/audit?from=2023-01-01T00:00:00Z&to=2024-01-01T00:00:00Z HTTP/1.1
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
The following sample response shows the change events of the code value hierarchies from 2023-01-01T00:00:00Z to 2024-01-01T00:00:00Z:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 3441

{
"pageSize": 100,
"page": 0,
"numberOfElements": 12,
"lastPage": true,
"firstPage": true,
"content": [
{
"asset": {
"id": "64071b105b243e32c4b04caa",
"internalId": "cl_country",
"alias": "als_cl_country",
"assetType": "CODELIST"
},
"modificationType": "DELETE",
"from": {
"previousValue": "France"
},
"to": {
"previousValue": "Europe"
},
"eventTime": "2023-03-07T11:11:06Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "64071b105b243e32c4b04caa",
"internalId": "cl_country",
"alias": "als_cl_country",
"assetType": "CODELIST"
},
"modificationType": "DELETE",
"from": {
"previousValue": "Paris"
},
"to": {
"previousValue": "France"
},
"eventTime": "2023-03-07T11:11:06Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "64071b105b243e32c4b04caa",
"internalId": "cl_country",
"alias": "als_cl_country",
"assetType": "CODELIST"
},
"modificationType": "CREATE",
"from": {
"newValue": "America"
},
"eventTime": "2023-03-07T11:10:14Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "64071b105b243e32c4b04caa",
"internalId": "cl_country",
"alias": "als_cl_country",
"assetType": "CODELIST"
},
"modificationType": "CREATE",
"from": {
"newValue": "Europe"
},
"eventTime": "2023-03-07T11:10:14Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "64071b105b243e32c4b04caa",
"internalId": "cl_country",
"alias": "als_cl_country",
"assetType": "CODELIST"
},
"modificationType": "CREATE",
"from": {
"newValue": "USA"
},
"to": {
"newValue": "America"
},
"eventTime": "2023-03-07T11:10:14Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "64071b105b243e32c4b04caa",
"internalId": "cl_country",
"alias": "als_cl_country",
"assetType": "CODELIST"
},
"modificationType": "CREATE",
"from": {
"newValue": "New York"
},
"to": {
"newValue": "USA"
},
"eventTime": "2023-03-07T11:10:14Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "64071b105b243e32c4b04caa",
"internalId": "cl_country",
"alias": "als_cl_country",
"assetType": "CODELIST"
},
"modificationType": "CREATE",
"from": {
"newValue": "Canada"
},
"to": {
"newValue": "America"
},
"eventTime": "2023-03-07T11:10:14Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "64071b105b243e32c4b04caa",
"internalId": "cl_country",
"alias": "als_cl_country",
"assetType": "CODELIST"
},
"modificationType": "CREATE",
"from": {
"newValue": "Toronto"
},
"to": {
"newValue": "Canada"
},
"eventTime": "2023-03-07T11:10:14Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "64071b105b243e32c4b04caa",
"internalId": "cl_country",
"alias": "als_cl_country",
"assetType": "CODELIST"
},
"modificationType": "CREATE",
"from": {
"newValue": "Germany"
},
"to": {
"newValue": "Europe"
},
"eventTime": "2023-03-07T11:10:14Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "64071b105b243e32c4b04caa",
"internalId": "cl_country",
"alias": "als_cl_country",
"assetType": "CODELIST"
},
"modificationType": "CREATE",
"from": {
"newValue": "Berlin"
},
"to": {
"newValue": "Germany"
},
"eventTime": "2023-03-07T11:10:14Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "64071b105b243e32c4b04caa",
"internalId": "cl_country",
"alias": "als_cl_country",
"assetType": "CODELIST"
},
"modificationType": "CREATE",
"from": {
"newValue": "France"
},
"to": {
"newValue": "Europe"
},
"eventTime": "2023-03-07T11:10:14Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "64071b105b243e32c4b04caa",
"internalId": "cl_country",
"alias": "als_cl_country",
"assetType": "CODELIST"
},
"modificationType": "CREATE",
"from": {
"newValue": "Paris"
},
"to": {
"newValue": "France"
},
"eventTime": "2023-03-07T11:10:14Z",
"userName": "integration-test-admin"
}
]
}

Get history of code values of a code list (v2)

Retrieves all the change events of code values of a code list for a specific time range based on an internal ID or alias.

GET request

To retrieve all the change events of code values of a code list for a specific time range based on an internal ID or alias, submit a GET request with the following URI:
/rdm-service/external/v2/codelists/{codeListKey}/codevalues/audit

GET request query parameters

You can append query parameters to the URI to specify the time range, page number, page size, and modification type.
The following table describes the query parameters:
Parameter
Description
codeListKey
Internal ID or alias of the code list from which you are retrieving the code values.
from
Start date and time of the time range, which is inclusive. Time range must be in the following ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'. For example, you might use 2019-12-12T14:04:04Z.
to
End date and time of the time range, which is exclusive. Time range must be in the following ISO-8601 format: yyyy-MM-dd’T’HH:mm:ss’Z'. For example, you might use 2019-12-15T14:04:04Z.
page
Optional. Page number to display. Default is 0.
pageSize
Optional. Number of records to display per page. Default value is 100. Maximum value is 10000.
modificationType
Optional. Type of modification. Value can be CREATE or UPDATE_AND_DELETE.

GET response

The response contains the change event of code values of a code list for a specific time range.
The following table describes the attributes in the response body:
Attribute
Type
Description
pageSize
Number
Number of records displayed per page.
page
Number
Page from which the response was retrieved.
numberOfElements
Number
Number of records returned in the current page.
firstPage
Boolean
Indicates whether the current page is the first page in the total result.
lastPage
Boolean
Indicates whether the current page is the last page in the total result.
content
Array
Includes the list of modification events.
asset
Object
Includes details about the code values of the code list.
id
String
ID of the code list. For more information, see Asset IDs.
internalId
String
Unique identifier of the code list.
alias
String
Alternative identifier of the code list.
assetType
String
Type of the asset. The value is CODELIST.
modificationType
String
Type of change made to the code values of the code list.
changedAttributes
Object
Includes details about the previous and new values of the attributes with changes.
code
String
Code field of the code values.
codeValueId
String
Internal ID of the code values.
eventTime
String
Date and time when the code values were last updated.
userName
String
User name of the user who initiated the modification.

GET example

To retrieve all the change events of code values of a code list for a specific time range based on an internal ID or alias, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/codelists/cl_country/codevalues/audit?from=2023-01-01T00:00:00Z&to=2024-01-01T00:00:00Z HTTP/1.1
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
The following sample response shows the change events of the code values of the code list from 2023-01-01T00:00:00Z to 2024-01-01T00:00:00Z:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 3441

{
"pageSize": 100,
"page": 0,
"numberOfElements": 12,
"lastPage": true,
"firstPage": true,
"content": [
{
"asset": {
"id": "64071b105b243e32c4b04caa",
"internalId": "cl_country",
"alias": "als_cl_country",
"assetType": "CODELIST"
},
"modificationType": "DELETE",
"from": {
"previousValue": "France"
},
"to": {
"previousValue": "Europe"
},
"eventTime": "2023-03-07T11:11:06Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "64071b105b243e32c4b04caa",
"internalId": "cl_country",
"alias": "als_cl_country",
"assetType": "CODELIST"
},
"modificationType": "DELETE",
"from": {
"previousValue": "Paris"
},
"to": {
"previousValue": "France"
},
"eventTime": "2023-03-07T11:11:06Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "64071b105b243e32c4b04caa",
"internalId": "cl_country",
"alias": "als_cl_country",
"assetType": "CODELIST"
},
"modificationType": "CREATE",
"from": {
"newValue": "America"
},
"eventTime": "2023-03-07T11:10:14Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "64071b105b243e32c4b04caa",
"internalId": "cl_country",
"alias": "als_cl_country",
"assetType": "CODELIST"
},
"modificationType": "CREATE",
"from": {
"newValue": "Europe"
},
"eventTime": "2023-03-07T11:10:14Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "64071b105b243e32c4b04caa",
"internalId": "cl_country",
"alias": "als_cl_country",
"assetType": "CODELIST"
},
"modificationType": "CREATE",
"from": {
"newValue": "USA"
},
"to": {
"newValue": "America"
},
"eventTime": "2023-03-07T11:10:14Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "64071b105b243e32c4b04caa",
"internalId": "cl_country",
"alias": "als_cl_country",
"assetType": "CODELIST"
},
"modificationType": "CREATE",
"from": {
"newValue": "New York"
},
"to": {
"newValue": "USA"
},
"eventTime": "2023-03-07T11:10:14Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "64071b105b243e32c4b04caa",
"internalId": "cl_country",
"alias": "als_cl_country",
"assetType": "CODELIST"
},
"modificationType": "CREATE",
"from": {
"newValue": "Canada"
},
"to": {
"newValue": "America"
},
"eventTime": "2023-03-07T11:10:14Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "64071b105b243e32c4b04caa",
"internalId": "cl_country",
"alias": "als_cl_country",
"assetType": "CODELIST"
},
"modificationType": "CREATE",
"from": {
"newValue": "Toronto"
},
"to": {
"newValue": "Canada"
},
"eventTime": "2023-03-07T11:10:14Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "64071b105b243e32c4b04caa",
"internalId": "cl_country",
"alias": "als_cl_country",
"assetType": "CODELIST"
},
"modificationType": "CREATE",
"from": {
"newValue": "Germany"
},
"to": {
"newValue": "Europe"
},
"eventTime": "2023-03-07T11:10:14Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "64071b105b243e32c4b04caa",
"internalId": "cl_country",
"alias": "als_cl_country",
"assetType": "CODELIST"
},
"modificationType": "CREATE",
"from": {
"newValue": "Berlin"
},
"to": {
"newValue": "Germany"
},
"eventTime": "2023-03-07T11:10:14Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "64071b105b243e32c4b04caa",
"internalId": "cl_country",
"alias": "als_cl_country",
"assetType": "CODELIST"
},
"modificationType": "CREATE",
"from": {
"newValue": "France"
},
"to": {
"newValue": "Europe"
},
"eventTime": "2023-03-07T11:10:14Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "64071b105b243e32c4b04caa",
"internalId": "cl_country",
"alias": "als_cl_country",
"assetType": "CODELIST"
},
"modificationType": "CREATE",
"from": {
"newValue": "Paris"
},
"to": {
"newValue": "France"
},
"eventTime": "2023-03-07T11:10:14Z",
"userName": "integration-test-admin"
}
]
}

Search code values (v2)

Use the search API to search for code values in all the code lists based on an internal ID or alias.

POST request

To search for code values in all the code lists based on an internal ID or alias, submit a POST request with the following URI:
/rdm-service/external/v2/search
Use the following parameters in the search request:
Field
Type
Description
showAssetDetails
Boolean
Indicates whether the search result displays the details of assets. Value can be true or false. Default is false.
page
Integer
Optional. Page number to display.
Default is 0.
pageSize
Integer
Optional. Number of code values that you want to display on each page.
Default is 100. You can specify up to 10000.
search
String
Search string that must contain a minimum of two characters.
For example, you can specify the search string as "IND."
You can use only the values of string data type attributes, such as name, code, description, and other custom string attributes.
Note: You can't use the values of integer, date, boolean, and decimal data type attributes in the search string.
To retrieve all the code values, use an asterisk (*).
To retrieve the exact code value that you search for, specify the search string in the following format:
"\"<search_string>\""
For example, to search for the exact code value AUSTRIA, specify "\"AUSTRIA\"" as search string.

POST response

The request response returns the search results.
The response contains the following attributes in the response body:
Field
Type
Description
pageSize
Integer
Number of code values displayed on each page.
page
Integer
Number of the page that you retrieved.
totalNumberOfElements
Integer
Total number of code values found.
numberOfElements
Integer
Total number of code values on the current page.
lastPage
Boolean
Indicates whether the current page is the last page of the search results.
firstPage
Boolean
Indicates whether the current page is the first page of the search results.
content
Object
Includes the list of code values.
record
Array
Includes the details of the code value.
Name
String
Name of the code value.
Code
String
Code field value of the code value.
referenceDataSetDetails
Array
Includes details of the reference data set.
id
String
ID of the reference data set. For more information, see Asset IDs.
name
String
Name of the reference data set.
internalId
String
Unique identifier of the reference data set.
alias
String
Alternative identifier of the reference data set.
codeListDetails
Array
Includes details of the code list.
id
String
ID of the code list. For more information, see Asset IDs.
name
String
Name of the code list.
internalId
String
Unique identifier of the code list.
alias
String
Alternative identifier of the code list.

POST example

To search for code values in all the code lists based on the internal ID or alias, you might use the following request:
POST https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/search?showAssetDetails=true' HTTP/1.1
Content-Type: application/json
Accept: application/octet-stream
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
{
"page":1,
"pageSize":1,
"search":"IN"
The following sample response displays the code values that contain IN in all the code lists:
{
"pageSize": 1,
"page": 0,
"totalNumberOfElements": 20,
"numberOfElements": 1,
"lastPage": false,
"firstPage": true,
"content": [
{
"record": {
"Description": "Desc-India",
"Name": "INDIA",
"Code": "IN"
},
"referenceDataSetDetails": {
"id": "65603a826052154799cd87b1",
"name": "Country",
"internalId": "country",
"alias": "als_country"
},
"codeListDetails": {
"id": "65603a836052154799cd87c2",
"name": "Enterprise Country",
"internalId": "ent_country",
"alias": "als_ent_country"
}
}
]
}

Export code value hierarchy to JSON format (v2)

Exports the subset of code values in a hierarchical code list to a JSON file based on an internal ID or alias.

GET request

To export the subset of code values in a hierarchical code list based on an internal ID or alias, submit a GET request with the following URI:
/rdm-service/external/v2/codelists/{codeListKey}/codevalues/subset/{subsetId}/cursor?page={page}
Note: This API supports only incremental pagination starting from page 0. In the request header, you must specify the Accept attribute to application/json.
Use the following parameters in the request query to specify the subset of code values to export:
Field
Type
Description
codeListKey
String
Internal ID or alias of the hierarchical code list.
subSetIdentifier
String
ID of the subset.
page
Number
Page number to display. Default value is 0.
limit
Number
Optional. Number of records to display on each page. Default value is 10000.

GET response

The response is in JSON file.

GET example

To export the subset of code values in a hierarchical code list based on an internal ID or alias, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/codelists/ent_country/codevalues/subset/71253be5deb0e7d4974935e0/cursor?page=0 HTTP/1.1
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
The following sample response shows the exported subset of code values in the JSON file:
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 352

{
"pageSize":2,
"page":0,
"numberOfElements":2,
"content":[
{
"Code":"STUDENT-1001",
"fields":{
"Code":"STUDENT-1001",
"Name":"ppniK"
},
"parentId":"UNIVERSITY-001"
},
{
"Code":"UNIVERSITY-001",
"fields":{
"Code":"UNIVERSITY-001",
"Name":"ABC University"
}
}
]
}

Update cursor settings of the subset of code values (v2)

Updates the cursor settings of the subset of code values based on an internal ID or alias.

PUT request

To update the cursor settings of the subset of code values based on an internal ID or alias, submit a PUT request with the following URI:
/rdm-service/external/v2/codelists/{codeListKey}/codevalues/subset/{subSetIdentifier}/cursor
Note: When you update the cursor setting, the page is reset to zero. The export API exports the subset of code values from the starting page.
The following table describes the query parameters:
Field
Type
Description
codeListKey
String
Internal ID or alias of the code list.
subSetIdentifier
String
ID of the subset.
filename
String
File name for the exported file. Value must end with the .csv file extension.
repeatHeaders
Boolean
Optional. Indicates whether to populate headers in the CSV response. Value is true or false. Default is false.
delimiter
String
Optional. Delimiter used to separate values. Value must be ASTERISK, CIRCUMFLEX, COLON, COMMA, PIPE, SECTION, SEMICOLON, SPACE or TAB. Default is COMMA.
decimalSeparator
String
Optional. Decimal separator used for numbers. Value must be COMMA or DOT. Default is DOT.
thousandSeparator
String
Optional. Grouping separator used for numbers. Value must be COMMA, DOT, SPACE, SINGLEQUOTE or NONE. Default is NONE.
dateFormat
String
Format used for dates. Use one of the following formats:
  • - DE. For dd.mm.yyyy format.
  • - ISO. For yyyy-mm-dd format.
  • - US. For mm/dd/yyyy format.
Default is ISO.
addLabelsForReferenceAttribute
Boolean
Optional. Displays values for reference and dependent attributes based on the display attributes of reference and dependent code lists, respectively.
codepage
String
Optional. Code page used for the export file. Value must be UTF8 or MS_WINDOWS. Default is UTF8.
columns
Array
Optional. Attribute columns you want to export. If you do not specify attribute columns, the export includes all the attribute columns.
fieldName
String
Optional. Name of attribute column to include in the exported file.
codeListId
String
ID of the code list.
noOfRecordsPerPage
Number
Optional. Number of records to display on each page. The maximum value is 10000. Default is 10000.

PUT response

A 204 no content response is returned.

PUT example

To update the cursor settings of the subset of code values based on the internal ID or alias, you might use the following request:
PUT https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/codelists/country/codevalues/subset/71253be5deb0e7d4974935e0/cursor HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 391

{
"filename":"codeValueHierarchyExportFile.csv",
"repeatHeaders":true,
"delimiter":"COMMA",
"decimalSeparator":"COMMA",
"thousandSeparator":"DOT",
"dateFormat":"DE",
"addLabelsForReferenceAttribute":true,
"codepage":"UTF8",
"columns":[
{
"fieldName":"columnName",
"codeListId":"5d352cbb8de0392f8c0710d3"
}
],
"noOfRecordsPerPage":10000
}
The following sample response shows the no content response:
HTTP/1.1 204 No Content