Workflow API: Forms

Retrieves one specific form condition

get
Authorizations
BearerstringRequired
Path parameters
maskedSurveyQuestionstring · uuidRequired
maskingSurveyOptionItemstring · uuidRequired
questionstringRequired
optionstringRequired
Responses
chevron-right
200

OK

get
/api/workflow/forms-conditions/{question}/{option}
200

OK

Checks for the existence of one specific form condition

head
Authorizations
BearerstringRequired
Path parameters
maskedSurveyQuestionstring · uuidRequired
maskingSurveyOptionItemstring · uuidRequired
questionstringRequired
optionstringRequired
Responses
chevron-right
200

OK

Responseboolean
head
/api/workflow/forms-conditions/{question}/{option}
200

OK

Collects the list of form conditions that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/forms-conditions/collect
200

OK

Counts the form conditions that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/forms-conditions/count
200

OK

Downloads the list of form conditions that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
Responses
chevron-right
200

OK

No content

post
/api/workflow/forms-conditions/download
200

OK

No content

Searches for the list of form conditions that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/forms-conditions/search
200

OK

Retrieves one specific form

get
Authorizations
BearerstringRequired
Path parameters
surveyFormstring · uuidRequired
formstringRequired
Responses
chevron-right
200

OK

get
/api/workflow/forms/{form}
200

OK

Checks for the existence of one specific form

head
Authorizations
BearerstringRequired
Path parameters
surveyFormstring · uuidRequired
formstringRequired
Responses
chevron-right
200

OK

Responseboolean
head
/api/workflow/forms/{form}
200

OK

Collects the list of forms that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
lastChangeUserstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
surveyMessageInvitationstring · uuid | nullableOptional
surveyMessageResponseCompletedstring · uuid | nullableOptional
surveyMessageResponseConfirmedstring · uuid | nullableOptional
surveyMessageResponseStartedstring · uuid | nullableOptional
displaySummaryChartboolean | nullableOptional
enableUserConfidentialityboolean | nullableOptional
hasWorkflowConfigurationboolean | nullableOptional
requireUserAuthenticationboolean | nullableOptional
requireUserIdentificationboolean | nullableOptional
lastChangeTypestring | nullableOptional
surveyFormHookstring | nullableOptional
surveyFormLanguagestring | nullableOptional
surveyFormLanguageTranslationsstring | nullableOptional
surveyFormNamestring | nullableOptional
surveyFormStatusstring | nullableOptional
userFeedbackstring | nullableOptional
assetNumberinteger · int32 | nullableOptional
branchCountinteger · int32 | nullableOptional
conditionCountinteger · int32 | nullableOptional
pageCountinteger · int32 | nullableOptional
questionCountinteger · int32 | nullableOptional
responseLimitPerUserinteger · int32 | nullableOptional
surveyFormDurationMinutesinteger · int32 | nullableOptional
lastChangeTimestring · date-time | nullableOptional
surveyFormClosedstring · date-time | nullableOptional
surveyFormLockedstring · date-time | nullableOptional
surveyFormOpenedstring · date-time | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/forms/collect
200

OK

Counts the forms that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
lastChangeUserstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
surveyMessageInvitationstring · uuid | nullableOptional
surveyMessageResponseCompletedstring · uuid | nullableOptional
surveyMessageResponseConfirmedstring · uuid | nullableOptional
surveyMessageResponseStartedstring · uuid | nullableOptional
displaySummaryChartboolean | nullableOptional
enableUserConfidentialityboolean | nullableOptional
hasWorkflowConfigurationboolean | nullableOptional
requireUserAuthenticationboolean | nullableOptional
requireUserIdentificationboolean | nullableOptional
lastChangeTypestring | nullableOptional
surveyFormHookstring | nullableOptional
surveyFormLanguagestring | nullableOptional
surveyFormLanguageTranslationsstring | nullableOptional
surveyFormNamestring | nullableOptional
surveyFormStatusstring | nullableOptional
userFeedbackstring | nullableOptional
assetNumberinteger · int32 | nullableOptional
branchCountinteger · int32 | nullableOptional
conditionCountinteger · int32 | nullableOptional
pageCountinteger · int32 | nullableOptional
questionCountinteger · int32 | nullableOptional
responseLimitPerUserinteger · int32 | nullableOptional
surveyFormDurationMinutesinteger · int32 | nullableOptional
lastChangeTimestring · date-time | nullableOptional
surveyFormClosedstring · date-time | nullableOptional
surveyFormLockedstring · date-time | nullableOptional
surveyFormOpenedstring · date-time | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/forms/count
200

OK

Downloads the list of forms that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
lastChangeUserstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
surveyMessageInvitationstring · uuid | nullableOptional
surveyMessageResponseCompletedstring · uuid | nullableOptional
surveyMessageResponseConfirmedstring · uuid | nullableOptional
surveyMessageResponseStartedstring · uuid | nullableOptional
displaySummaryChartboolean | nullableOptional
enableUserConfidentialityboolean | nullableOptional
hasWorkflowConfigurationboolean | nullableOptional
requireUserAuthenticationboolean | nullableOptional
requireUserIdentificationboolean | nullableOptional
lastChangeTypestring | nullableOptional
surveyFormHookstring | nullableOptional
surveyFormLanguagestring | nullableOptional
surveyFormLanguageTranslationsstring | nullableOptional
surveyFormNamestring | nullableOptional
surveyFormStatusstring | nullableOptional
userFeedbackstring | nullableOptional
assetNumberinteger · int32 | nullableOptional
branchCountinteger · int32 | nullableOptional
conditionCountinteger · int32 | nullableOptional
pageCountinteger · int32 | nullableOptional
questionCountinteger · int32 | nullableOptional
responseLimitPerUserinteger · int32 | nullableOptional
surveyFormDurationMinutesinteger · int32 | nullableOptional
lastChangeTimestring · date-time | nullableOptional
surveyFormClosedstring · date-time | nullableOptional
surveyFormLockedstring · date-time | nullableOptional
surveyFormOpenedstring · date-time | nullableOptional
Responses
chevron-right
200

OK

No content

post
/api/workflow/forms/download
200

OK

No content

Searches for the list of forms that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
lastChangeUserstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
surveyMessageInvitationstring · uuid | nullableOptional
surveyMessageResponseCompletedstring · uuid | nullableOptional
surveyMessageResponseConfirmedstring · uuid | nullableOptional
surveyMessageResponseStartedstring · uuid | nullableOptional
displaySummaryChartboolean | nullableOptional
enableUserConfidentialityboolean | nullableOptional
hasWorkflowConfigurationboolean | nullableOptional
requireUserAuthenticationboolean | nullableOptional
requireUserIdentificationboolean | nullableOptional
lastChangeTypestring | nullableOptional
surveyFormHookstring | nullableOptional
surveyFormLanguagestring | nullableOptional
surveyFormLanguageTranslationsstring | nullableOptional
surveyFormNamestring | nullableOptional
surveyFormStatusstring | nullableOptional
userFeedbackstring | nullableOptional
assetNumberinteger · int32 | nullableOptional
branchCountinteger · int32 | nullableOptional
conditionCountinteger · int32 | nullableOptional
pageCountinteger · int32 | nullableOptional
questionCountinteger · int32 | nullableOptional
responseLimitPerUserinteger · int32 | nullableOptional
surveyFormDurationMinutesinteger · int32 | nullableOptional
lastChangeTimestring · date-time | nullableOptional
surveyFormClosedstring · date-time | nullableOptional
surveyFormLockedstring · date-time | nullableOptional
surveyFormOpenedstring · date-time | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/forms/search
200

OK

Retrieves one specific form option item

get
Authorizations
BearerstringRequired
Path parameters
surveyOptionItemstring · uuidRequired
itemstringRequired
Responses
chevron-right
200

OK

get
/api/workflow/forms-options-items/{item}
200

OK

Checks for the existence of one specific form option item

head
Authorizations
BearerstringRequired
Path parameters
surveyOptionItemstring · uuidRequired
itemstringRequired
Responses
chevron-right
200

OK

Responseboolean
head
/api/workflow/forms-options-items/{item}
200

OK

Collects the list of form option items that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
branchToQuestionIdentifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
surveyOptionListIdentifierstring · uuid | nullableOptional
surveyOptionItemCategorystring | nullableOptional
surveyOptionItemSequenceinteger · int32 | nullableOptional
surveyOptionItemPointsnumber · double | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/forms-options-items/collect
200

OK

Counts the form option items that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
branchToQuestionIdentifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
surveyOptionListIdentifierstring · uuid | nullableOptional
surveyOptionItemCategorystring | nullableOptional
surveyOptionItemSequenceinteger · int32 | nullableOptional
surveyOptionItemPointsnumber · double | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/forms-options-items/count
200

OK

Downloads the list of form option items that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
branchToQuestionIdentifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
surveyOptionListIdentifierstring · uuid | nullableOptional
surveyOptionItemCategorystring | nullableOptional
surveyOptionItemSequenceinteger · int32 | nullableOptional
surveyOptionItemPointsnumber · double | nullableOptional
Responses
chevron-right
200

OK

No content

post
/api/workflow/forms-options-items/download
200

OK

No content

Searches for the list of form option items that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
branchToQuestionIdentifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
surveyOptionListIdentifierstring · uuid | nullableOptional
surveyOptionItemCategorystring | nullableOptional
surveyOptionItemSequenceinteger · int32 | nullableOptional
surveyOptionItemPointsnumber · double | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/forms-options-items/search
200

OK

Retrieves one specific form option list

get
Authorizations
BearerstringRequired
Path parameters
surveyOptionListstring · uuidRequired
liststringRequired
Responses
chevron-right
200

OK

get
/api/workflow/forms-options-lists/{list}
200

OK

Checks for the existence of one specific form option list

head
Authorizations
BearerstringRequired
Path parameters
surveyOptionListstring · uuidRequired
liststringRequired
Responses
chevron-right
200

OK

Responseboolean
head
/api/workflow/forms-options-lists/{list}
200

OK

Collects the list of form option lists that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
surveyQuestionIdentifierstring · uuid | nullableOptional
surveyOptionListSequenceinteger · int32 | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/forms-options-lists/collect
200

OK

Counts the form option lists that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
surveyQuestionIdentifierstring · uuid | nullableOptional
surveyOptionListSequenceinteger · int32 | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/forms-options-lists/count
200

OK

Downloads the list of form option lists that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
surveyQuestionIdentifierstring · uuid | nullableOptional
surveyOptionListSequenceinteger · int32 | nullableOptional
Responses
chevron-right
200

OK

No content

post
/api/workflow/forms-options-lists/download
200

OK

No content

Searches for the list of form option lists that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
surveyQuestionIdentifierstring · uuid | nullableOptional
surveyOptionListSequenceinteger · int32 | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/forms-options-lists/search
200

OK

Retrieves one specific form question

get
Authorizations
BearerstringRequired
Path parameters
surveyQuestionstring · uuidRequired
questionstringRequired
Responses
chevron-right
200

OK

get
/api/workflow/forms-questions/{question}
200

OK

Checks for the existence of one specific form question

head
Authorizations
BearerstringRequired
Path parameters
surveyQuestionstring · uuidRequired
questionstringRequired
Responses
chevron-right
200

OK

Responseboolean
head
/api/workflow/forms-questions/{question}
200

OK

Collects the list of form questions that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
surveyFormIdentifierstring · uuid | nullableOptional
surveyQuestionIsNestedboolean | nullableOptional
surveyQuestionIsRequiredboolean | nullableOptional
surveyQuestionListEnableBranchboolean | nullableOptional
surveyQuestionListEnableGroupMembershipboolean | nullableOptional
surveyQuestionListEnableOtherTextboolean | nullableOptional
surveyQuestionListEnableRandomizationboolean | nullableOptional
surveyQuestionNumberEnableStatisticsboolean | nullableOptional
surveyQuestionAttributestring | nullableOptional
surveyQuestionCodestring | nullableOptional
surveyQuestionIndicatorstring | nullableOptional
surveyQuestionSourcestring | nullableOptional
surveyQuestionTypestring | nullableOptional
surveyQuestionSequenceinteger · int32 | nullableOptional
surveyQuestionTextCharacterLimitinteger · int32 | nullableOptional
surveyQuestionTextLineCountinteger · int32 | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/forms-questions/collect
200

OK

Counts the form questions that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
surveyFormIdentifierstring · uuid | nullableOptional
surveyQuestionIsNestedboolean | nullableOptional
surveyQuestionIsRequiredboolean | nullableOptional
surveyQuestionListEnableBranchboolean | nullableOptional
surveyQuestionListEnableGroupMembershipboolean | nullableOptional
surveyQuestionListEnableOtherTextboolean | nullableOptional
surveyQuestionListEnableRandomizationboolean | nullableOptional
surveyQuestionNumberEnableStatisticsboolean | nullableOptional
surveyQuestionAttributestring | nullableOptional
surveyQuestionCodestring | nullableOptional
surveyQuestionIndicatorstring | nullableOptional
surveyQuestionSourcestring | nullableOptional
surveyQuestionTypestring | nullableOptional
surveyQuestionSequenceinteger · int32 | nullableOptional
surveyQuestionTextCharacterLimitinteger · int32 | nullableOptional
surveyQuestionTextLineCountinteger · int32 | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/forms-questions/count
200

OK

Downloads the list of form questions that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
surveyFormIdentifierstring · uuid | nullableOptional
surveyQuestionIsNestedboolean | nullableOptional
surveyQuestionIsRequiredboolean | nullableOptional
surveyQuestionListEnableBranchboolean | nullableOptional
surveyQuestionListEnableGroupMembershipboolean | nullableOptional
surveyQuestionListEnableOtherTextboolean | nullableOptional
surveyQuestionListEnableRandomizationboolean | nullableOptional
surveyQuestionNumberEnableStatisticsboolean | nullableOptional
surveyQuestionAttributestring | nullableOptional
surveyQuestionCodestring | nullableOptional
surveyQuestionIndicatorstring | nullableOptional
surveyQuestionSourcestring | nullableOptional
surveyQuestionTypestring | nullableOptional
surveyQuestionSequenceinteger · int32 | nullableOptional
surveyQuestionTextCharacterLimitinteger · int32 | nullableOptional
surveyQuestionTextLineCountinteger · int32 | nullableOptional
Responses
chevron-right
200

OK

No content

post
/api/workflow/forms-questions/download
200

OK

No content

Searches for the list of form questions that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid | nullableOptional
organizationIdentifierstring · uuid | nullableOptional
surveyFormIdentifierstring · uuid | nullableOptional
surveyQuestionIsNestedboolean | nullableOptional
surveyQuestionIsRequiredboolean | nullableOptional
surveyQuestionListEnableBranchboolean | nullableOptional
surveyQuestionListEnableGroupMembershipboolean | nullableOptional
surveyQuestionListEnableOtherTextboolean | nullableOptional
surveyQuestionListEnableRandomizationboolean | nullableOptional
surveyQuestionNumberEnableStatisticsboolean | nullableOptional
surveyQuestionAttributestring | nullableOptional
surveyQuestionCodestring | nullableOptional
surveyQuestionIndicatorstring | nullableOptional
surveyQuestionSourcestring | nullableOptional
surveyQuestionTypestring | nullableOptional
surveyQuestionSequenceinteger · int32 | nullableOptional
surveyQuestionTextCharacterLimitinteger · int32 | nullableOptional
surveyQuestionTextLineCountinteger · int32 | nullableOptional
Responses
chevron-right
200

OK

post
/api/workflow/forms-questions/search
200

OK

Last updated

Was this helpful?