getFormsData

Searching for all form data

FormData.getFormsData(langCode, offset, limit)

const value = await FormData.getFormsData()

Schema

langCode: string
Language code. Default "en_US"
example:

offset: number
Parameter for pagination. Default 0
example: 0

limit: number
Parameter for pagination. Default 30
example: 30

This method creates form data objects by sending a request to the API. It accepts an array of objects of type IFormsPost as the request body to provide the necessary form data. It returns a Promise that resolves to the created objects.

Example return:

{
  "total": 1,
  "items": [
    {
      "id": 1764,
      "formIdentifier": "my-form",
      "time": "2023-02-12 10:56",
      "formData": {
        "marker": "name_1",
        "value": "Name",
        "type": "string"
      },
      "attributeSetIdentifier": "test-form"
    }
  ]
}

Schema

total: number
total number of found records
example: 100

id: number
object identifier
example: 1764

formIdentifier: string
Text identifier of the form object (marker)
example: my-form

time: Date
Date and time of form modification
example: 2023-02-12 10:56

formData: FormDataLangType
Data submitted by the form
example:

{
  "en_US": [
    {
      "marker": "marker_1",
      "value": "Name"
    }
  ]
}

attributeSetIdentifier: string
text identifier (marker) of the used attribute set
example: test-form