GET FormInstanceGenerationLog

Description

This API endpoint retrieves the generation log associated with a specific form instance. It allows clients to access detailed information about the process of generating the form, including any messages, warnings, or errors encountered during the generation process. This information can be valuable for troubleshooting, auditing, and ensuring the accuracy of generated forms.

ALT

Endpoint

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

• Method: GET

Request Parameters

Parameter Type Required
id String (max length 32) Yes

Response Structure

{
  "data": {
    "log": [
      {
        "messageType": "String",
        "message": "String",
        "elementId": "String",
        "elementName": "String",
        "attributeId": "String",
        "attributeName": "String"
      }
    ]
  }
} `

API Contract

Permitted Values

messageType

Code Value
E Error

Field Specifications

  • messageType
  • message: Max length 1333.
  • elementId: Optional, max length 10.
  • attributeId: Optional, max length 5.
  • elementName: Max length 1333. Field name/form element name for which the log message belongs.
  • attributeName: Optional, max length 1333.

Sample Response

{
    "data": {
        "logs": [
            {
                "id": "01234567-89ab-cdef-0123-456789abcdef",
                "messageType": "E",
                "message": "Invalid value at 'Tax Payer ID': '123456789'. Value must be 8 digits.",
                "elementName": "Tax Payer ID",
                "attributeName": ""
            }
        ]
    }
}

Sample request [CURL]

curl --location 'https://exampleapi.example.net/v1.0/api/Forms/FormInstanceGenerationLogs?Id=example-id-1234-5678-90ab-cdef12345678' \
--header 'Authorization: Bearer exampleToken1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz' \
--header 'Cookie: incap_ses_1607_1234567=exampleCookieValue1; incap_ses_76_1234567=exampleCookieValue2; incap_ses_8216_1234567=exampleCookieValue3; nlbi_1234567=exampleCookieValue4; visid_incap_1234567=exampleCookieValue5' \