GET api/v1/forms/datanames/{FormId}

List form data name

Request Information

URI Parameters

NameDescriptionTypeAdditional information
FormId

form Id

universally unique identifier

Required

Select

Select columns

Collection of ListFormDataNameV1Select

Default value: All

Example value: Name, FullName

Unique items

PageNumber

Page number

integer (32 bits)

Default value: 1

Example value: 1

Range: inclusive between 1 and 2147483647

PageSize

Number of records per page

integer (32 bits)

Default value: 10

Example value: 10

Range: inclusive between 0 and 100

Body Parameters

None.

Response Information

Resource Description

Retrieve a list of form data names

ListFormDataNameV1Response
NameDescriptionTypeAdditional information
FormDataNames

List of form data names

Collection of ListFormDataNameV1ResponseFormDataName

None.

Total

Total number of records matching the request

integer (32 bits)

Required

Example value: 42

Range: inclusive between 0 and 2147483647

Response Formats

application/json

Sample:
{
  "FormDataNames": [
    {
      "FormDataNameId": "0ae1737c-d2f1-4f7c-8fbd-c9566ed719d5",
      "ParentFormDataNameId": "fb63b708-cc7e-4097-8d8d-a21aa53d7a66",
      "Depth": 0,
      "IsArray": true,
      "Name": "date",
      "FullName": "image.pins[].data.date"
    },
    {
      "FormDataNameId": "0ae1737c-d2f1-4f7c-8fbd-c9566ed719d5",
      "ParentFormDataNameId": "fb63b708-cc7e-4097-8d8d-a21aa53d7a66",
      "Depth": 0,
      "IsArray": true,
      "Name": "date",
      "FullName": "image.pins[].data.date"
    }
  ],
  "Total": 42
}