Reference 360

Back Next

Get modified code value relationships in hierarchy by time range (v2)

Retrieves code value relationships in a hierarchy that were created or updated during the specified period based on the internal ID or alias. 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 for code lists with internal IDs or aliases.

By default, the request returns the first 100 code values. To retrieve more code values or to view the next page of code values, 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/v2/codelists/{codeListKey}/codevalues/hierarchy/modifications?from=<from>&to=<to>[&pageSize=<page size>&page=<page number>
]

The following table lists the query parameters in the URI:

Parameter	Type	Description
codeListKey	String	Internal ID or alias of the code list from which you are retrieving the code values.
from	String	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	String	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	Integer	Optional. Page number to display. Default is 0 .
pageSize	Integer	Optional. Number of records to display per page. Default value is 100 . Maximum value is 10000 .

GET response

The response contains data about the created or updated code value relationships for the specified time range.

The following table describes the attributes in the response body:

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 code values relationships that were created or updated during a specific time period based on its internal ID

country

, you might use the following request:

GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/codelists/country/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 code value relationships that were created or updated during a specific time period:

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

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

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 on which the code value was moved in the draft code list. The moved code value in draft code list might now meet the specified time range criteria.

codelists version 2

Download Guide

Watch

Comments

Reference 360 Homepage

Communities

Knowledge Base

Success Portal