Workflow
  • 23 May 2023
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Workflow

  • Dark
    Light

Article summary


 GET   /Workflow/{id}/GetFormInstanceWorkflow


Get workflow information for the current form instance.

Route Parameters
ParameterTypeDescription
id*GuidThe workflow id.
Response Codes
CodeDescription
200OK


 POST   /Workflow/{id}/CreateWorkflowTask


Create a new workflow task.

Route Parameters
ParameterTypeDescription
id*GuidThe workflow id.
Body Parameters
ParameterTypeDescription
userList{UserListExample}List of users.
negativeOutcomeOptionIntOption for a negative result
  • Continue (0)
  • EndWorkflow (1)
  • ReturnToSeq (2)
returnToSeqIntNumber of the sequence to return to.
insertTaskLocationIntSequence to insert the new task.
taskDescriptionStringDescription of the new task.
dueDatedatetimeDate the task is due.
returnToSequenceTypeIntThe sequence return type.
  • Originator (0)
  • User (1)
  • Sequence (2)
taskTypeIntThe type of task.
  • Serial (0)
  • Approval (1)
queueModeTaskBoolSet queue mode for the task?


 GET   /Workflow/FormTemplate


Get the workflow information for a form template.

Query Parameters
ParameterTypeDescription
name*StringThe name of the form (DocID).


 GET   /Workflow/Initialize


Initialize a configured workflow.

Query Parameters
ParameterTypeDescription
formId*GuidId of the form.


 GET   /Workflow/GetTaskForUser


Get any current workflow tasks for a user.

Query Parameters
ParameterTypeDescription
idStringThe form ID.


 POST   /Workflow/CompleteTask


Complete a workflow task.

Body Parameters
ParameterTypeDescription
formId*GuidThe form ID if this call originates from an Upload Button form control.
wfid*GuidWorkflow ID.
waid*GuidWorkflow assignment ID.
taskApproval*StringTask approval type.
  • Approve
  • Deny
commentStringA comment for the completed task.
passwordStringThe task password.


 POST   /Workflow/CompleteTask


Complete a workflow task.

Body Parameters
ParameterTypeDescription
formId*GuidThe form ID if this call originates from an Upload Button form control.
wfid*GuidWorkflow ID.
waid*GuidWorkflow assignment ID.
taskApproval*StringTask approval type.
  • Approve
  • Deny
commentStringA comment for the completed task.
passwordStringThe task password.

Was this article helpful?
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.
ESC

Eddy, a generative AI, facilitating knowledge discovery through conversational intelligence