Reference 360 > Reference 360 REST API > crosswalk v3
  

crosswalk v3

Use this resource to retrieve the value mappings for a code value based on identifiers, such as internal ID or alias.

Get history of a crosswalk by time range (v3)

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

GET request

To retrieve all the change events of a crosswalk for a specific time range based on an internal ID or alias, submit a GET request with the following URI:
/rdm-service/external/v3/crosswalks/{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 a crosswalk.
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 crosswalk for a specific time range.
The following table describes the attributes in the response body:
Attributes
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.
id
String
ID of the crosswalk. For more information, see Asset IDs.
name
String
Name of the crosswalk.
internalId
String
Unique identifier of the crosswalk.
alias
String
Alternative identifier of the crosswalk.
assetType
String
Optional. Type of asset. Set the value to REFERENCEDATASET, CODELIST, CROSSWALK, or HIERARCHY.
asset
Object
Includes details about the crosswalk.
modificationType
String
Type of change made to the crosswalk. Value can be CREATE, UPDATE, or DELETE.
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
Date and time when the crosswalk was last modified.
userName
String
User name of the user who initiated the modification.

GET example

To retrieve all the change events of a crosswalk 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/v3/crosswalks/cl_audit/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 crosswalk 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: 1247

{
"pageSize": 100,
"page": 0,
"numberOfElements": 4,
"lastPage": true,
"firstPage": true,
"content": [
{
"asset": {
"id": "63eb866c3eceda5c401e22bb",
"name": "ZIT_16763797384291632_4196_ExternalCodeListAuditTrailTest_IntTestCodelist1_1",
"internalId": "cl_audit",
"alias": "als_cl_audit",
"assetType": "CODELIST"
},
"modificationType": "UPDATE",
"eventTime": "2023-02-14T13:02:48Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "63eb866c3eceda5c401e22bb",
"name": "ZIT_16763797384291632_4196_ExternalCodeListAuditTrailTest_IntTestCodelist1_1",
"internalId": "cl_audit",
"alias": "als_cl_audit",
"assetType": "CODELIST"
},
"modificationType": "UPDATE",
"fieldChanges": {
"description": {
"previousValue": "description 1",
"newValue": "description 2"
},
"version": {
"previousValue": "version 1",
"newValue": "version 2"
}
},
"attributeChanges": {
"ReferenceAttribute": {
"displayAttributes": {
"previousValue": [
"Name",
"Code"
],
"newValue": [
"Code"
]
}
}
},
"eventTime": "2023-02-14T13:02:46Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "63eb866c3eceda5c401e22bb",
"name": "ZIT_16763797384291632_4196_ExternalCodeListAuditTrailTest_IntTestCodelist1_1",
"internalId": "cl_audit",
"alias": "als_cl_audit",
"assetType": "CODELIST"
},
"modificationType": "UPDATE",
"eventTime": "2023-02-14T13:02:40Z",
"userName": "integration-test-admin"
},
{
"asset": {
"id": "63eb866c3eceda5c401e22bb",
"name": "ZIT_16763797384291632_4196_ExternalCodeListAuditTrailTest_IntTestCodelist1_1",
"internalId": "cl_audit",
"alias": "als_cl_audit",
"assetType": "CODELIST"
},
"modificationType": "CREATE",
"fieldChanges": {
"description": {
"newValue": "description 1"
},
"displayColumns": {
"newValue": [
"Name"
]
},
"hierarchical": {
"newValue": "true"
},
"levels": {
"newValue": "6"
},
"name": {
"newValue": "ZIT_16763797384291632_4196_ExternalCodeListAuditTrailTest_IntTestCodelist1_1"
},
"termId": {
"newValue": "63eb865cf663af1d2a7ef268"
},
"version": {
"newValue": "version 1"
}
},
"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"
}
},
"ReferenceAttribute": {
"name": {
"newValue": "referenceAttribute"
},
"type": {
"newValue": "Reference"
},
"required": {
"newValue": "false"
},
"displayAttributes": {
"newValue": [
"Name",
"Code"
]
},
"referenceDataSetId": {
"newValue": "63ffb73ba7fc2c03f6273205"
},
"codeListId": {
"newValue": "63ffb73d87e60e6fcd814fbd"
}
}
},
"dependencyChanges": {
"displayAttributes": {
"newValue": [
"Name",
"Code"
]
},
"referenceDataSetId": {
"newValue": "63ffc0e0a7fc2c03f627323c"
},
"codeListId": {
"newValue": "63ffc0e287e60e6fcd815026"
}
},
"eventTime": "2023-02-14T13:02:35Z",
"userName": "integration-test-admin"
}
]
}

Get value mappings for a code value (v3)

Retrieve the value mappings for a code value based on an internal ID or alias.
You identify the code value that you want to retrieve value mappings 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 value mappings for a code value based on an internal ID or alias, submit a GET request with the following URI and specify the code:
/rdm-service/external/v3/crosswalks/{crosswalkKey}/mappings?Code={code}

GET request query parameters

The following table describes the parameter in the request:
Parameter
Type
Description
crosswalkKey
String
Internal ID or alias of a crosswalk.
page
Number
Optional. Page number to display. Default is 0.
pageSize
Number
Optional. The number of records to display on each page. Default is 100. Maximum is 10000.
Code
String
Value in the Code attribute of the source code value.

GET response

The response contains the value mappings for the code value.
The following table describes the attributes in the response body:
Field
Type
Description
pageSize
Number
Number of records displayed per page.
page
Number
Page from which the response was retrieved.
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.
mappings
Array
Includes the values in the Code attribute of the target code values.
Code
String
Source code value of a crosswalk mapping.
targetCode
String
Target code value of a crosswalk mapping.

GET example

To retrieve the value mappings for the code value based on the internal ID or alias, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v3/crosswalks/sapcountry_to_isocountry/mappings?Code=DE HTTP/1.1
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
The following sample response shows value mappings:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 92

{
"pageSize": 100,
"page": 0,
"totalNumberOfElements": 5,
"numberOfElements": 5,
"lastPage": true,
"firstPage": true,
"mappings": [
{
"Code": "code1",
"targetCode": "targetCode1"
},
{
"Code": "code2",
"targetCode": "targetCode2"
},
{
"Code": "code3",
"targetCode": "targetCode3"
},
{
"Code": "code4",
"targetCode": "targetCode4"
},
{
"Code": "code5",
"targetCode": "targetCode5"
}
]
}

Delete value mappings of a crosswalk by mapped source and target code values (v3)

Delete value mappings of a crosswalk by mapped source and target code values based on an internal ID or alias.

POST request

To delete value mappings of a crosswalk by mapped source and target code values based on an internal ID or alias, submit a POST request with the following URI:
/rdm-service/external/v3/crosswalks/{crosswalkKey}/mappings
Use the following parameters in the request body to specify the value mappings of a crosswalk to delete:
Field
Type
Description
crosswalkKey
String
Internal ID or alias of a crosswalk.
action
String
Action to perform.
mappings
Array
List of mappings for the specified crosswalk.
Code
String
Source code value of a crosswalk mapping.
targetCode
String
Target code value of a crosswalk mapping.

POST response

A 204 no content response is returned.

POST example

To delete value mappings of a crosswalk by mapped source and target code values based on the internal ID or alias, you might use the following request:
POST https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v3/crosswalks/sapcountry_to_isocountry/mappings HTTP/1.1
Content-Type: application/json
Content-Length: 384

{
"action":"DELETE",
"mappings":[
{
"Code":"sourceCode1",
"targetCode":"targetCode1"
},
{
"Code":"sourceCode2",
"targetCode":"targetCode2"
},
{
"Code":"sourceCode3",
"targetCode":"targetCode3"
},
{
"Code":"sourceCode4",
"targetCode":"targetCode4"
},
{
"Code":"sourceCode5",
"targetCode":"targetCode5"
}
]
}
The following sample response shows the no content response:
HTTP/1.1 204 No Content