Skip to main content

List form definitions by tenant.

GET 
/form-definitions/export

No parameters required.

Request​

Query Parameters

    offset int64

    Offset

    Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in V3 API Standard Collection Parameters. The offset value is record-based, not page-based, and the index starts at 0.

    Example: 0
    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:

    name: eq, gt, sw, in

    description: eq, gt, sw, in

    created: eq, gt, sw, in

    modified: eq, gt, sw, in

    Example: name sw "my form"
    sorters string

    Default value: name

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

    Sorting is supported for the following fields: name, description, created, modified

    Example: name

Responses​

Returns a list of form definition objects by tenant used by SP-Config

Schema
  • Array [
    • object object
    id string

    Unique guid identifying the form definition.

    name string

    Name of the form definition.

    description string

    Form definition's description.

    owner object
    type string

    Possible values: [IDENTITY]

    FormOwnerType value. IDENTITY FormOwnerTypeIdentity

    id string

    Unique identifier of the form's owner.

    usedBy object[]

    List of objects using the form definition. Whenever a system uses a form, the API reaches out to the form service to record that the system is currently using it.

  • Array [
    • type string

    Possible values: [WORKFLOW, SOURCE]

    FormUsedByType value. WORKFLOW FormUsedByTypeWorkflow SOURCE FormUsedByTypeSource

    id string

    Unique identifier of the system using the form.

  • ]
    • formInput object[]

    List of form inputs required to create a form-instance object.

  • Array [
    • id string

    Unique identifier for the form input.

    type string

    Possible values: [STRING]

    FormDefinitionInputType value. STRING FormDefinitionInputTypeString

    label string

    Name for the form input.

    description string

    Form input's description.

  • ]
    • formElements object[]

    List of nested form elements.

  • Array [
    • id string

    Form element identifier.

    elementType string

    Possible values: [TEXT, TOGGLE, TEXTAREA, HIDDEN, PHONE, EMAIL, SELECT, DATE, SECTION, COLUMNS]

    FormElementType value. TEXT FormElementTypeText TOGGLE FormElementTypeToggle TEXTAREA FormElementTypeTextArea HIDDEN FormElementTypeHidden PHONE FormElementTypePhone EMAIL FormElementTypeEmail SELECT FormElementTypeSelect DATE FormElementTypeDate SECTION FormElementTypeSection COLUMNS FormElementTypeColumns

    config object

    Config object.

    key string

    Technical key.

    validations object

    Set of FormElementValidation items.

  • ]
    • formConditions object[]

    Conditional logic that can dynamically modify the form as the recipient is interacting with it.

  • Array [
    • ruleOperator string

    Possible values: [AND, OR]

    ConditionRuleLogicalOperatorType value. AND ConditionRuleLogicalOperatorTypeAnd OR ConditionRuleLogicalOperatorTypeOr

    rules object[]

    List of rules.

  • Array [
    • sourceType string

    Possible values: [INPUT, ELEMENT]

    Defines the type of object being selected. It will be either a reference to a form input (by input name) or a form element (by technical key). INPUT ConditionRuleSourceTypeInput ELEMENT ConditionRuleSourceTypeElement

    source string

    Source - if the sourceType is ConditionRuleSourceTypeInput, the source type is the name of the form input to accept. However, if the sourceType is ConditionRuleSourceTypeElement, the source is the name of a technical key of an element to retrieve its value.

    operator string

    Possible values: [EQ, NE, CO, NOT_CO, IN, NOT_IN, EM, NOT_EM, SW, NOT_SW, EW, NOT_EW]

    ConditionRuleComparisonOperatorType value. EQ ConditionRuleComparisonOperatorTypeEquals This comparison operator compares the source and target for equality. NE ConditionRuleComparisonOperatorTypeNotEquals This comparison operator compares the source and target for inequality. CO ConditionRuleComparisonOperatorTypeContains This comparison operator searches the source to see whether it contains the value. NOT_CO ConditionRuleComparisonOperatorTypeNotContains IN ConditionRuleComparisonOperatorTypeIncludes This comparison operator searches the source if it equals any of the values. NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes EM ConditionRuleComparisonOperatorTypeEmpty NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty SW ConditionRuleComparisonOperatorTypeStartsWith Checks whether a string starts with another substring of the same string. This operator is case-sensitive. NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith EW ConditionRuleComparisonOperatorTypeEndsWith Checks whether a string ends with another substring of the same string. This operator is case-sensitive. NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith

    valueType string

    Possible values: [STRING, STRING_LIST, INPUT, ELEMENT, LIST, BOOLEAN]

    ConditionRuleValueType type. STRING ConditionRuleValueTypeString This value is a static string. STRING_LIST ConditionRuleValueTypeStringList This value is an array of string values. INPUT ConditionRuleValueTypeInput This value is a reference to a form input. ELEMENT ConditionRuleValueTypeElement This value is a reference to a form element (by technical key). LIST ConditionRuleValueTypeList BOOLEAN ConditionRuleValueTypeBoolean

    value

    Based on the ValueType.

  • ]
    • effects object[]

    List of effects.

  • Array [
    • effectType string

    Possible values: [HIDE, SHOW, DISABLE, ENABLE, REQUIRE, OPTIONAL, SUBMIT_MESSAGE, SUBMIT_NOTIFICATION, SET_DEFAULT_VALUE]

    Type of effect to perform when the conditions are evaluated for this logic block. HIDE ConditionEffectTypeHide Disables validations. SHOW ConditionEffectTypeShow Enables validations. DISABLE ConditionEffectTypeDisable Disables validations. ENABLE ConditionEffectTypeEnable Enables validations. REQUIRE ConditionEffectTypeRequire OPTIONAL ConditionEffectTypeOptional SUBMIT_MESSAGE ConditionEffectTypeSubmitMessage SUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification SET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue This value is ignored on purpose.

    config object

    Arbitrary map containing a configuration based on the EffectType.

    defaultValueLabel string

    Effect type's label.

    element string

    Element's identifier.

  • ]
  • ]
    • created date-time

    Created is the date the form definition was created

    modified date-time

    Modified is the last date the form definition was modified

    self string
    version int8
  • ]
Loading...