Skip to main content

Export form definitions by tenant.​

No parameters required.

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: 250
  • 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

    Filters

    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

    Sorters

    Item will be sorted in the returned array if the sorters expression evaluates to true for that item. 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 definitions by tenant

Schema
  • count int64

    Count number of Results

  • results object[]

    Results holds a list of FormDefinitionResponse items

  • created date-time

    Created is the date the form definition was created

  • description string

    Description is the form definition description

  • formConditions object[]

    FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form

  • effects object[]

    Effects is a list of effects

  • config object

    Config is a arbitrary map that holds a configuration based on EffectType

  • effectType string

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

    EffectType is the type of effect to perform when the conditions are evaluated for this logic block HIDE ConditionEffectTypeHide ConditionEffectTypeHide disables validations SHOW ConditionEffectTypeShow ConditionEffectTypeShow enables validations DISABLE ConditionEffectTypeDisable ConditionEffectTypeDisable disables validations ENABLE ConditionEffectTypeEnable ConditionEffectTypeEnable enables validations REQUIRE ConditionEffectTypeRequire OPTIONAL ConditionEffectTypeOptional SUBMIT_MESSAGE ConditionEffectTypeSubmitMessage SUBMIT_NOTIFICATION ConditionEffectTypeSubmitNotification SET_DEFAULT_VALUE ConditionEffectTypeSetDefaultValue ConditionEffectTypeSetDefaultValue is ignored on purpose

  • ruleOperator string

    Possible values: [AND, OR]

    RuleOperator is a ConditionRuleLogicalOperatorType value AND ConditionRuleLogicalOperatorTypeAnd OR ConditionRuleLogicalOperatorTypeOr

  • rules object[]

    Rules is a list of rules

  • operator string

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

    Operator is a ConditionRuleComparisonOperatorType value EQ ConditionRuleComparisonOperatorTypeEquals ConditionRuleComparisonOperatorTypeEquals is a comparison operator, the source and target are compared for equality NE ConditionRuleComparisonOperatorTypeNotEquals ConditionRuleComparisonOperatorTypeNotEquals is a comparison operator, the source and target are compared for the opposite of equality CO ConditionRuleComparisonOperatorTypeContains ConditionRuleComparisonOperatorTypeContains is a comparison operator, the source is searched to see if it contains the value NOT_CO ConditionRuleComparisonOperatorTypeNotContains IN ConditionRuleComparisonOperatorTypeIncludes ConditionRuleComparisonOperatorTypeIncludes is a comparison operator, the source will be searched if it equals any of the values NOT_IN ConditionRuleComparisonOperatorTypeNotIncludes EM ConditionRuleComparisonOperatorTypeEmpty NOT_EM ConditionRuleComparisonOperatorTypeNotEmpty SW ConditionRuleComparisonOperatorTypeStartsWith ConditionRuleComparisonOperatorTypeStartsWith checks if a string starts with another substring of the same string, this operator is case-sensitive NOT_SW ConditionRuleComparisonOperatorTypeNotStartsWith EW ConditionRuleComparisonOperatorTypeEndsWith ConditionRuleComparisonOperatorTypeEndsWith checks if a string ends with another substring of the same string, this operator is case-sensitive NOT_EW ConditionRuleComparisonOperatorTypeNotEndsWith

  • source string

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

  • sourceType string

    Possible values: [INPUT, ELEMENT]

    SourceType defines what type of object is being selected. Either a reference to a form input (by input name), or a form element (by technical key) INPUT ConditionRuleSourceTypeInput ELEMENT ConditionRuleSourceTypeElement

  • value

    Value is the value based on the ValueType

  • valueType string

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

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

  • formElements object[]

    FormElements is a list of nested form elements

  • config object

    Config is a config object

  • elementType string

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

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

  • id string

    ID is a form element identifier

  • key string

    Key is the technical key

  • validations object

    FormElementValidationsSet is a set of FormElementValidation items

  • formInput object[]

    FormInput is a list of form inputs that are required when creating a form-instance object

  • description string

    Description is the description for this form input value

  • id string

    ID is a unique identifier

  • label string

    Label is the name for this form input value

  • type string

    Possible values: [STRING]

    Type is a FormDefinitionInputType value STRING FormDefinitionInputTypeString

  • id string

    FormDefinitionID is a unique guid identifying this form definition

  • modified date-time

    Modified is the last date the form definition was modified

  • name string

    Name is the form definition name

  • owner object
  • id string

    ID is a unique identifier

  • type string

    Possible values: [IDENTITY]

    Type is a FormOwnerType value IDENTITY FormOwnerTypeIdentity

  • usedBy object[]

    UsedBy is a list of objects where when any system uses a particular form it reaches out to the form service to record it is currently being used

  • id string

    ID is a unique identifier

  • type string

    Possible values: [WORKFLOW, SOURCE]

    Type is a FormUsedByType value WORKFLOW FormUsedByTypeWorkflow SOURCE FormUsedByTypeSource

Loading...