Reference 360

Back Next

Get latest modified code values by time range

Retrieves the latest modified code values in a code list for a time range.

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. You can retrieve a maximum of 10000 records in a request.

GET request

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

/rdm-service/external/v1/codelists/<code list ID>/codevalues/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/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 details about the latest modified code values.

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.
status	String	Included in the content object. Optional. Status of the code value.
effectiveDate	String	Included in the content object. Optional. Date code value becomes effective.
codeValueFields	Object	Included in the content object. Contains the field values for the code value.
lastUpdateDate	String	Included in the content object. Update date of the last modification.
changeType	Object	Included in the content object. Type of change made to the code value. Values are MODIFIED or DELETED . The MODIFIED change type appears for both new and updated code values.

GET example

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

GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/codelists/ce63c85efb9791eb49c4baa3/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 the latest modified code values:

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

{ 
  "pageSize":100,
  "page":0,
  "totalNumberOfElements":1000,
  "numberOfElements":1,
  "lastPage":false,
  "firstPage":true,
  "content":[ 
    { 
      "status":"Draft",
      "dependency":"f9b48b61fbeb3b491a69bd44",
      "lastUpdateDate":"2019-12-11T13:29:55Z",
      "changeType":"MODIFIED",
      "effectiveDate":"2017-04-01",
      "codeValueFields":{ 
        "field1":"Some value"
      }
    }
  ]
}

Known limitations

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

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Get latest modified code values by time range

Get latest modified code values by time range

GET request

GET request query parameters

GET response

GET example

Known limitations