Reference 360

Back Next

Get latest modified code values by time range (v2)

Retrieves the latest modified code values in a code list that were created or updated during the specified period based on the internal ID or alias.

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. You can retrieve a maximum of 10,000 code values in a request.

GET request

To retrieve the code values in a code list that were created or updated during the specified period based on the internal ID or alias, submit a GET request with the following URI:

/rdm-service/external/v2/codelists/{codeListKey}/modifications?from=<from>&to=<to>[&pageSize=<page size>&page=<page number>]

The following table describes the parameter 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 lists.

The following table describes the attributes in the response body:

Field	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.
content	Array	Includes the list of code values.
status	String	Status of the code list.
dependency	String	ID of the code value specified as the dependency.
lastUpdateDate	String	Date when the code value was last updated.
changeType	String	Type of change made to the code list. Values are MODIFIED and DELETED .
effectiveDate	String	Date when the code list became effective.
codeValueFields	Object	Includes the attribute definition for code values.

GET example

To retrieve the first page of code values in a code list 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/modifications?from=2019-12-11T13:29:55Z&to=2019-12-12T13:29:55Z&page=0&pageSize=100 HTTP/1.1
Accept: application/json

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

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 282
{
  "pageSize": 1,
  "page": 0,
  "totalNumberOfElements": 1000,
  "numberOfElements": 1,
  "lastPage": false,
  "firstPage": true,
  "content": [
    {
      "status": "Draft",
      "dependency": "870d2e1b6cd2249aa48dc5db",
      "lastUpdateDate": "2019-12-11T13:29:55Z",
      "changeType": "MODIFIED",
      "effectiveDate": "2017-04-01",
      "codeValueFields": {
        "Name": "NAME-A"
      }
    }
  ]
}

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Get latest modified code values by time range (v2)

Get latest modified code values by time range (v2)

GET request

GET response

GET example