Field

Definition

Property Type Description
name String Name
type String

Type

Values:
  • Checks
  • Combo
  • Date
  • FileUpload
  • ImageUpload
  • Number
  • Radios
  • Signature
  • SoundRecorder
  • TextArea
  • TextBox
  • Time
Note that non-input fields are excluded
dataType String

Type of data in submission

Values:
  • Attachment
  • Date
  • Number
  • Png
  • String
  • Time
title String

Title

Nullable for some field types
choices String[]

Available value choices

Nullable for some field types
masked Boolean

Masked

Nullable for some field types

Example

[
    {
        "name": "a_text_field",
        "type": "TextBox",
        "dataType": "String",
        "title": "A text box",
        "choices": null,
        "masked": false
    },{
        "name": "a_big_text_field",
        "type": "TextArea",
        "dataType": "String",
        "title": "A text area",
        "choices": null,
        "masked": null
    },{
        "name": "single_choice",
        "type": "Combo",
        "dataType": "String",
        "title": "A drop-down",
        "choices": ["One", "Two", "Three"],
        "masked": null
    },{
        "name": "multi_choice",
        "type": "Checks",
        "dataType": "String",
        "title": "Check boxes",
        "choices": ["A", "B", "C", "D"],
        "masked": null
    },{
        "name": "signature",
        "type": "Signature",
        "dataType": "Png",
        "title": "A signature",
        "choices": null,
        "masked": null
    },{
        "name": "image_upload",
        "type": "ImageUpload",
        "dataType": "Attachment",
        "title": "An image upload",
        "choices": null,
        "masked": null
    }
]

results matching ""

    No results matching ""