Workflow Tasks

Create WorkflowTask

Creates a new WorkflowTask

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

Workflow Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
workflow_Key
required
integer <int32>

Identifier of the workflow. Note: This field is marked as NOT NULL in the database and therefore required by the API.

workflowTask_Seq
required
integer <int32>

Identifies the order of the associated task. Note: This field is marked as NOT NULL in the database and therefore required by the API.

description
string or null <= 512 characters

Description of the associated task.

entry_Date
string <date-time>

Date record was first added to the system

entry_User
string or null <= 20 characters

User that first added the record to the system

update_Date
string <date-time>

Date the record was last updated in the system

update_User
string or null <= 20 characters

User that last updated the record in the system

Responses
200

Success

401

Unauthorized

post/workflows/{workflowKey}/tasks
Request samples
{
  • "workflow_Key": 0,
  • "workflowTask_Seq": 0,
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List WorkflowTask

Lists all WorkflowTask for the given workflowKey

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

Workflow Key

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
Request samples 
Response samples 
No sample
Get WorkflowTask
Gets WorkflowTask


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


 
Responses 
200
Success


401
Unauthorized


get/workflows/{workflowKey}/tasks/{workflowTaskSeq}
Request samples 
Response samples 
No sample
Update WorkflowTask
Updates a specific WorkflowTask.


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. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
workflowTask_Seq
required
integer <int32> 
Identifies the order of the associated task. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
description
string or null  <= 512 characters 
Description of the associated task.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
200
Success


401
Unauthorized


put/workflows/{workflowKey}/tasks/{workflowTaskSeq}
Request samples 
{
  • "workflow_Key": 0,
  • "workflowTask_Seq": 0,
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete WorkflowTask
Deletes an WorkflowTask


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


 
Responses 
204
Success


401
Unauthorized


delete/workflows/{workflowKey}/tasks/{workflowTaskSeq}
Request samples 
Create or Update Batch WorkflowTask
Create or Update multiple WorkflowTask at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
workflow_Key
required
integer <int32> 
Identifier of the workflow. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
workflowTask_Seq
required
integer <int32> 
Identifies the order of the associated task. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
description
string or null  <= 512 characters 
Description of the associated task.


 
entry_Date
string <date-time> 
Date record was first added to the system


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system


 
update_Date
string <date-time> 
Date the record was last updated in the system


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system


 
Responses 
207
Success


401
Unauthorized


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