Use this resource to retrieve the details of a code list, the details of a code value, and the crosswalks associated to a code list. You can also unlock code lists locked by other users.
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 ServicesReference 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
Get code list details
Retrieves the details of a code list, such as the properties, status, structure definition, and attributes.
GET request
To retrieve the details of a code list, submit a GET request with the following URI:
/rdm-service/external/v1/codelists/<code list ID>
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 response
The response contains the details of the specified code list.
The following table describes the attributes in the response:
Field
Type
Description
id
String
ID of the asset. Assets include reference data sets, code lists, crosswalks, and hierarchies. For more information, see Asset IDs.
termId
String
ID of the reference data set to which the code list is associated.
name
String
Name of the asset.
description
String
Optional. Description of asset.
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. Username of the user who approved the asset.
approvedOn
String
Optional. Date the asset was approved.
defaultList
String
ID of the default code list.
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.
relatedTermId
String
Optional. If the attribute datatype is Reference, lists the ID of the reference data set.
displayColumns
Array
Optional. If the attribute datatype is Reference, lists the display columns.
dependencyDef
-
Optional. Includes the definition of the asset specified as the dependency.
termId
String
Optional. ID of the asset specified as the dependency.
displayColumns
Array
Optional. Display columns used as labels for code values associated with the dependent asset.
GET example
To retrieve the details of a code list, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/codelists/4fb1356728272974bd46945f 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
Retrieves all the change events of a code list for a specific time range.
GET request
To retrieve all the change events of a code list for a specific time range, submit a GET request with the following URI:
/rdm-service/external/v1/codelists/<Code list ID>/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 query parameters:
Parameter
Description
from
Start date and time of a time range. The start date and time is inclusive. Set the time range in the ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'. For example, you can set 2023-01-01T00:00:00Z.
to
End date and time of a time range. The end date and time is exclusive. Set the time range in the ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'. For example, you can set 2024-01-01T00:00:00Z.
page
Optional. Page number to display. Default is 0.
pageSize
Optional. The number of records to display on each page. Default is 100. Maximum 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:
Attribute
Type
Description
pageSize
Number
The number of records displayed on each page.
page
Number
Page number displayed.
numberOfElements
Number
The number of events.
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.
modificationType
String
The type of change made to the code list.
fieldChanges
Object
Displays the previous and new values of the fields with changes.
attributeChanges
Object
Displays the previous and new values of the attributes with changes.
eventTime
String
The date and time the code list was last updated.
userName
String
The user name of the user who initiated the modification.
GET example
To retrieve all the change events of a code list for a specific time range, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/codelists/9ae8fcf6b8f0327a7bdb7f2c/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
You identify the code value that you want to retrieve the details for by specifying the value in the Code attribute.
Note: You cannot use the + symbol inside the code field value.
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/v1/codelists/{code list ID}/codevalues?Code={code}
GET response
The response contains the details of the code value.
The following table describes the attributes in the response:
Field
Type
Description
codelistId
String
ID of the code list that the code values belong to.
status
String
Optional. Status of the code value.
Note: To retrieve a list of statuses, use the List enum entries API. For more information, see Get system reference data values.
effectiveDate
String
Optional. Date the code value became effective.
codeValueFields
Object
Includes the attribute field values for the code value.
GET example
To retrieve the details of a code value, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/codelists/591c302d8af18b0001b1fac2/codevalues?Code=AR 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":"591c302d8af18b0001b1fac2", "status":"Draft", "effectiveDate":"2019-09-20", "codeValueFields":{ "Name":"Argentina", "Code":"AR", "description":"The EU country code for Argentina" } } ]
Get history of code values of a code list
Retrieves all the change events of code values of a code list for a specific time range.
GET request
To retrieve all the change events of code values of a code list for a specific time range, submit a GET request with the following URI:
/rdm-service/external/v1/codelists/<code list ID>/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
from
Start date and time of a time range. The start date and time is inclusive. Set the time range in the ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'. For example, you can set 2023-01-01T00:00:00Z.
to
End date and time of a time range. The end date and time is exclusive. Set the time range in the ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'. For example, you can set 2024-01-01T00:00:00Z.
page
Optional. Page number to display. Default is 0.
pageSize
Optional. The number of records to display on each page. Default is 100. Maximum 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:
Attribute
Type
Description
pageSize
Number
The number of records displayed on each page.
page
Number
Page number displayed.
numberOfElements
Number
The number of events.
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.
modificationType
String
The type of change made to the code values of the code list.
changedAttributes
Object
Displays the previous and new values of the attributes with changes.
code
String
The code field of the code values.
codeValueId
String
Internal ID of the code values.
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 values of a code list for a specific time range, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/codelists/c2f9323dbec86b2cfe8a8101/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
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:
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 UPDATE.
records
Array
List of code values to update.
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.
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.
Note: You can't update code values that are defined as a parent code value in a hierarchical code list. Use the code value REST API to move a code value to another node within the same hierarchical code list.
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
When you update a code value in a hierarchical code list, you don't need to use the parentCode attribute.
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
-
Lists the code values that were updated successfully and describes the details of the code values.
Code
String
Code attribute value for the updated code value.
label
String
Display attribute value for the updated code value.
failedRecords
-
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 couldn't be updated.
errorCode
String
Error code for the error type.
errorSummary
String
A short summary that explains why the code value wasn'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, you might use the following request:
{ "successfulRecords": [], "failedRecords": [ { "label": "NAME-A", "errorCauses": [ { "errorCode": "RDM.001027674", "errorSummary": "The specified code value does not exist.", "errorParameter": { "Code": "CODE-A" } } ], "Code": "CODE-A" } ], "successfulRecordsCount": 0, "failedRecordsCount": 1 }
Delete code values
Deletes one or multiple code values that you no longer need. When you delete code values using the Delete code values API, you directly delete code values without creating a 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 for 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
DELETE request
To delete a code value, submit a DELETE request with the following URI:
/rdm-service/external/v1/codelists/<code list ID>/codevalues
The following table describes the attributes in the request:
Field
Type
Description
Codes
String
Comma-separated list of code values by the value in the Code attribute.
DELETE response
The response contains the deletion report. If the delete failed, the report provides failure reasons.
The following table describes the attributes in the response:
Field
Type
Description
numberOfRecordsDeleted
Number
Number of code values that were deleted successfully.
numberOfRecordsFailed
Number
Number of code values that were not deleted.
deletedRecords
-
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
-
Lists the code values that were not deleted and describes the reasons.
Code
String
Code attribute value for the code value.
label
String
Display attribute value for the code value.
errorCode
String
Error code for the error type.
errorSummary
String
Explains why the code value was not deleted.
The display attribute value represents the code value when the code value appears in other assets in Reference 360. For more information, see Display attributes.
DELETE example
To delete code values, you might use the following request:
Export a subset of code values in a hierarchical code list
Use this resource to export a subset of code values from a starting node and its ancestors and descendants with specified level in a hierarchical code list.
Create a subset ID for code values in a hierarchical code list
Creates a subset ID for code values in a hierarchical code list.
POST request
To create a subset ID for code values in a hierarchical code list, submit a POST request with the following URI:
Use the following parameters in the request body to specify the code value hierarchy:
Field
Type
Description
type
String
Type of the code values subset. Value must be ANCESTORS_AND_DESCENDANTS.
ancestors
-
The ancestors of the code value that you want to export.
depth
Number
Optional. The levels of ancestors of the code value that you want to export.
include
Boolean
The flag to indicate inclusion of ancestors of the code value.
descendants
-
The descendants of the code value that you want to export.
depth
Number
Optional. The levels of descendants of the code value that you want to export.
include
Boolean
The flag to indicate inclusion of descendants of the code value that you want to export.
startNode
-
The starting node of the code value that you want to export.
code
String
The code field of the starting node of the code value that you want to export.
cursorSettings
-
Includes details about the cursor settings.
repeatHeaders
Boolean
Optional. Indicates whether to populate headers in the CSV response. Value is true or false. Default is false.
addLabelsForReferenceAttribute
Boolean
Optional. Displays values for reference and dependent attributes based on the display attributes of reference and dependent code lists, respectively.
delimiter
String
Optional. Delimiter used to separate values. Value must be ASTERISK, CIRCUMFLEX, COLON, COMMA, PIPE, SECTION, SEMICOLON, SPACE, or TAB. Default is COMMA.
codepage
String
Optional. Code page used for the export file. Value can be UTF8 or MS_WINDOWS. Default is UTF8.
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 can be COMMA, DOT, SPACE, SINGLEQUOTE or NONE. Default is NONE.
filename
String
File name for the exported file. Value must end with the .csv file extension.
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.
columns
Array
Optional. Attribute columns that you want to export. If you don't 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.
POST response
The response contains the subset ID of the code value hierarchy in a hierarchical code list.
POST example
To create a subset ID for code value hierarchy in a hierarchical code list, you might use the following request:
POST https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/codelists/5d352cbb8de0392f8c0710d3/codevalues/subset HTTP/1.1 Content-Type: application/json Accept: application/json IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
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.
Field
Type
Description
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, you might use the following request:
PUT https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/codelists/5d352cbb8de0392f8c0710d3/codevalues/subset/71253be5deb0e7d4974935e0/cursor HTTP/1.1 Content-Type: application/json Accept: application/json Content-Length: 391
Note: This API supports only incremental pagination starting from page 0. In the request header, you must specify the Accept attribute to application/octet-stream.
Use the following parameters in the request query to specify the subset of code values to export:
Field
Type
Description
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 a CSV file.
GET example
To export the subset of code values in a hierarchical code list, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/codelists/5d352cbb8de0392f8c0710d3/codevalues/subset/71253be5deb0e7d4974935e0/cursor?page=0 HTTP/1.1 Content-Type: application/json Accept: application/octet-stream IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
The following sample response shows the exported subset of code values in a CSV file:
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
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, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/codelists/5d352cbb8de0392f8c0710d3/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
Get history of code value hierarchies by time range
Retrieves all the change events of code value hierarchies for a specific time range.
GET request
To retrieve all the change events of code value hierarchies for a specific time range, submit a GET request with the following URI:
/rdm-service/external/v1/codelists/<code list ID>/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
from
Start date and time of a time range. The start date and time is inclusive. Set the time range in the ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'. For example, you can set 2023-01-01T00:00:00Z.
to
End date and time of a time range. The end date and time is exclusive. Set the time range in the ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'. For example, you can set 2024-01-01T00:00:00Z.
page
Optional. Page number to display. Default is 0.
pageSize
Optional. The number of records to display on each page. Default is 100. Maximum 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:
Attribute
Type
Description
pageSize
Number
The number of records displayed on each page.
page
Number
Page number displayed.
numberOfElements
Number
The number of events.
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.
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, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/codelists/c2f9323dbec86b2cfe8a8101/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
Retrieves the latest modified code values in a code list for a 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 latest modified code values in a code list for a time range, submit a GET request with the following URI:
/rdm-service/external/v1/codelists/<code list ID>/codevalues/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/v1/codelists/<code list ID>/codevalues/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.
The following table lists the query parameters:
Parameter
Description
from
Start date and time of the time range. The start point is inclusive. Time range must be in the 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. The end point is exclusive. Time range must be in the 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:
Field
Type
Description
page
Number
Page number displayed.
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
Included in the content object.
Optional. Status of the code value.
effectiveDate
String
Included in the content object.
Optional. Date code value becomes effective.
codeValueFields
Object
Included in the content object.
Contains the field values for the code value.
lastUpdateDate
String
Included in the content object.
Update date of the last modification.
changeType
Object
Included in the content object.
Type of change made to the code value. Values are MODIFIED or DELETED.
Note: The MODIFIED change type appears for both new and updated code values.
GET example
To retrieve the first page of the latest modified code values for a time range, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/codelists/ce63c85efb9791eb49c4baa3/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
•If the code list is in draft state, some code values might appear in the API response even though the code values have not changed in the specified time range. For example, if you delete a code value in a draft code list, the last update date of the code value updates to the date the code value was deleted in the draft. This means that the deleted code value in the draft code list might meet the specified time range criteria now.
Get modified code value relationships in hierarchy by time range
Retrieve the modified code value relationships in a hierarchy for a time range. 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.
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.
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/v1/codelists/<code list ID>/codevalues/hierarchy/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/v1/codelists/<code list ID>/codevalues/hierarchy/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.
The following table lists the query parameters:
Parameter
Description
from
Start date and time of the time range. The start point is inclusive. Time range must be in the 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. The end point is exclusive. Time range must be in the 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 value relationships for the specified time range.
The following table describes the attributes in the response:
Field
Type
Description
page
Number
Page number displayed.
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
Included in the content object.
Update date of the last modification.
parentCode
String
Included in the content object.
Code value of the parent node.
childCode
String
Included in the content object.
Code value of the child node.
GET example
To retrieve the first page of modified code values relationships for a time range, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/codelists/123456/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 modified code value relationships:
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: 261
•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 the code value was moved in the draft. This means that the moved code value in draft code list might meet the specified time range criteria now.
Get modified code lists by time range
Retrieve the modified code lists for a time range. 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, submit a GET request with the following URI:
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. The start point is inclusive. Time range must be in the 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. The end point is exclusive. Time range must be in the 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:
Field
Type
Description
page
Number
Page number displayed.
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.
GET example
To retrieve the first page of modified code lists for a time range, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/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