getFormsDataByMarker

Searching for form data by text identifier (marker)

FormData.getFormsDataByMarker(marker, langCode, offset, limit)

const value = await FormData.getFormsDataByMarker('my-marker')

Schema

marker:* string
Marker of form
example: my-marker

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

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

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

This method retrieves a specific form data object by its marker from the API. It accepts a marker parameter as the marker of the form data. It returns a Promise that resolves to an array of objects of type FormDataEntity.

Example return:

{
  "total": 10,
  "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

---