SureTax Returns API

GET Form Instance Change Log ID

OVERVIEWREQUESTRESPONSETRY IT OUT

Overview

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.

OperationId: GET Form Instance Change Log ID

Authorization Method(s): OAuth

Verb: GET

End Point: /api/v1/Forms/FormInstanceChangeLog

Query Parameters

Display String	Field Name	Field Type
Id*	Id	string

*Mandatory parameter

FormInstanceChangeLogResponse

OVERVIEWEXAMPLE

Overview

FormInstanceChangeLogResponse

Display Name	Field Name	Field Type
Data	data	ChangeLogData

ChangeLogData

Display Name	Field Name	Field Type
Change Log	changeLog	array[ChangeLogEntry]

ChangeLogEntry

Display Name	Field Name	Field Type
Element Id *	elementId	string
Element Name *	elementName	string
Attribute Id *	attributeId	string
Attribute Name *	attributeName	string
Old Value *	oldValue	string
New Value *	newValue	string
Changed By *	changedBy	string
Changed On *	changedOn	string

Example Response

{
  "data": {
    "changeLog": [
      {
        "elementId": "12345",
        "elementName": "Form Title",
        "attributeId": "attr-001",
        "attributeName": "Title",
        "oldValue": "Old Form Title",
        "newValue": "New Form Title",
        "changedBy": "user123",
        "changedOn": "2024-10-20T14:30:00Z"
      }
    ]
  }
}

Response Codes

code	description
200	The API response contains the change log for the specified form instance. Success Response - 200 OK.
204	204 No Content If no records are found for the provided request, the API will respond with a No Content status.
400	Bad request. Invalid parameters or missing required information.
401	Unauthorized access. The request requires user authentication.
500	Internal server error. An error occurred while processing the request.

To execute a web service call for API Key Enabled APIs, Select an environment and enter the client number and validation api key corresponding to that environment.

Select Environment:End Point:

/api/v1/Forms/FormInstanceChangeLog

Add Request Headers: