Workflows

Create Workflow

Creates a new Workflow

SecurityapiKeyAuth and bearerAuth
Request
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.

criteria_Key
integer or null <int32>

Identifies the criteria associated with the workflow.

criteria_SQL
string or null

The SQL used to determine which claims fall under this workflow

description
string or null <= 512 characters

Description of the workflow.

disabled
required
boolean

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

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

last_Execute_Date
string or null <date-time>

Last time this Workflow was checked

prerequisite_Workflow_Key
integer or null <int32>

Identifies the workflow step that preceeds the selected step.

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

workflow_Type
string or null <= 32 characters

Identifies the service area associated with the workflow.

Responses
200

Success

401

Unauthorized

post/workflows
Request samples
{
  • "workflow_Key": 0,
  • "criteria_Key": 0,
  • "criteria_SQL": "string",
  • "description": "string",
  • "disabled": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "last_Execute_Date": "2019-08-24T14:15:22Z",
  • "prerequisite_Workflow_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "workflow_Type": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List Workflow

Lists all Workflow

SecurityapiKeyAuth and bearerAuth
Request
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
Request samples 
Response samples 
No sample
Get Workflow
Gets Workflow


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


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


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.


 
criteria_Key
integer or null <int32> 
Identifies the criteria associated with the workflow.


 
criteria_SQL
string or null
The SQL used to determine which claims fall under this workflow


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


 
disabled
required
boolean
Disables the selected workflow. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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


 
last_Execute_Date
string or null <date-time> 
Last time this Workflow was checked


 
prerequisite_Workflow_Key
integer or null <int32> 
Identifies the workflow step that preceeds the selected step.


 
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


 
workflow_Type
string or null  <= 32 characters 
Identifies the service area associated with the workflow.


 
Responses 
200
Success


401
Unauthorized


put/workflows/{workflowKey}
Request samples 
{
  • "workflow_Key": 0,
  • "criteria_Key": 0,
  • "criteria_SQL": "string",
  • "description": "string",
  • "disabled": true,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "last_Execute_Date": "2019-08-24T14:15:22Z",
  • "prerequisite_Workflow_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "workflow_Type": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete Workflow
Deletes an Workflow


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


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


SecurityapiKeyAuth and bearerAuth 
Request 
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.


 
criteria_Key
integer or null <int32> 
Identifies the criteria associated with the workflow.


 
criteria_SQL
string or null
The SQL used to determine which claims fall under this workflow


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


 
disabled
required
boolean
Disables the selected workflow. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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


 
last_Execute_Date
string or null <date-time> 
Last time this Workflow was checked


 
prerequisite_Workflow_Key
integer or null <int32> 
Identifies the workflow step that preceeds the selected step.


 
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


 
workflow_Type
string or null  <= 32 characters 
Identifies the service area associated with the workflow.


 
Responses 
207
Success


401
Unauthorized


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