GET FormInstanceChangeLog

Description

This API endpoint retrieves the change log associated with a generated form instance. The change log provides a detailed record of any modifications made to the form instance, including information such as the type of change, timestamp, and the user responsible for the change. By accessing the change log, users can track the history of modifications made to the form instance, facilitating transparency and auditability of the data.

ALT

Endpoint

• Endpoint: <environment base url>/v1.0/api/Forms/FormInstanceChangeLog

• Method: GET

Request Parameters

Parameter	Type	Required	Description
id	string(max length 32)	Yes	Form instance id

Response Structure

{
  "data": {
    "changeLog": [
      {
        "elementId": "String",
        "elementName": "String",
        "attributeId": "String",
        "attributeName": "String",
        "oldValue": "String",
        "newValue": "String",
        "changedBy": "String",
        "changedOn": "String"
      }
    ]
  }
}

API Contract

elementId: optional, max length 10.
attributeId: optional, max length 5.
elementName: max length 1333. Field name/form element name for which the change log belongs.
AttributeName: optional, max length 1333.
changedOn: timestamp on which the change was made.
changedBy: max length 12, is the user who performed the change.
oldValue: max length 1333, is the field value before the change.
newValue: max length 1333, is the field value after the change.
Change logs are returned across all the edits, regeneration, and resets performed on a form instance by any user.

Sample Response

{
    "data": {
        "changeLog": []
    }
}

Sample request [CURL]

curl --location 'https://testsuretaxapi.taxrating.net/v1.0/api/Forms/FormInstanceChangeLog?Id=999db138-40cb-405e-92b0-c4f34d9b7481' \
--header 'Authorization: Bearer <access_token_value>' \
--data ''