Return a form definition.
GET/form-definitions/:formDefinitionID
Parameter {formDefinitionID}
should match a form definition ID.
Request
Path Parameters
Form definition ID
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 500
Returns a form definition
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- Array [
- ]
- ]
Unique guid identifying the form definition.
Name of the form definition.
Form definition's description.
owner object
Possible values: [IDENTITY
]
FormOwnerType value. IDENTITY FormOwnerTypeIdentity
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.
Possible values: [WORKFLOW
, SOURCE
]
FormUsedByType value. WORKFLOW FormUsedByTypeWorkflow SOURCE FormUsedByTypeSource
Unique identifier of the system using the form.
formInput object[]
List of form inputs required to create a form-instance object.
Unique identifier for the form input.
Possible values: [STRING
]
FormDefinitionInputType value. STRING FormDefinitionInputTypeString
Name for the form input.
Form input's description.
formElements object[]
List of nested form elements.
Form element identifier.
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.
Technical key.
Set of FormElementValidation items.
formConditions object[]
Conditional logic that can dynamically modify the form as the recipient is interacting with it.
Possible values: [AND
, OR
]
ConditionRuleLogicalOperatorType value. AND ConditionRuleLogicalOperatorTypeAnd OR ConditionRuleLogicalOperatorTypeOr
rules object[]
List of rules.
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 - 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.
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
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
Based on the ValueType.
effects object[]
List of effects.
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.
Effect type's label.
Element's identifier.
Created is the date the form definition was created
Modified is the last date the form definition was modified
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "My form",
"description": "My form description",
"owner": {
"type": "IDENTITY",
"id": "00000000-0000-0000-0000-000000000000"
},
"usedBy": [
{
"type": "WORKFLOW",
"id": "00000000-0000-0000-0000-000000000000"
}
],
"formInput": [
{
"id": "00000000-0000-0000-0000-000000000000",
"type": "STRING",
"label": "input1",
"description": "A single dynamic scalar value (i.e. number, string, date, etc.) that can be passed into the form for use in conditional logic"
}
],
"formElements": [
{
"id": "00000000-0000-0000-0000-000000000000",
"elementType": "TEXT",
"config": {
"label": "Department"
},
"key": "department",
"validations": [
{
"validationType": "REQUIRED"
}
]
}
],
"formConditions": [
{
"ruleOperator": "AND",
"rules": [
{
"sourceType": "ELEMENT",
"source": "department",
"operator": "EQ",
"valueType": "STRING",
"value": "Engineering"
}
],
"effects": [
{
"effectType": "HIDE",
"config": {
"defaultValueLabel": "Access to Remove",
"element": 8110662963316867
}
}
]
}
],
"created": "2023-07-12T20:14:57.74486Z",
"modified": "2023-07-12T20:14:57.74486Z"
}
An error with the request occurred
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
messages object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
An error with the authorization occurred
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
messages object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
An error with the user permissions occurred
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
messages object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
An error with the item not found
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
messages object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
Too many requests
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
DetailCode is the text of the status code returned
messages object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
TrackingID is the request tracking unique identifier
{
"detailCode": "Internal Server Error",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"trackingId": "9cd03ef80e6a425eb6b11bdbb057cdb4"
}
An internal server error occurred
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
messages object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}