---
title: "Workflow"
slug: "workflow-3"
updated: 2023-05-23T19:36:37Z
published: 2023-05-23T19:36:37Z
canonical: "docs.visualvault.com/workflow-3"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.visualvault.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Workflow

#### **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 - Continue (0) - EndWorkflow (1) - ReturnToSeq (2) |
| 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. - Originator (0) - User (1) - Sequence (2) |
| taskType | Int | The type of task. - Serial (0) - Approval (1) |
| 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. - Approve - Deny |
| 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. - Approve - Deny |
| comment | String | A comment for the completed task. |
| password | String | The task password. |