REST API for Workflow Documentation

Assignments

GET api/v1/assignments
Summary
Gets a list of workflow tasks assigned to the logged in user
Parameters
- page - Page number to retrieve default value : 1
- page_size - Page size default value : 25
- sort - Field to sort by (specify '-' to sort in descending order)
Returns
GET api/v1/assignments/{1}/subwork/{2}/task/{3}
Summary
Gets specific information about the specified task
Parameters
- work_id(required) - Workflow ID
- subwork_id - Subworkflow ID default value : 0
- task_id(required) - TaskID
Returns
GET api/v1/assignments/{1}/subwork/{2}/task/{3}/accept
Summary
Accept the task on behalf of the user.
Parameters
- work_id(required) - Workflow ID
- subwork_id - Subworkflow ID default value : 0
- task_id(required) - TaskID
Returns
POST api/v1/assignments/{1}/subwork/{2}/task/{3}/complete
Summary
Completes the designated task with disposition or without disposition
Parameters
- work_id(required) - Workflow ID
- subwork_id - Subworkflow ID default value : 0
- task_id(required) - TaskID
- disposition - Disposition choice default value :
Returns
POST api/v1/assignments/{1}/subwork/{2}/task/{3}/delegate
Summary
Delegates a workflow task to another user.
Parameters
- work_id(required) - Workflow ID
- subwork_id - Subworkflow ID default value : 0
- task_id(required) - TaskID
- member_id(required) - User ID
Returns
POST api/v1/assignments/{1}/subwork/{2}/task/{3}/sendforreview
Summary
Sends the task for review to the identified user
Parameters
- work_id(required) - Workflow ID
- subwork_id - Subworkflow ID default value : 0
- task_id(required) - TaskID
- member_id(required) - User ID
- instructions - Task Instructions default value :
- title - Task Title default value :
- duration - Task Duration
- xAction - Internal flag - review default value : Review_sendon
Returns

Workflow

GET api/v1/workflow/{1}/context
Summary
This function loads the WF map, creates the temporary map holder, then saves the map * to cache so that subsequent functions can add attributes, attachments, or comments before * sending the task on.
Parameters
- map_id(required) - Workflow map ID
Returns
- data
  { contextID: Unique ID to set data to this Workflow before starting wfTitle: default title of workflow (can be changed prior to starting) }
- httpReturnCode
  200 if OK, 400 if error

GET api/v1/workflow/{1}/attrInfo

Summary
Gets information about the attributes available in this workflow, including its unique ID, its data type, maximum number of rows, and valid values (where applicable)

Parameters

context_id(required) - Context ID

Returns

data

{
   attributes: [list of available attributes]
   {
   DisplayName: Name of attribute, 
   ID: Unique ID of attribute, 
   MaxRows: max # of values that can be set,
   NumRows: number of rows by default, 
   Required: true if attribute required, 
   Values: [list of values for this attribute]
   }
}

httpReturnCode
```
200 if OK, 400 if error
```

GET api/v1/workflow/{1}/formInfo

Summary
Gets information about the available formsin this workflow, including form names, and field unique IDs and other field parameters

Parameters

context_id(required) - Context ID

Returns

data

forms: [list of all forms accessible from this task]
{
    formName : name of this form
    required : true if form is required, false otherwise
    fields : [list of all field definitions for this form]
    {
       DefaultValues: [List of default values, or a list with a single empty string if no defaults,
       DisplayName: Display name for field,
       Format: Date format (for date fields only),
       ID: Unique ID of field - use when setting values on form,
       MaxRows: Max # of values that the field can have,
       NumRows: default number of values that this field holds (usually 1),
       Required: true if field is required
       TimeField: for date fields only, true if date fields contains a time, false if it is just the calendar date,
       Values: list of values currently set in the form
    }
}

httpReturnCode
```
200 if OK, 400 if error
```

GET api/v1/workflow/{1}/attachmentFolder
Summary
Gets Data ID of attachments folder for this workflow.
Parameters
- context_id(required) - Context ID
Returns
- data
  none
- httpReturnCode
  200 if OK, 400 if error
GET api/v1/workflow/{1}/start
Summary
Starts the workflow for the context ID initialized previously. This command has both a GET and a POST implementation. For simple initiation, use GET. If the workflow title needs to change, use POST version and pass in 'wfTitle' param as a form argument.
Parameters
- context_id(required) - Context ID
- wfTitle - Workflow Title (POST version of request only)
Returns
- data
  { workID: ID of workflow just launched }
- httpReturnCode
  200 if OK, 400 if error
POST api/v1/workflow/{1}/start
Summary
Starts the workflow for the context ID initialized previously. This command has both a GET and a POST implementation. For simple initiation, use GET. If the workflow title needs to change, use POST version and pass in 'wfTitle' param as a form argument.
Parameters
- context_id(required) - Context ID
- wfTitle - Workflow Title (POST version of request only)
Returns
- data
  { workID: ID of workflow just launched }
- httpReturnCode
  200 if OK, 400 if error
POST api/v1/workflow/{1}/attributes
Summary
Saves attribute values contained within this request
Parameters
- context_id(required) - Context ID
Additional Parameter info
- attr_<x>_<y> - value to save to attributes package. x is the ID of the field, and y is the row (starting from 1). y can be no more than the max number of values that this field can hold.
Returns
- data
  none
- httpReturnCode
  200 if OK, 400 if error
POST api/v1/workflow/{1}/comments
Summary
Saves the comment contained within this request.
Parameters
- context_id(required) - Context ID
- comments - Comment default value :
Returns
- data
  none
- httpReturnCode
  200 if OK, 400 if error
POST api/v1/workflow/{1}/forms
Summary
Saves form values contained within this request to form named in this request
Parameters
- context_id(required) - Context ID
- formName(required) - Name of form to be saved
Additional Parameter info
- formName (required) - name of form as retrieved when fetching the forms package.
- field_<x>_<y> - value to save to form. x is the ID of the field, and y is the row (starting from 1). y can be no more than the max number of values that this field can hold.
Returns
- data
  none
- httpReturnCode
  200 if OK, 400 if error

Packages

GET api/v1/wfpackages/{1}/subwork/{2}/task/{3}/list
Summary
Gets a list of packages available from this workflow task.
Parameters
- work_id(required) - Workflow ID
- subwork_id - Subworkflow ID default value : 0
- task_id(required) - TaskID
Returns
GET api/v1/wfpackages/{1}/subwork/{2}/task/{3}/pkg/{4}
Summary
Gets all information for this package
Parameters
- work_id(required) - Workflow ID
- subwork_id - Subworkflow ID default value : 0
- task_id(required) - TaskID
- pkg_name(required) - Package name
Returns
POST api/v1/wfpackages/{1}/subwork/{2}/task/{3}/pkg/{4}
Summary
Saves the information in this request to the identified workflow package (comments, attributes, etc.).
Parameters
- work_id(required) - Workflow ID
- subwork_id - Subworkflow ID default value : 0
- task_id(required) - TaskID
- pkg_name(required) - Package name
Additional Parameter info The following are package-specific parameters
Comments Package
- Comments - Text to save to comments.
Attributes Package
- attr_<x>_<y> - value to save to attributes package. x is the ID of the field, and y is the row (starting from 1). y can be no more than the max number of values that this field can hold.
Forms Package
- formName (required) - name of form as retrieved when fetching the forms package.
- field_<x>_<y> - value to save to form. x is the ID of the field, and y is the row (starting from 1). y can be no more than the max number of values that this field can hold.
Returns

WorkStatus

GET api/v1/wfstatus/workflows
Summary
This function returns a list of workflows that the logged in user has either initiated or managed
Parameters
- page - Page of results to retrieve default value : 1
- page_size - Max number of results to return per page default value : 25
- sort - Sort results by column (add '-' to make it a descending sort)
- status_filter - Filters workflows on status. Valid options are 'active', and 'archived' default value : Active
- mgr_filter - Filters workflows on whether WF initated by user, managed by user or both default value : all
Returns
GET api/v1/wfstatus/workflow/{1}/subworkid/{2}/status
Summary
Retrieves specific data about this workflow/subworkflow
Parameters
- workID(required) - Workflow ID
- subworkID(required) - Sub-workflow ID (same as workID for master)
Returns
POST api/v1/wfstatus/workflow/{1}/subworkid/{2}/manage
Summary
Use this command to manage the workflow, i.e. suspending/resuming, stopping, deleting, etc. Only commands valid for the current workflow state will be accepted, and only if the user executing this command has sufficient permission to the workflow. Allowable commands are returned by call to status.
Parameters
- workID(required) - Workflow ID
- subworkID(required) - Sub-workflow ID (same as workID for master)
- command(required) - Command to execute as returend from allowedCommands in GET status
Returns