Reference 360 > Reference 360 REST API > crosswalks v2
  

crosswalks v2

Use this resource to retrieve the details of a crosswalk, such as the properties, status, source code list, and target code list based on identifiers, such as internal ID or alias. You can also retrieve the value mappings for a code value.

Unlock a crosswalk (v2)

Unlocks a crosswalk that's locked by another user based on an internal ID or alias.
Note: To use the API, you require the Informatica Intelligent Cloud Services Reference 360 Administrator role.

PUT request

To unlock a crosswalk based on an internal ID or alias, submit a PUT request with the following URI:
/rdm-service/external/v2/crosswalks/{crosswalkKey}/unlock

PUT request query parameters

The following table describes the parameter in the request:
Parameter
Type
Description
crosswalkKey
String
Internal ID or alias of a crosswalk that you want to unlock.

PUT response

A 202 accepted response is returned.

PUT example

To unlock a crosswalk 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/crosswalks/sap_country_to_iso_country/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 crosswalk details (v2)

Retrieves the details of a crosswalk based on an internal ID or alias.

GET request

To retrieve the details of a crosswalk based on an internal ID or alias, submit a GET request with the following URI:
/rdm-service/external/v1/crosswalks/<crosswalkKey>

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.

GET response

The response contains the details of a crosswalk.
The following table describes the attributes in the response body:
Field
Type
Description
id
String
ID of the crosswalk. For more information, see Asset IDs.
internalId
String
Unique identifier of the crosswalk.
alias
String
Alternative identifier of the crosswalk.
sourceCodeListDetails
Object
Includes the details of the source code list.
sourceCodelistId
String
ID of the source code list to which the crosswalk is associated.
internalId
String
Unique identifier of the source code list.
alias
String
Alternative identifier of the target code list.
targetCodeListDetails
Object
Includes the details of the target code list.
targetCodelistId
String
ID of the target code list to which the crosswalk is associated.
internalId
String
Unique identifier of the target code list.
alias
String
Alternative identifier of the target code list.
description
String
Optional. Description of asset.
status
String
Optional. Status of the asset.
confidentiality
String
Optional. Confidentiality of the asset.
sourceApplication
String
Optional. Application of the source code list.
targetApplication
String
Optional. Application of the target code list.
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.

GET example

To retrieve the details of a crosswalk 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/crosswalks/sap_country_to_iso_country HTTP/1.1
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX
The following sample response shows the details of a crosswalk:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 300

{
"id": "67900c57587a205cc9e92834",
"internalId": "sap_country_to_epm_country",
"alias": "sapcountry_to_epmcountry",
"sourceCodeListDetails": {
"id": "67900c53587a205cc9e92820",
"internalId": "sap_country",
"alias": "sapcountry"
},
"targetCodeListDetails": {
"id": "c9abd8c8abe43ad653c3ecd4",
"internalId": "epm_country",
"alias": "epmcountry"
},
"approvedOn": "2017-03-01",
"confidentiality": "private",
"description": "Sample Crosswalk",
"effectiveDate": "2007-04-01",
"status": "active"
}

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.
action
String
Action to perform on code values.
page
Integer
Optional. Page number to display. Default is 0.
pageSize
Integer
Optional. The number of records to display in 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:
Attribute
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.
mappings
Array
Includes the values in the Code attribute of the target code values.
Code
String
Value in the Code attribute of the source code value.
targetCode
String
Value in the Code attribute of the target code value.

GET example

To retrieve the value mappings for the code value, you might use the following request:
GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/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 duplicate mappings of a crosswalk (v2)

The delete request runs a crosswalk cleanser job that scans all mappings of a crosswalk and removes the duplicate mappings based on an internal ID or alias.

DELETE request

To delete duplicate mappings of a crosswalk based on an internal ID or alias, submit a DELETE request with the following URI:
/rdm-service/external/v2/crosswalks/{crosswalkKey}/mappings/duplicates
Note: You must execute this API to run the crosswalk cleanser job only if you find duplicate crosswalk mappings in the exported CSV file. The CSV file must be exported using export v3 API at a point in time.

DELETE response

A 202 accepted response is returned.

DELETE example

To delete duplicate mappings of a crosswalk based on the internal ID or alias, you might use the following request:
DELETE https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/crosswalks/sap_country_to_iso_country/mappings/duplicates HTTP/1.1
Content-Type: application/json
The following sample response shows the accepted response:
HTTP/1.1 202 Accepted

Get job details of a crosswalk cleanser job (v2)

Retrieves job details of a crosswalk cleanser job based on an internal ID or alias.

GET request

To get the job details of a crosswalk cleanser job based on an internal ID or alias, submit a GET request with the following URI:
/rdm-service/external/v2/crosswalks/{crosswalkKey}/mappings/duplicates/status

GET response

The response contains the details of the crosswalk cleanser job, such as the status of the crosswalk cleanser job, number of records processed for import, and the error details.
The following table describes the attributes in the response body:
Field
Type
Description
id
String
Identifier of the crosswalk for which the crosswalk cleanser job was triggered.
internalId
String
Unique identifier of the crosswalk.
alias
String
Alternative identifier of the crosswalk.
createdBy
String
User name of the user who triggered the crosswalk cleanser job.
createdDate
String
Date when the crosswalk cleanser job was triggered.
status
String
Status of the crosswalk cleanser job.
jobDetails
Object
Details of the crosswalk cleanser job.
initialNumberOfMappings
Number
Number of existing crosswalk mappings.
invalidSourcePKeyReport
Object
Details of invalid mappings.
numberOfRecords
Number
Number of invalid records.
numberOfSuccessRecords
Number
Number of invalid records that were successfully deleted.
numberOfFailedRecords
Number
Number of invalid records that were not deleted.
errors
Array
Details of the errors.
errorCode
String
Error code for the error type.
errorSummary
String
Message that explains why the invalid records are not deleted.
errorParameter
Object
Error parameter.

GET example

To get the job details of a crosswalk cleanser job 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/crosswalks/sap_country_to_epm_country/mappings/duplicates/status HTTP/1.1
Accept: application/json
The following sample response shows the job details of a crosswalk cleanser job:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 555

{
"id": "572daed0d1a98447ff6e557d",
"internalId": "sap_country_to_epm_country",
"alias": "sapcountry_to_epmcountry",
"createdBy": "5b9d4944f0f0b880eec4068a",
"createdDate": "2023-09-01T08:15:55.000+00:00",
"status": "RUNNING",
"jobDetails": {
"initialNumberOfMappings": 10,
"invalidSourcePKeyReport": {
"numberOfRecords": 5,
"numberOfSuccessRecords": 4,
"numberOfFailedRecords": 1
}
},
"errors": [
{
"errorCode": "RDM.0010000",
"errorSummary": "Unable to fix the sourcePkey",
"errorParameter": {
"sourcePkey": "619cd13b57eb9948fa585d65"
}
}
]
}

Known limitation

If the crosswalk cleanser job fails to remove duplicate mappings of a crosswalk, the API response returns the RDM.0010269 error code.
To avoid duplicate mappings in the crosswalk when the crosswalk cleanser job fails, perform the following actions:
  1. 1In Reference 360, open the specific crosswalk.
  2. 2Click Export mappings to export the value mappings of the crosswalk.
  3. 3Delete the crosswalk.
  4. 4Create another crosswalk between the same source and target code lists.
  5. 5Open the crosswalk and click Import Mappings to import the exported CSV file to the crosswalk.