Reference 360

Back Next

Get history of a crosswalk by time range (v3)

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

GET request

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

/rdm-service/external/v3/crosswalks/{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 query parameters:

Parameter	Description
assetKey	Internal ID or alias of a crosswalk. When you provide an invalid assetKey in the request URL, the crosswalk version 3 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 crosswalk for a specific time range.

The following table describes the attributes in the response body:

Attributes	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.
id	String	ID of the crosswalk. For more information, see Asset IDs.
name	String	Name of the crosswalk.
internalId	String	Unique identifier of the crosswalk.
alias	String	Alternative identifier of the crosswalk.
assetType	String	Optional. Type of asset. Set the value to REFERENCEDATASET, CODELIST, CROSSWALK, or HIERARCHY.
asset	Object	Includes details about the crosswalk.
modificationType	String	Type of change made to the crosswalk. Value can be CREATE, UPDATE, or DELETE.
fieldChanges	Object	Displays the previous and new values of the fields with changes.
attributeChanges	Object	Displays the previous and new values of the attributes with changes.
eventTime	String	Date and time when the crosswalk was last modified.
userName	String	User name of the user who initiated the modification.

GET example

To retrieve all the change events of a crosswalk 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/v3/crosswalks/cl_audit/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 crosswalk 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: 1247

{
  "pageSize": 100,
  "page": 0,
  "numberOfElements": 4,
  "lastPage": true,
  "firstPage": true,
  "content": [
    {
      "asset": {
        "id": "63eb866c3eceda5c401e22bb",
        "name": "ZIT_16763797384291632_4196_ExternalCodeListAuditTrailTest_IntTestCodelist1_1",
        "internalId": "cl_audit",
        "alias": "als_cl_audit",
        "assetType": "CODELIST"
      },
      "modificationType": "UPDATE",
      "eventTime": "2023-02-14T13:02:48Z",
      "userName": "integration-test-admin"
    },
    {
      "asset": {
        "id": "63eb866c3eceda5c401e22bb",
        "name": "ZIT_16763797384291632_4196_ExternalCodeListAuditTrailTest_IntTestCodelist1_1",
        "internalId": "cl_audit",
        "alias": "als_cl_audit",
        "assetType": "CODELIST"
      },
      "modificationType": "UPDATE",
      "fieldChanges": {
        "description": {
          "previousValue": "description 1",
          "newValue": "description 2"
        },
        "version": {
          "previousValue": "version 1",
          "newValue": "version 2"
        }
      },
      "attributeChanges": {
        "ReferenceAttribute": {
          "displayAttributes": {
            "previousValue": [
              "Name",
              "Code"
            ],
            "newValue": [
              "Code"
            ]
          }
        }
      },
      "eventTime": "2023-02-14T13:02:46Z",
      "userName": "integration-test-admin"
    },
    {
      "asset": {
        "id": "63eb866c3eceda5c401e22bb",
        "name": "ZIT_16763797384291632_4196_ExternalCodeListAuditTrailTest_IntTestCodelist1_1",
        "internalId": "cl_audit",
        "alias": "als_cl_audit",
        "assetType": "CODELIST"
      },
      "modificationType": "UPDATE",
      "eventTime": "2023-02-14T13:02:40Z",
      "userName": "integration-test-admin"
    },
    {
      "asset": {
        "id": "63eb866c3eceda5c401e22bb",
        "name": "ZIT_16763797384291632_4196_ExternalCodeListAuditTrailTest_IntTestCodelist1_1",
        "internalId": "cl_audit",
        "alias": "als_cl_audit",
        "assetType": "CODELIST"
      },
      "modificationType": "CREATE",
      "fieldChanges": {
        "description": {
          "newValue": "description 1"
        },
        "displayColumns": {
          "newValue": [
            "Name"
          ]
        },
        "hierarchical": {
          "newValue": "true"
        },
        "levels": {
          "newValue": "6"
        },
        "name": {
          "newValue": "ZIT_16763797384291632_4196_ExternalCodeListAuditTrailTest_IntTestCodelist1_1"
        },
        "termId": {
          "newValue": "63eb865cf663af1d2a7ef268"
        },
        "version": {
          "newValue": "version 1"
        }
      },
      "attributeChanges": {
        "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"
          }
        },
        "ReferenceAttribute": {
          "name": {
            "newValue": "referenceAttribute"
          },
          "type": {
            "newValue": "Reference"
          },
          "required": {
            "newValue": "false"
          },
          "displayAttributes": {
            "newValue": [
              "Name",
              "Code"
            ]
          },
          "referenceDataSetId": {
            "newValue": "63ffb73ba7fc2c03f6273205"
          },
          "codeListId": {
            "newValue": "63ffb73d87e60e6fcd814fbd"
          }
        }
      },
      "dependencyChanges": {
        "displayAttributes": {
          "newValue": [
            "Name",
            "Code"
          ]
        },
        "referenceDataSetId": {
          "newValue": "63ffc0e0a7fc2c03f627323c"
        },
        "codeListId": {
          "newValue": "63ffc0e287e60e6fcd815026"
        }
      },
      "eventTime": "2023-02-14T13:02:35Z",
      "userName": "integration-test-admin"
    }
  ]
}

Rename Saved Search

Table of Contents

Reference 360

Reference 360

Get history of a crosswalk by time range (v3)

Get history of a crosswalk by time range (v3)

GET request

GET request query parameters

GET response

GET example