Reference 360

Back Next

Get crosswalks for a code list (v2)

Retrieves the crosswalks associated to a code list and the summary information for each crosswalk based on the internal ID or alias.

GET request

To retrieve all crosswalks associated to a code list based on an internal ID or alias, submit a GET request with the following URI:

/rdm-service/external/v2/codelists/{codeListKey}/crosswalks

GET request query parameters

The following table describes the parameter in the request:

Parameter	Type	Description
codeListKey	String	Internal ID or alias of a code list of the crosswalk.

GET response

The response contains the crosswalks associated to the code list.

The following table describes the attributes in the response body:

Field	Type	Description
id	String	ID of the code list. For more information, see Asset IDs.
internalId	String	Unique identifier of the code list.
description	String	Optional. Description of the code list.
status	String	Optional. Status of the code list.
confidentiality	String	Optional. Confidentiality of the code list.
effectiveDate	String	Optional. Date when the code list became effective.
approvedOn	String	Optional. Date when the code list was approved.
sourceCodeListDetails	Object	Includes details of the source code list to which the crosswalk is associated.
id	String	ID of the source code list to which the crosswalk is associated.
targetCodeListDetails	Object	Includes details of the target code list to which the crosswalk is associated.
id	String	ID of the target code list to which the crosswalk is associated.

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 the crosswalks associated to a code list 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/codelists/internalId/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": "af5dc4d0d7ada6609985ab33",
    "internalId": "internalId",
    "description": "Sample Crosswalk 1",
    "status": "active",
    "sourceCodeListDetails": {
      "id": "85812f48d51aac9513b7df4e"
    },
    "targetCodeListDetails": {
      "id": "3dd16657bab79b6d60eab2ff"
    }
  },
  {
    "id": "3536aeb4364a4afabca8eadd",
    "internalId": "internalId2",
    "description": "Sample Crosswalk 2",
    "status": "inactive",
    "confidentiality": "private",
    "effectiveDate": "2007-04-01",
    "approvedOn": "2017-03-01",
    "sourceCodeListDetails": {
      "id": "85812f48d51aac9513b7df4e"
    },
    "targetCodeListDetails": {
      "id": "c4a1387ef17d161d3a3c2575"
    }
  }
]

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Get crosswalks for a code list (v2)

Get crosswalks for a code list (v2)

GET request

GET request query parameters

GET response

GET example