Reference 360 > Reference 360 REST API > rds
  

rds

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.

Get reference data sets

Retrieves all the reference data sets.

GET request

To retrieve all the reference data sets, submit a GET request with the following URI:
/rdm-service/external/v1/rds

GET response

The response contains information about each reference data sets.
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.
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.
displayColumns
String
Optional. List of display columns used as labels for code values. Default is name.

GET example

To retrieve all the reference data sets, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/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":"15d106a7905bd02a580d2b8d",
"name":"Country",
"description":"A Business Term named Country",
"hierarchical":false,
"levels":1,
"displayColumns":[
"Name"
]
},
{
"id":"655df89e349a7fc1c0cd5f33",
"name":"Currency",
"hierarchical":false,
"levels":1,
"domain":"International standards",
"confidentiality":"private",
"priority":"Prio1",
"status":"Draft",
"effectiveDate":"2017-04-01",
"approvedOn":"2017-03-01",
"displayColumns":[
"Name"
]
}
]

Get reference data set details

Retrieves the details of a reference data set, such as the properties, status, structure definition, and attributes.

GET request

To retrieve the details of a reference data set, submit a GET request with the following URI:
/rdm-service/external/v1/rds/<reference data set 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 summary information and definition of the reference data set.
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.
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 reference data set, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/rds/15d106a7905bd02a580d2b8d HTTP/1.1
Accept: 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: 1265

{
"id":"15d106a7905bd02a580d2b8d",
"name":"Country",
"description":"A Business Term named Country",
"hierarchical":false,
"levels":1,
"defaultList":"fa2a7f11fea1fc38db8d29aa",
"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
},
{
"name":"Code",
"origin":"TERM",
"datatype":"String",
"mandatory":true
},
{
"name":"Description",
"origin":"TERM",
"datatype":"String",
"mandatory":false
},
{
"name":"Alpha2Code",
"origin":"TERM",
"datatype":"String",
"mandatory":true
},
{
"name":"Alpha3Code",
"origin":"TERM",
"datatype":"String",
"mandatory":false
},
{
"name":"RefField",
"origin":"TERM",
"datatype":"Reference",
"mandatory":true,
"relatedTermId":"655df89e349a7fc1c0cd5f33",
"displayColumns":[
"column1",
"column2"
]
}
],
"dependencyDef":{
"termId":"Continent",
"displayColumns":[
"Name"
]
}
}

Get history of a reference data set by time range

Retrieves all the change events of a reference data set for a specific time range.

GET request

To retrieve all the change events of a reference data set for a specific time range, submit a GET request with the following URI:
/rdm-service/external/v1/rds/<reference data set 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 reference data set 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 reference data set.
modificationType
String
The type of change made to the reference data set.
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 reference data set 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 reference data set for a specific time range, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/rds/2cf464206292908e67c9f719/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",
"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",
"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",
"assetType":"REFERENCEDATASET"
},
"modificationType":"UPDATE",
"eventTime":"2023-03-07T09:15:28Z",
"userName":"integration-test-admin"
},
{
"asset":{
"id":"6407004f6b19964cc917c7bf",
"name":"Countary",
"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",
"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",
"assetType":"REFERENCEDATASET"
},
"modificationType":"UPDATE",
"eventTime":"2023-03-07T09:13:55Z",
"userName":"mdm-rdm-service"
},
{
"asset":{
"id":"6407004f6b19964cc917c7bf",
"name":"Countary",
"assetType":"REFERENCEDATASET"
},
"modificationType":"UPDATE",
"eventTime":"2023-03-07T09:13:54Z",
"userName":"integration-test-admin"
},
{
"asset":{
"id":"6407004f6b19964cc917c7bf",
"name":"Countary",
"assetType":"REFERENCEDATASET"
},
"modificationType":"UPDATE",
"fieldChanges":{
"defaultList":{
"newValue":"6407004f5b243e32c4b02bb8"
}
},
"eventTime":"2023-03-07T09:13:54Z",
"userName":"integration-test-admin"
},
{
"asset":{
"id":"6407004f6b19964cc917c7bf",
"name":"Countary",
"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

Retrieves all the code lists in a reference data set.

GET request

To retrieve all the code lists in a reference data set, submit a GET request with the following URI:
/rdm-service/external/v1/rds/<reference data set ID>/codelists
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 information about the code lists in the specified reference data set.
The following table describes the attributes in the response:
Field
Type
Definition
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.
displayColumns
String
Optional. List of display columns used as labels for code values. Default is name.
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. Username of the user who approved the asset.
approvedOn
String
Optional. Date the asset was approved.

GET example

To retrieve all the code lists in a reference data set, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/rds/15d106a7905bd02a580d2b8d/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":"863efc094436e68bc4299204",
"termId":"c0af1cd77e7a1a3d658883ad",
"name":"Units",
"description":"Code list for units",
"version":"2.0",
"application":"UN recommendation 20",
"hierarchical":false,
"levels":1,
"displayColumns":[
"Name"
]
},
{
"id":"17f60eb76ebcc75fec93dadc",
"termId":"c0af1cd77e7a1a3d658883ad",
"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"
]
}
]