Reference 360

Back Next

Get history of code values of a code list (v2)

Retrieves all the change events of code values of a code list for a specific time range based on the internal ID or alias.

GET request

To retrieve all the change events of code values of a code list for a specific time range based on an internal ID or alias, submit a GET request with the following URI:

/rdm-service/external/v2/codelists/{codeListKey}/codevalues/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
codeListKey	Internal ID or alias of the code list from which you are retrieving the code values.
from	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	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	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 .
modificationType	Optional. Type of modification. Value can be CREATE or UPDATE_AND_DELETE.

GET response

The response contains the change event of code values of a code list for a specific time range.

The following table describes the attributes in the response body:

Attribute	Type	Description
pageSize	Number	Number of records displayed per page.
page	Number	Page from which the response was retrieved.
numberOfElements	Number	Number of records returned in the current page.
firstPage	Boolean	Indicates whether the current page is the first page in the total result.
lastPage	Boolean	Indicates whether the current page is the last 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.
id	String	ID of the code list. For more information, see Asset IDs.
internalId	String	Unique identifier of the code list.
alias	String	Alternative identifier of the code list.
assetType	String	Type of the asset. The value is CODELIST .
modificationType	String	Type of change made to the code values of the code list.
changedAttributes	Object	Includes details about the previous and new values of the attributes with changes.
code	String	Code field of the code values.
codeValueId	String	Internal ID of the code values.
eventTime	String	Date and time when the code values were last updated.
userName	String	User name of the user who initiated the modification.

GET example

To retrieve all the change events of code values of a code list for a specific time range based on the internal ID or alias, you might use the following request:

GET https://use4-mdm.dm-us.informaticacloud.com/rdm-service/external/v2/codelists/cl_country/codevalues/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 values of the code list 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": 12,
  "lastPage": true,
  "firstPage": true,
  "content": [
    {
      "asset": {
        "id": "64071b105b243e32c4b04caa",
        "internalId": "cl_country",
        "alias": "als_cl_country",
        "assetType": "CODELIST"
      },
      "modificationType": "DELETE",
      "from": {
        "previousValue": "France"
      },
      "to": {
        "previousValue": "Europe"
      },
      "eventTime": "2023-03-07T11:11:06Z",
      "userName": "integration-test-admin"
    },
    {
      "asset": {
        "id": "64071b105b243e32c4b04caa",
        "internalId": "cl_country",
        "alias": "als_cl_country",
        "assetType": "CODELIST"
      },
      "modificationType": "DELETE",
      "from": {
        "previousValue": "Paris"
      },
      "to": {
        "previousValue": "France"
      },
      "eventTime": "2023-03-07T11:11:06Z",
      "userName": "integration-test-admin"
    },
    {
      "asset": {
        "id": "64071b105b243e32c4b04caa",
        "internalId": "cl_country",
        "alias": "als_cl_country",
        "assetType": "CODELIST"
      },
      "modificationType": "CREATE",
      "from": {
        "newValue": "America"
      },
      "eventTime": "2023-03-07T11:10:14Z",
      "userName": "integration-test-admin"
    },
    {
      "asset": {
        "id": "64071b105b243e32c4b04caa",
        "internalId": "cl_country",
        "alias": "als_cl_country",
        "assetType": "CODELIST"
      },
      "modificationType": "CREATE",
      "from": {
        "newValue": "Europe"
      },
      "eventTime": "2023-03-07T11:10:14Z",
      "userName": "integration-test-admin"
    },
    {
      "asset": {
        "id": "64071b105b243e32c4b04caa",
        "internalId": "cl_country",
        "alias": "als_cl_country",
        "assetType": "CODELIST"
      },
      "modificationType": "CREATE",
      "from": {
        "newValue": "USA"
      },
      "to": {
        "newValue": "America"
      },
      "eventTime": "2023-03-07T11:10:14Z",
      "userName": "integration-test-admin"
    },
    {
      "asset": {
        "id": "64071b105b243e32c4b04caa",
        "internalId": "cl_country",
        "alias": "als_cl_country",
        "assetType": "CODELIST"
      },
      "modificationType": "CREATE",
      "from": {
        "newValue": "New York"
      },
      "to": {
        "newValue": "USA"
      },
      "eventTime": "2023-03-07T11:10:14Z",
      "userName": "integration-test-admin"
    },
    {
      "asset": {
        "id": "64071b105b243e32c4b04caa",
        "internalId": "cl_country",
        "alias": "als_cl_country",
        "assetType": "CODELIST"
      },
      "modificationType": "CREATE",
      "from": {
        "newValue": "Canada"
      },
      "to": {
        "newValue": "America"
      },
      "eventTime": "2023-03-07T11:10:14Z",
      "userName": "integration-test-admin"
    },
    {
      "asset": {
        "id": "64071b105b243e32c4b04caa",
        "internalId": "cl_country",
        "alias": "als_cl_country",
        "assetType": "CODELIST"
      },
      "modificationType": "CREATE",
      "from": {
        "newValue": "Toronto"
      },
      "to": {
        "newValue": "Canada"
      },
      "eventTime": "2023-03-07T11:10:14Z",
      "userName": "integration-test-admin"
    },
    {
      "asset": {
        "id": "64071b105b243e32c4b04caa",
        "internalId": "cl_country",
        "alias": "als_cl_country",
        "assetType": "CODELIST"
      },
      "modificationType": "CREATE",
      "from": {
        "newValue": "Germany"
      },
      "to": {
        "newValue": "Europe"
      },
      "eventTime": "2023-03-07T11:10:14Z",
      "userName": "integration-test-admin"
    },
    {
      "asset": {
        "id": "64071b105b243e32c4b04caa",
        "internalId": "cl_country",
        "alias": "als_cl_country",
        "assetType": "CODELIST"
      },
      "modificationType": "CREATE",
      "from": {
        "newValue": "Berlin"
      },
      "to": {
        "newValue": "Germany"
      },
      "eventTime": "2023-03-07T11:10:14Z",
      "userName": "integration-test-admin"
    },
    {
      "asset": {
        "id": "64071b105b243e32c4b04caa",
        "internalId": "cl_country",
        "alias": "als_cl_country",
        "assetType": "CODELIST"
      },
      "modificationType": "CREATE",
      "from": {
        "newValue": "France"
      },
      "to": {
        "newValue": "Europe"
      },
      "eventTime": "2023-03-07T11:10:14Z",
      "userName": "integration-test-admin"
    },
    {
      "asset": {
        "id": "64071b105b243e32c4b04caa",
        "internalId": "cl_country",
        "alias": "als_cl_country",
        "assetType": "CODELIST"
      },
      "modificationType": "CREATE",
      "from": {
        "newValue": "Paris"
      },
      "to": {
        "newValue": "France"
      },
      "eventTime": "2023-03-07T11:10:14Z",
      "userName": "integration-test-admin"
    }
  ]
}

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Get history of code values of a code list (v2)

Get history of code values of a code list (v2)

GET request

GET request query parameters

GET response

GET example