Reference 360

Back Next

Get history of code value hierarchies by time range (v1)

Retrieves all the change events of code value hierarchies for a specific time range.

GET request

To retrieve all the change events of code value hierarchies for a specific time range, submit a GET request with the following URI:

/rdm-service/external/v1/codelists/<code list ID>/codevalues/hierarchy/audit

GET request query parameters

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

The following table describes the query parameters:

Parameter	Description
from	Start date and time of a time range. The start date and time is inclusive. Set the time range in the ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'. For example, you can set 2023-01-01T00:00:00Z .
to	End date and time of a time range. The end date and time is exclusive. Set the time range in the ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'. For example, you can set 2024-01-01T00:00:00Z .
page	Optional. Page number to display. Default is 0.
pageSize	Optional. The number of records to display on each page. Default is 100. Maximum is 10000.
modificationType	Optional. Type of modification. Value can be CREATE or DELETE.

GET response

The response contains the change events of code value hierarchies for a specific time range.

The following table describes the attributes in the response:

Attribute	Type	Description
pageSize	Number	The number of records displayed on each page.
page	Number	Page number displayed.
numberOfElements	Number	The number of events.
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 modification events.
asset	Object	Includes details about the code values of the code list.
modificationType	String	The type of change made to the code values of the code list.
eventTime	String	The date and time the code values were last updated.
userName	String	The user name of the user who initiated the modification.

GET example

To retrieve all the change events of code value hierarchies for a specific time range, you might use the following request:

GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v1/codelists/c2f9323dbec86b2cfe8a8101/codevalues/hierarchy/audit?from=2023-01-01T00:00:00Z&to=2024-01-01T00:00:00Z HTTP/1.1
Accept: application/json
IDS-SESSION-ID: XXXXXXXXXXXXXXXXXXXXXX

The following sample response shows the change events of the code value hierarchies from 2023-01-01T00:00:00Z to 2024-01-01T00:00:00Z:

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

{
   "pageSize":100,
   "page":0,
   "numberOfElements":6,
   "lastPage":true,
   "firstPage":true,
   "content":[
      {
         "asset":{
            "id":"6407014f5b243e32c4b02ce3",
            "assetType":"CODELIST"
         },
         "codeValueId":"640701e45b243e32c4b02d40",
         "code":"Antarctica",
         "modificationType":"UPDATE",
         "changedAttributes":[
            {
               "attribute":"Description",
               "previousValue":"Numeric Code of Antarctica",
               "newValue":"Numeric Code of Antarctica (ISO 3166-1)"
            }
         ],
         "eventTime":"2023-03-07T09:21:56Z",
         "userName":"integration-test-admin"
      },
      {
         "asset":{
            "id":"6407014f5b243e32c4b02ce3",
            "assetType":"CODELIST"
         },
         "codeValueId":"640701d25b243e32c4b02d35",
         "code":"Albania",
         "modificationType":"UPDATE",
         "changedAttributes":[
            {
               "attribute":"Description",
               "previousValue":"Numeric Code of Albania",
               "newValue":"Numeric Code of Albania (ISO 3166-1)"
            }
         ],
         "eventTime":"2023-03-07T09:21:39Z",
         "userName":"integration-test-admin"
      },
      {
         "asset":{
            "id":"6407014f5b243e32c4b02ce3",
            "assetType":"CODELIST"
         },
         "codeValueId":"640701c35b243e32c4b02d21",
         "code":"Afghanistan",
         "modificationType":"UPDATE",
         "changedAttributes":[
            {
               "attribute":"Description",
               "previousValue":"Numeric Code for Afghanistan",
               "newValue":"Numeric Code for Afghanistan (ISO 3166-1)"
            }
         ],
         "eventTime":"2023-03-07T09:21:19Z",
         "userName":"integration-test-admin"
      },
      {
         "asset":{
            "id":"6407014f5b243e32c4b02ce3",
            "assetType":"CODELIST"
         },
         "codeValueId":"640701c35b243e32c4b02d21",
         "code":"Afghanistan",
         "modificationType":"CREATE",
         "changedAttributes":[
            {
               "attribute":"Code",
               "newValue":"Afghanistan"
            },
            {
               "attribute":"Description",
               "newValue":"Numeric Code for Afghanistan"
            },
            {
               "attribute":"Name",
               "newValue":"Afganistan"
            },
            {
               "attribute":"NumericCode",
               "newValue":"004"
            }
         ],
         "eventTime":"2023-03-07T09:20:43Z",
         "userName":"integration-test-admin"
      },
      {
         "asset":{
            "id":"6407014f5b243e32c4b02ce3",
            "assetType":"CODELIST"
         },
         "codeValueId":"640701d25b243e32c4b02d35",
         "code":"Albania",
         "modificationType":"CREATE",
         "changedAttributes":[
            {
               "attribute":"Code",
               "newValue":"Albania"
            },
            {
               "attribute":"Description",
               "newValue":"Numeric Code of Albania"
            },
            {
               "attribute":"Name",
               "newValue":"Albania"
            },
            {
               "attribute":"NumericCode",
               "newValue":"008"
            }
         ],
         "eventTime":"2023-03-07T09:20:43Z",
         "userName":"integration-test-admin"
      },
      {
         "asset":{
            "id":"6407014f5b243e32c4b02ce3",
            "assetType":"CODELIST"
         },
         "codeValueId":"640701e45b243e32c4b02d40",
         "code":"Antarctica",
         "modificationType":"CREATE",
         "changedAttributes":[
            {
               "attribute":"Code",
               "newValue":"Antarctica"
            },
            {
               "attribute":"Description",
               "newValue":"Numeric Code of Antarctica"
            },
            {
               "attribute":"Name",
               "newValue":"Antarctica"
            },
            {
               "attribute":"NumericCode",
               "newValue":"010"
            }
         ],
         "eventTime":"2023-03-07T09:20:43Z",
         "userName":"integration-test-admin"
      }
   ]
}

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Get history of code value hierarchies by time range (v1)

Get history of code value hierarchies by time range (v1)

GET request

GET request query parameters

GET response

GET example