Reference 360

Back Next

Get history of a code list by time range (v2)

Retrieves all the change events 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 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/{assetKey}/summary/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 request query parameters:

Parameter	Description
assetKey	Internal ID or alias of a code list. When you provide an invalid assetKey in the request URL, the codelist version 2 REST API returns an error if the request contains invalid internal IDs or aliases.
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, UPDATE, or DELETE.

GET response

The response contains the change events 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.
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 list.
id	String	ID of the code list.
name	String	Name of the code list.
internalId	String	Unique identifier of the code list.
alias	String	Alternative identifier of the code list.
assetType	String	Type of the code list.
modificationType	String	The type of change made to the code list.
fieldChanges	Object	Includes details about the previous and new values of the fields with changes.
attributeChanges	Object	Includes details about the previous and new values of the attributes with changes.
eventTime	String	The date and time when the code list was last updated.
userName	String	The user name of the user who initiated the modification.
application	String	Optional. Application that uses the code list.
approvedById	String	Optional. ID of the approver of the asset.
approvedByName	String	Optional. User name of the user who approved the asset.
approvedOn	String	Optional. Date the asset was approved.
description	String	Optional. Description of asset.
effectiveDate	String	Optional. Date the asset became effective.
status	String	Optional. Status of the asset.
version	String	Optional. Version of the code list.

GET example

To retrieve all the change events 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/ent_numeric/summary/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 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: 4991

{
  "pageSize": 100,
  "page": 0,
  "numberOfElements": 8,
  "lastPage": true,
  "firstPage": true,
  "content": [
    {
      "asset": {
        "id": "6407014f5b243e32c4b02ce3",
        "name": "ISO 3166-1 numeric",
        "internalId": "ent_numeric",
        "alias": "als_ent_numeric",
        "assetType": "CODELIST"
      },
      "modificationType": "UPDATE",
      "eventTime": "2023-03-07T09:23:35Z",
      "userName": "integration-test-admin"
    },
    {
      "asset": {
        "id": "6407014f5b243e32c4b02ce3",
        "name": "ISO 3166-1 numeric",
        "internalId": "ent_numeric",
        "alias": "als_ent_numeric",
        "assetType": "CODELIST"
      },
      "modificationType": "UPDATE",
      "fieldChanges": {
        "additionalDescription": {
          "newValue": "(ISO 3166-1)"
        },
        "application": {
          "newValue": {
            "key": "EnterpriseKey",
            "label": "Enterprise"
          }
        },
        "approvedById": {
          "newValue": "2L0DXgAOiCObZDT7Yql02R"
        },
        "approvedByName": {
          "newValue": "integration-test-planner"
        },
        "approvedOn": {
          "newValue": "2023-03-08"
        },
        "description": {
          "newValue": "Numeric Codes for Countries"
        },
        "effectiveDate": {
          "newValue": "2023-03-06"
        },
        "status": {
          "newValue": {
            "key": "ActiveKey",
            "label": "Active"
          }
        },
        "version": {
          "newValue": "1"
        }
      },
      "eventTime": "2023-03-07T09:23:34Z",
      "userName": "integration-test-admin"
    },
    {
      "asset": {
        "id": "6407014f5b243e32c4b02ce3",
        "name": "ISO 3166-1 numeric",
        "internalId": "ent_numeric",
        "alias": "als_ent_numeric",
        "assetType": "CODELIST"
      },
      "modificationType": "UPDATE",
      "attributeChanges": {
        "NumericCode": {
          "name": {
            "newValue": "NumericCode"
          },
          "type": {
            "newValue": "String"
          },
          "required": {
            "newValue": "false"
          }
        }
      },
      "eventTime": "2023-03-07T09:19:29Z",
      "userName": "integration-test-admin"
    },
    {
      "asset": {
        "id": "6407014f5b243e32c4b02ce3",
        "name": "ISO 3166-1 numeric",
        "internalId": "ent_numeric",
        "alias": "als_ent_numeric",
        "assetType": "CODELIST"
      },
      "modificationType": "UPDATE",
      "attributeChanges": {
        "NumericCode": {
          "name": {
            "newValue": "NumericCode"
          },
          "type": {
            "newValue": "String"
          },
          "required": {
            "newValue": "false"
          }
        }
      },
      "eventTime": "2023-03-07T09:19:27Z",
      "userName": "integration-test-admin"
    },
    {
      "asset": {
        "id": "6407014f5b243e32c4b02ce3",
        "name": "ISO 3166-1 numeric",
        "internalId": "ent_numeric",
        "alias": "als_ent_numeric",
        "assetType": "CODELIST"
      },
      "modificationType": "UPDATE",
      "eventTime": "2023-03-07T09:18:19Z",
      "userName": "integration-test-admin"
    },
    {
      "asset": {
        "id": "6407014f5b243e32c4b02ce3",
        "name": "ISO 3166-1 numeric",
        "internalId": "ent_numeric",
        "alias": "als_ent_numeric",
        "assetType": "CODELIST"
      },
      "modificationType": "UPDATE",
      "eventTime": "2023-03-07T09:18:17Z",
      "userName": "integration-test-admin"
    },
    {
      "asset": {
        "id": "6407014f5b243e32c4b02ce3",
        "name": "ISO 3166-1 numeric",
        "internalId": "ent_numeric",
        "alias": "als_ent_numeric",
        "assetType": "CODELIST"
      },
      "modificationType": "UPDATE",
      "eventTime": "2023-03-07T09:18:09Z",
      "userName": "integration-test-admin"
    },
    {
      "asset": {
        "id": "6407014f5b243e32c4b02ce3",
        "name": "ISO 3166-1 numeric",
        "internalId": "ent_numeric",
        "alias": "als_ent_numeric",
        "assetType": "CODELIST"
      },
      "modificationType": "CREATE",
      "fieldChanges": {
        "displayColumns": {
          "newValue": [
            "Name"
          ]
        },
        "hierarchical": {
          "newValue": "false"
        },
        "levels": {
          "newValue": "1"
        },
        "name": {
          "newValue": "ISO 3166-1 numeric"
        },
        "termId": {
          "newValue": "6407004f6b19964cc917c7bf"
        }
      },
      "attributeChanges": {
        "Alpha2Code": {
          "name": {
            "newValue": "Alpha2Code"
          },
          "type": {
            "newValue": "String"
          },
          "required": {
            "newValue": "false"
          }
        },
        "Alpha3Code": {
          "name": {
            "newValue": "Alpha3Code"
          },
          "type": {
            "newValue": "String"
          },
          "required": {
            "newValue": "false"
          }
        },
        "Code": {
          "name": {
            "newValue": "Code"
          },
          "type": {
            "newValue": "String"
          },
          "required": {
            "newValue": "true"
          }
        },
        "Description": {
          "name": {
            "newValue": "Description"
          },
          "type": {
            "newValue": "String"
          },
          "required": {
            "newValue": "false"
          }
        },
        "Name": {
          "name": {
            "newValue": "Name"
          },
          "type": {
            "newValue": "String"
          },
          "required": {
            "newValue": "true"
          }
        }
      },
      "eventTime": "2023-03-07T09:18:07Z",
      "userName": "integration-test-admin"
    }
  ]
}

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Get history of a code list by time range (v2)

Get history of a code list by time range (v2)

GET request

GET request query parameters

GET response

GET example