Reference 360 > Reference 360 REST API > rds (v2)
  

rds (v2)

Use this resource to list all reference data sets, get the details for a reference data set, and list code lists in a reference data set based on an internal ID or alias.

Get reference data sets (v2)

Retrieves all the reference data sets based on an internal ID or alias.

GET request

To retrieve all the reference data sets based on an internal ID or alias, submit a GET request with the following URI:
/rdm-service/external/v2/rds

GET response

The response contains information about each reference data sets.
The following table describes the attributes in the response body:
Field
Type
Description
id
String
ID of the reference data set. For more information, see Asset IDs.
name
String
Name of the reference data set.
description
String
Optional. Description of reference data set.
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.
internalId
String
Unique identifier of the reference data set.
alias
String
Alternative identifier of the reference data set.
defaultListDetails
Object
Includes details of the default code list for the reference data set.
id
String
ID of the default code list.
internalId
String
Unique identifier of the default code list for the reference data set.
alias
String
Alternative identifier of the default code list for the reference data set.
domain
String
Optional. Domain of the reference data set.
confidentiality
String
Optional. Confidentiality of the reference data set.
priority
String
Optional. Priority of the reference data set.
status
String
Optional. Status of the reference data set.
effectiveDate
String
Optional. Date the reference data set became effective.
approvedById
String
Optional. ID of the approver of the reference data set.
approvedByName
String
Optional. Username of the user who approved the reference data set.
approvedOn
String
Optional. Date the reference data set was approved.
displayColumns
Array
Optional. List of display columns used as labels for code values. Default is name.

GET example

To retrieve all the reference data sets 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/rds HTTP/1.1
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
The following sample response shows the reference data sets:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 514

[
{
"id": "fba77ab1fdb64d78fc52efb1",
"name": "Country",
"description": "A Business Term named Country",
"hierarchical": false,
"levels": 1,
"internalId": "rds_units",
"alias": "units_rds",
"defaultListDetails": {
"id": "045e33bb684b4fcfa58c4e06",
"internalId": "iso_units",
"alias": "isounits"
},
"displayColumns": [
"Name"
]
},
{
"id":"655df89e349a7fc1c0cd5f33",
"name":"Currency",
"hierarchical":false,
"levels":1,
"internalId": "rds_currency",
"alias": "currency_rds",
"domain":"International standards",
"confidentiality":"private",
"priority":"Prio1",
"status":"Draft",
"effectiveDate":"2017-04-01",
"approvedOn":"2017-03-01",
"displayColumns":[
"Name"
]
}
]

Get reference data set details (v2)

Retrieves the details of a reference data set, such as the properties, status, structure definition, and attributes. You can retrieve the details of a reference data set based on an internal ID or alias.

GET request

To retrieve the details of a reference data set based on an internal ID or alias, submit a GET request with the following URI:
/rdm-service/external/v2/rds/<rdsKey>

GET request query parameter

The following table describes the query parameter:
Parameter
Description
rdsKey
Internal ID or alias of the reference data set.

GET response

The response contains the summary information and definition of the reference data set.
The following table describes the attributes in the response body:
Field
Type
Description
id
String
ID of the reference data set. For more information, see Asset IDs.
name
String
Name of the reference data set.
description
String
Optional. Description of reference data set.
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.
internalId
String
Unique identifier of the reference data set.
alias
String
Alternative identifier of the reference data set.
defaultListDetails
Object
Includes details of the default code list for the reference data set.
id
String
ID of the default code list for the reference data set. For more information, see Asset IDs.
internalId
String
Unique identifier of the default code list for the reference data set.
alias
String
Alternative identifier of the default code list for the reference data set.
domain
String
Optional. Domain of the reference data set.
confidentiality
String
Optional. Confidentiality of the reference data set.
priority
String
Optional. Priority of the reference data set.
status
String
Optional. Status of the reference data set.
effectiveDate
String
Optional. Date the reference data set became effective.
approvedById
String
Optional. ID of the approver of the reference data set.
approvedByName
String
Optional. Username of the user who approved the reference data set.
approvedOn
String
Optional. Date the reference data set was approved.
displayColumns
String
Optional. List of display columns used as labels for code values. Default is name.
codeValueFields
Object
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
Object
Optional. Includes the definition of the asset specified as the dependency.
rdsDetails
Object
Includes details for the 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.
displayColumns
Array
Optional. Display columns used as labels for code values associated with the dependent asset.

GET example

To retrieve the details of a reference data set 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/rds/rds_units HTTP/1.1Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
The following sample response shows the details of a reference data set:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 2752
{
"id": "fba77ab1fdb64d78fc52efb1",
"name": "Country",
"description": "A Business Term named Country",
"hierarchical": false,
"levels": 1,
"internalId": "rds_units",
"alias": "units_rds",
"defaultListDetails": {
"id": "045e33bb684b4fcfa58c4e06",
"internalId": "iso_units",
"alias": "isounits"
},
"domain": "International standards",
"confidentiality": "private",
"priority": "Prio1",
"status": "Draft",
"effectiveDate": "2017-04-01",
"approvedOn": "2017-03-01",
"displayColumns": [
"Name"
],
"codeValueFields": [
{
"name": "Name",
"origin": "TERM",
"datatype": "String",
"mandatory": true,
"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": "Alpha2Code",
"origin": "TERM",
"datatype": "String",
"mandatory": true,
"labels": [
{
"language": "en",
"value": "Alpha2Code"
}
]
},
{
"name": "Alpha3Code",
"origin": "TERM",
"datatype": "String",
"mandatory": false,
"labels": [
{
"language": "en",
"value": "Alpha3Code"
}
]
},
{
"name": "RefField",
"origin": "TERM",
"datatype": "Reference",
"mandatory": true,
"relatedRdsDetails": {
"id": "93d5f260efa741436ba60591",
"internalId": "testexternalrdsv2_2",
"alias": "testexternalrds_2"
},
"displayColumns": [
"column1",
"column2"
],
"labels": [
{
"language": "en",
"value": "RefField"
}
]
}
],
"dependencyDef": {
"rdsDetails": {
"id": "Continent",
"internalId": "testexternalrdsv2",
"alias": "testexternalrds_1"
},
"displayColumns": [
"Name"
]
}
}

Get history of a reference data set by time range (v2)

Retrieves all the change events of a reference data set for a specific time range based on an internal ID or alias.

GET request

To retrieve all the change events of a reference data set for a specific time range based on an internal ID or alias, submit a GET request with the following URI:
/rdm-service/external/v2/rds/{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 query parameters:
Parameter
Description
assetKey
Internal ID or alias of the reference data set.
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 reference data set for a specific time range.
The following table describes the attributes in the response body:
Attribute
Type
Description
pageSize
Number
The number of records displayed on each page.
page
Number
Page number displayed.
numberOfElements
Number
Total number of reference data sets found.
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 reference data set.
id
String
ID of the reference data set.
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.
assetType
String
Type of reference data asset.
modificationType
String
The type of change made to the reference data set. Value can be CREATE, UPDATE, or DELETE.
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
Date and time when the reference data set was last updated.
userName
String
User name of the user who initiated the modification.

GET example

To retrieve all the change events of a reference data set 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/rds/country/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 reference data set 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: 4803
{
"pageSize": 100,
"page": 0,
"numberOfElements": 9,
"lastPage": true,
"firstPage": true,
"content": [
{
"asset": {
"id": "6407004f6b19964cc917c7bf",
"name": "Country",
"internalId": "country",
"alias": "als_country",
"assetType": "REFERENCEDATASET"
},
"modificationType": "UPDATE",
"fieldChanges": {
"confidentiality": {
"newValue": {
"key": "PublicKey",
"label": "Public"
}
},
"domain": {
"newValue": {
"key": "GeographyKey",
"label": "Geography"
}
},
"effectiveDate": {
"newValue": "2023-03-05"
},
"priority": {
"newValue": {
"key": "Priority3",
"label": "Medium"
}
},
"status": {
"newValue": {
"key": "ActiveKey",
"label": "Active"
}
}
},
"eventTime": "2023-03-07T09:28:08Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "6407004f6b19964cc917c7bf",
"name": "Country",
"internalId": "country",
"alias": "als_country",
"assetType": "REFERENCEDATASET"
},
"modificationType": "UPDATE",
"fieldChanges": {
"name": {
"previousValue": "Countary",
"newValue": "Country"
}
},
"eventTime": "2023-03-07T09:17:46Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "6407004f6b19964cc917c7bf",
"name": "Countary",
"internalId": "country",
"alias": "als_country",
"assetType": "REFERENCEDATASET"
},
"modificationType": "UPDATE",
"eventTime": "2023-03-07T09:15:28Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "6407004f6b19964cc917c7bf",
"name": "Countary",
"internalId": "country",
"alias": "als_country",
"assetType": "REFERENCEDATASET"
},
"modificationType": "UPDATE",
"attributeChanges": {
"Alpha3Code": {
"name": {
"newValue": "Alpha3Code"
},
"type": {
"newValue": "String"
},
"required": {
"newValue": "false"
}
}
},
"eventTime": "2023-03-07T09:14:47Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "6407004f6b19964cc917c7bf",
"name": "Countary",
"internalId": "country",
"alias": "als_country",
"assetType": "REFERENCEDATASET"
},
"modificationType": "UPDATE",
"attributeChanges": {
"Alpha2Code": {
"name": {
"newValue": "Alpha2Code"
},
"type": {
"newValue": "String"
},
"required": {
"newValue": "false"
}
}
},
"eventTime": "2023-03-07T09:14:37Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "6407004f6b19964cc917c7bf",
"name": "Countary",
"internalId": "country",
"alias": "als_country",
"assetType": "REFERENCEDATASET"
},
"modificationType": "UPDATE",
"eventTime": "2023-03-07T09:13:55Z",
"userName": "mdm-rdm-service"
},
{
"asset": {
"id": "6407004f6b19964cc917c7bf",
"name": "Countary",
"internalId": "country",
"alias": "als_country",
"assetType": "REFERENCEDATASET"
},
"modificationType": "UPDATE",
"eventTime": "2023-03-07T09:13:54Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "6407004f6b19964cc917c7bf",
"name": "Countary",
"internalId": "country",
"alias": "als_country",
"assetType": "REFERENCEDATASET"
},
"modificationType": "UPDATE",
"fieldChanges": {
"defaultList": {
"newValue": "6407004f5b243e32c4b02bb8"
}
},
"eventTime": "2023-03-07T09:13:54Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "6407004f6b19964cc917c7bf",
"name": "Countary",
"internalId": "country",
"alias": "als_country",
"assetType": "REFERENCEDATASET"
},
"modificationType": "CREATE",
"fieldChanges": {
"description": {
"newValue": "A Business Term named Country"
},
"displayColumns": {
"newValue": [
"Name"
]
},
"hierarchical": {
"newValue": "false"
},
"levels": {
"newValue": "1"
},
"name": {
"newValue": "Countary"
}
},
"attributeChanges": {
"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:13:51Z",
"userName": "integration-test-admin"
}
]
}

Get code lists (v2)

Retrieves all the code lists in a reference data set based on an internal ID or alias.

GET request

To retrieve all the code lists in a reference data set based on an internal ID or alias, submit a GET request with the following URI:
/rdm-service/external/v2/rds/<rdsKey>/codelists

GET request query parameter

The following table describes the query parameter:
Parameter
Description
rdsKey
Internal ID or alias of the reference data set.

GET response

The response contains information about the code lists in the specified reference data set.
The following table describes the attributes in the response body:
id
String
ID of the code lists in a reference data set. For more information, see Asset IDs.
rdsDetails
Object
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 reference data set.
name
String
Name of the code list.
description
String
Optional. Description of asset.
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 code list in the reference data set.
confidentiality
String
Optional. Confidentiality of the code list in the reference data set.
priority
String
Optional. Priority of the code list in the reference data set.
status
String
Optional. Status of the code list in the reference data set.
effectiveDate
String
Optional. Date the code list in the reference data set became effective.
approvedById
String
Optional. ID of the approver of the code list in the reference data set.
approvedByName
String
Optional. User name of the user who approved the code list in the reference data set.
approvedOn
String
Optional. Date the code list in the reference data set was approved.
displayColumns
String
Optional. List of display columns used as labels for code values. Default is name.
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.
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 all the code lists in a reference data set 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/rds/rds_units/codelists HTTP/1.1
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
The following sample response shows the code lists in a reference data set:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 747
[
{
"id": "e36aebf55a48d54133b9e79a",
"rdsDetails": {
"id": "86845d3822371e96a4dbbcbb",
"internalId": "rds_units",
"alias": "units",
"name": "rds_units"
},
"name": "Units",
"description": "Code list for units",
"version": "2.0",
"application": "UN recommendation 20",
"hierarchical": false,
"levels": 1,
"displayColumns": [
"Name"
]
},
{
"id": "fae288a8796d3664ed7b3ffd",
"rdsDetails": {
"id": "86845d3822371e96a4dbbcbb",
"internalId": "rds_units",
"alias": "units",
"name": "rds_units"
},
"name": "SAP Units",
"description": "Code list for SAP units",
"version": "1.1",
"application": "SAP",
"hierarchical": true,
"levels": 10,
"domain": "International standards",
"confidentiality": "private",
"priority": "Prio1",
"status": "Draft",
"effectiveDate": "2017-04-01",
"approvedOn": "2017-03-01",
"displayColumns": [
"Name",
"Code"
]
}
]