Workflow Task Options

Create WorkflowTaskOption

Creates a new WorkflowTaskOption

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
workflowKey
required
integer <int32>

Workflow Key

workflowTaskSeq
required
integer <int32>

WorkflowTask Seq

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
workflow_Key
required
integer <int32>

Identifier of the workflow.

workflowTask_Seq
required
integer <int32>

Identifies the order of the associated task.

workflowTask_Option
required
string [ 1 .. 32 ] characters

Identifies the option to be used by the selected workflow task. These options will be specific to the workflow's 'Type'.

Responses
200

Success

401

Unauthorized

post/workflows/{workflowKey}/tasks/{workflowTaskSeq}/options
Request samples
{
  • "workflow_Key": 0,
  • "workflowTask_Seq": 0,
  • "workflowTask_Option": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List WorkflowTaskOption

Lists all WorkflowTaskOption for the given workflowKey and workflowTaskSeq

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
workflowKey
required
integer <int32>

Workflow Key

workflowTaskSeq
required
integer <int32>

WorkflowTask Seq

query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/workflows/{workflowKey}/tasks/{workflowTaskSeq}/options
Request samples 
Response samples 
No sample
Get WorkflowTaskOption
Gets WorkflowTaskOption


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
workflowKey
required
integer <int32> 
Workflow Key


 
workflowTaskSeq
required
integer <int32> 
WorkflowTask Seq


 
workflowTaskOption
required
string
WorkflowTask Option


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/workflows/{workflowKey}/tasks/{workflowTaskSeq}/options/{workflowTaskOption}
Request samples 
Response samples 
No sample
Delete WorkflowTaskOption
Deletes an WorkflowTaskOption


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
workflowKey
required
integer <int32> 
Workflow Key


 
workflowTaskSeq
required
integer <int32> 
WorkflowTask Seq


 
workflowTaskOption
required
string
WorkflowTask Option


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/workflows/{workflowKey}/tasks/{workflowTaskSeq}/options/{workflowTaskOption}
Request samples 
Create Batch WorkflowTaskOption
Create multiple WorkflowTaskOption at once.  If the entity does not exist, it will be created. If the entity does exist, an error message will be treturned.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
workflowKey
required
integer <int32> 
Workflow Key


 
workflowTaskSeq
required
integer <int32> 
WorkflowTask Seq


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
workflow_Key
required
integer <int32> 
Identifier of the workflow.


 
workflowTask_Seq
required
integer <int32> 
Identifies the order of the associated task.


 
workflowTask_Option
required
string  [ 1 .. 32 ] characters 
Identifies the option to be used by the selected workflow task. These options will be specific to the workflow's 'Type'.


 
Responses 
207
Success


401
Unauthorized


put/workflows/{workflowKey}/tasks/{workflowTaskSeq}/options-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}