Workflow
- 23 May 2023
- 1 Minute to read
- Contributors
- Print
- DarkLight
Workflow
- Updated on 23 May 2023
- 1 Minute to read
- Contributors
- Print
- DarkLight
Article Summary
Share feedback
Thanks for sharing your feedback!
GET /Workflow/{id}/GetFormInstanceWorkflow
Get workflow information for the current form instance.
Route Parameters
| Parameter | Type | Description |
|---|---|---|
| id* | Guid | The workflow id. |
Response Codes
| Code | Description |
|---|---|
| 200 | OK |
POST /Workflow/{id}/CreateWorkflowTask
Create a new workflow task.
Route Parameters
| Parameter | Type | Description |
|---|---|---|
| id* | Guid | The workflow id. |
Body Parameters
| Parameter | Type | Description |
|---|---|---|
| userList | {UserListExample} | List of users. |
| negativeOutcomeOption | Int | Option for a negative result
|
| returnToSeq | Int | Number of the sequence to return to. |
| insertTaskLocation | Int | Sequence to insert the new task. |
| taskDescription | String | Description of the new task. |
| dueDate | datetime | Date the task is due. |
| returnToSequenceType | Int | The sequence return type.
|
| taskType | Int | The type of task.
|
| queueModeTask | Bool | Set queue mode for the task? |
GET /Workflow/FormTemplate
Get the workflow information for a form template.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| name* | String | The name of the form (DocID). |
GET /Workflow/Initialize
Initialize a configured workflow.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| formId* | Guid | Id of the form. |
GET /Workflow/GetTaskForUser
Get any current workflow tasks for a user.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | String | The form ID. |
POST /Workflow/CompleteTask
Complete a workflow task.
Body Parameters
| Parameter | Type | Description |
|---|---|---|
| formId* | Guid | The form ID if this call originates from an Upload Button form control. |
| wfid* | Guid | Workflow ID. |
| waid* | Guid | Workflow assignment ID. |
| taskApproval* | String | Task approval type.
|
| comment | String | A comment for the completed task. |
| password | String | The task password. |
POST /Workflow/CompleteTask
Complete a workflow task.
Body Parameters
| Parameter | Type | Description |
|---|---|---|
| formId* | Guid | The form ID if this call originates from an Upload Button form control. |
| wfid* | Guid | Workflow ID. |
| waid* | Guid | Workflow assignment ID. |
| taskApproval* | String | Task approval type.
|
| comment | String | A comment for the completed task. |
| password | String | The task password. |
Was this article helpful?
