Reference 360

Back Next

Get modified code value relationships in hierarchy by time range

Retrieve the modified code value relationships in a hierarchy for a time range. Use the API to retrieve changes to code value relationships, such as code values that moved in the hierarchy and code values added under a parent code value.

By default, the request returns the first 100 records. To retrieve more records or to view the next page of records, use the query parameters.

GET request

To retrieve the modified code values in a hierarchical code list for a time range, submit a GET request with the following URI:

/rdm-service/external/v1/codelists/<code list ID>/codevalues/hierarchy/modifications?from=<from>&to=<to>

To specify the page number and page size, submit a GET request with the following query parameters appended to the URI:

/rdm-service/external/v1/codelists/<code list ID>/codevalues/hierarchy/modifications?from=<from>&to=<to>&pageSize=<page size>&page=<page number>

GET request query parameters

You can append query parameters to the URI to specify the time range, page number, and page size.

The following table lists the query parameters:

Parameter	Description
from	Start date and time of the time range. The start point is inclusive. Time range must be in the 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. The end point is exclusive. Time range must be in the 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 .

GET response

The response contains data about the modified code value relationships for the specified time range.

The following table describes the attributes in the response:

Field	Type	Description
page	Number	Page number displayed.
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.
content	Array	Includes the list of code values.
lastUpdateDate	String	Included in the content object. Update date of the last modification.
parentCode	String	Included in the content object. Code value of the parent node.
childCode	String	Included in the content object. Code value of the child node.

GET example

To retrieve the first page of modified code values relationships for a time range, you might use the following request:

GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/codelists/123456/codevalues/hierarchy/modifications?from=2019-12-11T13:29:55Z&to=2019-12-12T13:29:55Z&page=0&pageSize=100 HTTP/1.1
Accept: application/json
Host: localhost:8080

The following sample response shows the first page of modified code value relationships:

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

{ 
  "pageSize":100,
  "page":0,
  "totalNumberOfElements":1000,
  "numberOfElements":1,
  "lastPage":false,
  "firstPage":true,
  "content":[ 
    { 
      "lastUpdateDate":"2019-12-11T13:29:55Z",
      "parentCode":"USA",
      "childCode":"NY"
    }
  ]
}

Known limitations

If the code list is in draft state, some code value relationships might appear in the API response even though the code value relationships have not changed in the specified time range. For example, if you move a code value in a draft code list, the last update date of the code value updates to the date the code value was moved in the draft. This means that the moved code value in draft code list might meet the specified time range criteria now.

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Get modified code value relationships in hierarchy by time range

Get modified code value relationships in hierarchy by time range

GET request

GET request query parameters

GET response

GET example

Known limitations