Reference 360

Back Next

Get history of a hierarchy by time range (v2)

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

GET request

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

/rdm-service/external/v2/hierarchies/{assetKey}/summary/audit

GET request query parameters

The following table describes the parameter in the request body:

Parameter	Description
assetKey	Internal ID or alias of the hierarchy. When you provide an invalid assetKey in the request URL, the hierarchies 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 hierarchy 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 asset.
id	String	ID of the hierarchy. For more information, see Asset IDs.
name	String	Name of the hierarchy.
internalId	String	Unique identifier of the hierarchy.
alias	String	Alternative identifier of the hierarchy.
assetType	String	Type of the asset. The value is hierarchy .
modificationType	String	Type of change made to the hierarchy. Value can be CREATE, UPDATE, or DELETE.
fieldChanges	Object	Includes details of the previous and new values of the fields with changes.
confidentiality	String	Optional. Confidentiality of the hierarchy.
description	String	Optional. Description of the hierarchy.
domain	String	Optional. Domain of the hierarchy.
priority	String	Optional. Priority of the hierarchy.
status	String	Optional. Status of the hierarchy.
version	String	Optional. Version of the hierarchy.
eventTime	String	Date and time when the hierarchy was last updated.
userName	String	User name of the user who initiated the modification.

GET example

To retrieve all the change events of a hierarchy 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/hierarchies/country_iso/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 hierarchy 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: 2552

{
  "pageSize": 100,
  "page": 0,
  "numberOfElements": 6,
  "lastPage": true,
  "firstPage": true,
  "content": [
    {
      "asset": {
        "id": "640717485b243e32c4b048f9",
        "name": "Country ISO 3166-1",
        "internalId": "country_iso",
        "alias": "als_country_iso",
        "assetType": "HIERARCHY"
      },
      "modificationType": "UPDATE",
      "eventTime": "2023-03-07T10:53:29Z",
      "userName": "mdm-rdm-service"
    },
    {
      "asset": {
        "id": "640717485b243e32c4b048f9",
        "name": "Country ISO 3166-1",
        "internalId": "country_iso",
        "alias": "als_country_iso",
        "assetType": "HIERARCHY"
      },
      "modificationType": "UPDATE",
      "fieldChanges": {
        "application": {
          "newValue": {
            "key": "EnterpriseKey",
            "label": "Enterprise"
          }
        },
        "confidentiality": {
          "newValue": {
            "key": "PublicKey",
            "label": "Public"
          }
        },
        "description": {
          "newValue": "Hierarchy for Country Codes"
        },
        "domain": {
          "newValue": {
            "key": "GeographyKey",
            "label": "Geography"
          }
        },
        "priority": {
          "newValue": {
            "key": "Priority4",
            "label": "Low"
          }
        },
        "status": {
          "newValue": {
            "key": "ActiveKey",
            "label": "Active"
          }
        },
        "version": {
          "newValue": "1"
        }
      },
      "eventTime": "2023-03-07T10:53:28Z",
      "userName": "integration-test-admin"
    },
    {
      "asset": {
        "id": "640717485b243e32c4b048f9",
        "name": "Country ISO 3166-1",
        "internalId": "country_iso",
        "alias": "als_country_iso",
        "assetType": "HIERARCHY"
      },
      "modificationType": "UPDATE",
      "eventTime": "2023-03-07T10:52:15Z",
      "userName": "mdm-rdm-service"
    },
    {
      "asset": {
        "id": "640717485b243e32c4b048f9",
        "name": "Country ISO 3166-1",
        "internalId": "country_iso",
        "alias": "als_country_iso",
        "assetType": "HIERARCHY"
      },
      "modificationType": "UPDATE",
      "eventTime": "2023-03-07T10:52:14Z",
      "userName": "integration-test-admin"
    },
    {
      "asset": {
        "id": "640717485b243e32c4b048f9",
        "name": "Country ISO 3166-1",
        "assetType": "HIERARCHY"
      },
      "modificationType": "UPDATE",
      "eventTime": "2023-03-07T10:51:53Z",
      "userName": "mdm-rdm-service"
    },
    {
      "asset": {
        "id": "640717485b243e32c4b048f9",
        "name": "Country ISO 3166-1",
        "assetType": "HIERARCHY"
      },
      "modificationType": "CREATE",
      "fieldChanges": {
        "name": {
          "newValue": "Country ISO 3166-1"
        }
      },
      "eventTime": "2023-03-07T10:51:52Z",
      "userName": "integration-test-admin"
    }
  ]
}

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Get history of a hierarchy by time range (v2)

Get history of a hierarchy by time range (v2)

GET request

GET request query parameters

GET response

GET example