Workflow API: Submissions

Retrieves one specific submission

get
Authorizations
BearerstringRequired
Path parameters
responseSessionstring · uuidRequired
submissionstringRequired
Responses
chevron-right
200

OK

groupIdstring · uuid · nullableOptional
lastAnsweredQuestionIdstring · uuid · nullableOptional
lastChangeUserstring · uuidOptional
organizationIdstring · uuidOptional
periodIdstring · uuid · nullableOptional
respondentUserIdstring · uuidOptional
responseSessionIdstring · uuidOptional
surveyFormIdstring · uuidOptional
responseIsLockedbooleanOptional
lastChangeTypestring · nullableOptional
respondentLanguagestring · nullableOptional
responseSessionStatusstring · nullableOptional
lastChangeTimestring · date-timeOptional
responseSessionCompletedstring · date-time · nullableOptional
responseSessionCreatedstring · date-time · nullableOptional
responseSessionStartedstring · date-time · nullableOptional
get
/api/workflow/submissions/{submission}
200

OK

Checks for the existence of one specific submission

head
Authorizations
BearerstringRequired
Path parameters
responseSessionstring · uuidRequired
submissionstringRequired
Responses
chevron-right
200

OK

booleanOptional
head
/api/workflow/submissions/{submission}
200

OK

Collects the list of submissions that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
groupIdstring · uuid · nullableOptional
lastAnsweredQuestionIdstring · uuid · nullableOptional
lastChangeUserstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
periodIdstring · uuid · nullableOptional
respondentUserIdstring · uuid · nullableOptional
surveyFormIdstring · uuid · nullableOptional
responseIsLockedboolean · nullableOptional
lastChangeTypestring · nullableOptional
respondentLanguagestring · nullableOptional
responseSessionStatusstring · nullableOptional
lastChangeTimestring · date-time · nullableOptional
responseSessionCompletedstring · date-time · nullableOptional
responseSessionCreatedstring · date-time · nullableOptional
responseSessionStartedstring · date-time · nullableOptional
Responses
chevron-right
200

OK

groupIdstring · uuid · nullableOptional
lastAnsweredQuestionIdstring · uuid · nullableOptional
lastChangeUserstring · uuidOptional
organizationIdstring · uuidOptional
periodIdstring · uuid · nullableOptional
respondentUserIdstring · uuidOptional
responseSessionIdstring · uuidOptional
surveyFormIdstring · uuidOptional
responseIsLockedbooleanOptional
lastChangeTypestring · nullableOptional
respondentLanguagestring · nullableOptional
responseSessionStatusstring · nullableOptional
lastChangeTimestring · date-timeOptional
responseSessionCompletedstring · date-time · nullableOptional
responseSessionCreatedstring · date-time · nullableOptional
responseSessionStartedstring · date-time · nullableOptional
post
/api/workflow/submissions/collect
200

OK

Counts the submissions that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
groupIdstring · uuid · nullableOptional
lastAnsweredQuestionIdstring · uuid · nullableOptional
lastChangeUserstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
periodIdstring · uuid · nullableOptional
respondentUserIdstring · uuid · nullableOptional
surveyFormIdstring · uuid · nullableOptional
responseIsLockedboolean · nullableOptional
lastChangeTypestring · nullableOptional
respondentLanguagestring · nullableOptional
responseSessionStatusstring · nullableOptional
lastChangeTimestring · date-time · nullableOptional
responseSessionCompletedstring · date-time · nullableOptional
responseSessionCreatedstring · date-time · nullableOptional
responseSessionStartedstring · date-time · nullableOptional
Responses
chevron-right
200

OK

countinteger · int32Optional
summarystring · nullableOptional
post
/api/workflow/submissions/count
200

OK

Downloads the list of submissions that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
groupIdstring · uuid · nullableOptional
lastAnsweredQuestionIdstring · uuid · nullableOptional
lastChangeUserstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
periodIdstring · uuid · nullableOptional
respondentUserIdstring · uuid · nullableOptional
surveyFormIdstring · uuid · nullableOptional
responseIsLockedboolean · nullableOptional
lastChangeTypestring · nullableOptional
respondentLanguagestring · nullableOptional
responseSessionStatusstring · nullableOptional
lastChangeTimestring · date-time · nullableOptional
responseSessionCompletedstring · date-time · nullableOptional
responseSessionCreatedstring · date-time · nullableOptional
responseSessionStartedstring · date-time · nullableOptional
Responses
chevron-right
200

OK

No content

post
/api/workflow/submissions/download
200

OK

No content

Searches for the list of submissions that match specific criteria

post
Authorizations
BearerstringRequired
Body
identifierstring · uuid · nullableOptional
groupIdstring · uuid · nullableOptional
lastAnsweredQuestionIdstring · uuid · nullableOptional
lastChangeUserstring · uuid · nullableOptional
organizationIdstring · uuid · nullableOptional
periodIdstring · uuid · nullableOptional
respondentUserIdstring · uuid · nullableOptional
surveyFormIdstring · uuid · nullableOptional
responseIsLockedboolean · nullableOptional
lastChangeTypestring · nullableOptional
respondentLanguagestring · nullableOptional
responseSessionStatusstring · nullableOptional
lastChangeTimestring · date-time · nullableOptional
responseSessionCompletedstring · date-time · nullableOptional
responseSessionCreatedstring · date-time · nullableOptional
responseSessionStartedstring · date-time · nullableOptional
Responses
chevron-right
200

OK

responseSessionIdstring · uuidOptional
post
/api/workflow/submissions/search
200

OK

Last updated

Was this helpful?