Skip to main content

Retrieves dynamic data by element.

GET 
/form-instances/:formInstanceID/data-source/:formElementID

Parameter {formInstanceID} should match a form instance ID. Parameter {formElementID} should match a form element ID at the data source configuration.

Request​

Path Parameters

    formInstanceID stringrequired

    Form instance ID

    Example: 00000000-0000-0000-0000-000000000000
    formElementID stringrequired

    Form element ID

    Example: 1

Query Parameters

    limit int64

    Possible values: <= 250 characters

    Default value: 250

    Limit

    Integer specifying the maximum number of records to return in a single API call. The standard syntax described in V3 API Standard Collection Parameters. If it is not specified, a default limit is used.

    Example: 250
    filters string

    Filter results using the standard syntax described in V3 API Standard Collection Parameters

    Filtering is supported for the following fields and operators:

    value: eq, ne, in

    Supported composite operators: not

    Only a single not may be used, and it can only be used with the in operator. The not composite operator must be used in front of the field. For example, the following is valid: not value in ("ID01")

    Example: value eq "ID01"
    query string

    String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a "starts with" filter against several fields.

    Example: support

Responses​

Retrieves dynamic data to aid in correctly completing a valid form by form element ID from data source configuration

Schema
    results object[]

    Results holds a list of FormElementDataSourceConfigOptions items

  • Array [
    • label string

    Label is the main label to display to the user when selecting this option

    subLabel string

    SubLabel is the sub label to display below the label in diminutive styling to help describe or identify this option

    value string

    Value is the value to save as an entry when the user selects this option

  • ]
Loading...