Reference 360

Back Next

Get crosswalks for a code list

Retrieves the crosswalks associated to a code list and the summary information for each crosswalk.

GET request

To retrieve all crosswalks associated to a code list, submit a GET request with the following URI:

/rdm-service/external/v1/codelists/<code list ID>/crosswalks

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 crosswalks associated to the 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.
sourceCodelistId	String	ID of the source code list to which the crosswalk is associated.
targetCodelistId	String	ID 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. Username of the user who approved the asset.
approvedOn	String	Optional. Date the asset was approved.

GET example

To retrieve the crosswalks associated to a code list, you might use the following request:

GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/codelists/eff26036111cbb1e9c03f21f/crosswalks HTTP/1.1
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

The following sample response shows the crosswalks associated to a code list:

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 514

[ 
  { 
    "id":"242a0d14fc1149843cf00626",
    "description":"Sample Crosswalk 1",
    "status":"active",
    "sourceCodelistId":"eff26036111cbb1e9c03f21f",
    "targetCodelistId":"6253315d698f95a216e15a5e"
  },
  { 
    "id":"cd11cae0400cf0eaaedfd711",
    "description":"Sample Crosswalk 2",
    "status":"inactive",
    "sourceCodelistId":"eff26036111cbb1e9c03f21f",
    "targetCodelistId":"1bf325b44008a5ba4034c23c",
    "confidentiality":"private",
    "effectiveDate":"2007-04-01",
    "approvedOn":"2017-03-01"
  }
]

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Get crosswalks for a code list

Get crosswalks for a code list

GET request

GET response

GET example