Workflow Details

Create WorkflowDetail

Creates a new WorkflowDetail

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
workflowDetail_Key
required
integer <int32>

Unique identifier for the workflow table. Note: This field is marked as NOT NULL in the database and therefore required by the API.

assign_Date
string or null <date-time>

Date when the workflow item was assigned.

assign_Message
string or null

Message that was given to the assignment.

assign_User_ID
string or null <= 20 characters

ID of the User who assigned the workflow item.

complete_Date
string or null <date-time>

Date when the workflow item was completed.

complete_Message
string or null

Message that was given to the completion.

complete_User_ID
string or null <= 20 characters

ID of the User who completed the workflow item.

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

event_ID
integer or null <int32>

No longer in use

key_Column1
string or null <= 128 characters

Defines the subject of 'Key_Value1'.

key_Column2
string or null <= 128 characters

Defines the subject of 'Key_Value2'.

key_Column3
string or null <= 128 characters

Defines the subject of 'Key_Value3'.

key_Column4
string or null <= 128 characters

Defines the subject of 'Key_Value4'.

key_Column5
string or null <= 128 characters

Defines the subject of 'Key_Value5'.

key_DataType1
string or null <= 32 characters

Identifies the type of data of the value specified by 'Key_Value1'.

key_DataType2
string or null <= 32 characters

Identifies the type of data of the value specified by 'Key_Value2'.

key_DataType3
string or null <= 32 characters

Identifies the type of data of the value specified by 'Key_Value3'.

key_DataType4
string or null <= 32 characters

Identifies the type of data of the value specified by 'Key_Value4'.

key_DataType5
string or null <= 32 characters

Identifies the type of data of the value specified by 'Key_Value5'.

key_Value1
string or null <= 128 characters

Value of the subject specified by 'Key_Column1'.

key_Value2
string or null <= 128 characters

Value of the subject specified by 'Key_Column2'.

key_Value3
string or null <= 128 characters

Value of the subject specified by 'Key_Column3'.

key_Value4
string or null <= 128 characters

Value of the subject specified by 'Key_Column4'.

key_Value5
string or null <= 128 characters

Value of the subject specified by 'Key_Column5'.

process_Date
string or null <date-time>

Date when the workflow item was processed.

process_Message
string or null

Message that was given to the process.

process_User_ID
string or null <= 20 characters

ID of the User who processed the workflow item.

reject_Date
string or null <date-time>

Date when the workflow item was rejected.

reject_Message
string or null

Message that was given to the rejection.

reject_User_ID
string or null <= 20 characters

ID of the User who rejected the workflow item.

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

user_ID
string or null <= 20 characters

ID of the User whom the workflow detail was assigned to.

workflowTask_Seq
integer or null <int32>

Sequential identifier for the workflow table.

workflow_Key
integer or null <int32>

Identifier of the workflow.

workflow_Type
string or null <= 32 characters

Type of the associated workflow.

Responses
200

Success

401

Unauthorized

post/workflow-details
Request samples
{
  • "workflowDetail_Key": 0,
  • "assign_Date": "2019-08-24T14:15:22Z",
  • "assign_Message": "string",
  • "assign_User_ID": "string",
  • "complete_Date": "2019-08-24T14:15:22Z",
  • "complete_Message": "string",
  • "complete_User_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "event_ID": 0,
  • "key_Column1": "string",
  • "key_Column2": "string",
  • "key_Column3": "string",
  • "key_Column4": "string",
  • "key_Column5": "string",
  • "key_DataType1": "string",
  • "key_DataType2": "string",
  • "key_DataType3": "string",
  • "key_DataType4": "string",
  • "key_DataType5": "string",
  • "key_Value1": "string",
  • "key_Value2": "string",
  • "key_Value3": "string",
  • "key_Value4": "string",
  • "key_Value5": "string",
  • "process_Date": "2019-08-24T14:15:22Z",
  • "process_Message": "string",
  • "process_User_ID": "string",
  • "reject_Date": "2019-08-24T14:15:22Z",
  • "reject_Message": "string",
  • "reject_User_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "user_ID": "string",
  • "workflowTask_Seq": 0,
  • "workflow_Key": 0,
  • "workflow_Type": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List WorkflowDetail

Lists all WorkflowDetail

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/workflow-details
Request samples 
Response samples 
No sample
Get WorkflowDetail
Gets WorkflowDetail


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
workflowDetailKey
required
integer <int32> 
WorkflowDetail Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/workflow-details/{workflowDetailKey}
Request samples 
Response samples 
No sample
Update WorkflowDetail
Updates a specific WorkflowDetail.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
workflowDetailKey
required
integer <int32> 
WorkflowDetail Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
workflowDetail_Key
required
integer <int32> 
Unique identifier for the workflow table. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
assign_Date
string or null <date-time> 
Date when the workflow item was assigned.


 
assign_Message
string or null
Message that was given to the assignment.


 
assign_User_ID
string or null  <= 20 characters 
ID of the User who assigned the workflow item.


 
complete_Date
string or null <date-time> 
Date when the workflow item was completed.


 
complete_Message
string or null
Message that was given to the completion.


 
complete_User_ID
string or null  <= 20 characters 
ID of the User who completed the workflow item.


 
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


 
event_ID
integer or null <int32> 
No longer in use


 
key_Column1
string or null  <= 128 characters 
Defines the subject of 'Key_Value1'.


 
key_Column2
string or null  <= 128 characters 
Defines the subject of 'Key_Value2'.


 
key_Column3
string or null  <= 128 characters 
Defines the subject of 'Key_Value3'.


 
key_Column4
string or null  <= 128 characters 
Defines the subject of 'Key_Value4'.


 
key_Column5
string or null  <= 128 characters 
Defines the subject of 'Key_Value5'.


 
key_DataType1
string or null  <= 32 characters 
Identifies the type of data of the value specified by 'Key_Value1'.


 
key_DataType2
string or null  <= 32 characters 
Identifies the type of data of the value specified by 'Key_Value2'.


 
key_DataType3
string or null  <= 32 characters 
Identifies the type of data of the value specified by 'Key_Value3'.


 
key_DataType4
string or null  <= 32 characters 
Identifies the type of data of the value specified by 'Key_Value4'.


 
key_DataType5
string or null  <= 32 characters 
Identifies the type of data of the value specified by 'Key_Value5'.


 
key_Value1
string or null  <= 128 characters 
Value of the subject specified by 'Key_Column1'.


 
key_Value2
string or null  <= 128 characters 
Value of the subject specified by 'Key_Column2'.


 
key_Value3
string or null  <= 128 characters 
Value of the subject specified by 'Key_Column3'.


 
key_Value4
string or null  <= 128 characters 
Value of the subject specified by 'Key_Column4'.


 
key_Value5
string or null  <= 128 characters 
Value of the subject specified by 'Key_Column5'.


 
process_Date
string or null <date-time> 
Date when the workflow item was processed.


 
process_Message
string or null
Message that was given to the process.


 
process_User_ID
string or null  <= 20 characters 
ID of the User who processed the workflow item.


 
reject_Date
string or null <date-time> 
Date when the workflow item was rejected.


 
reject_Message
string or null
Message that was given to the rejection.


 
reject_User_ID
string or null  <= 20 characters 
ID of the User who rejected the workflow item.


 
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


 
user_ID
string or null  <= 20 characters 
ID of the User whom the workflow detail was assigned to.


 
workflowTask_Seq
integer or null <int32> 
Sequential identifier for the workflow table.


 
workflow_Key
integer or null <int32> 
Identifier of the workflow.


 
workflow_Type
string or null  <= 32 characters 
Type of the associated workflow.


 
Responses 
200
Success


401
Unauthorized


put/workflow-details/{workflowDetailKey}
Request samples 
{
  • "workflowDetail_Key": 0,
  • "assign_Date": "2019-08-24T14:15:22Z",
  • "assign_Message": "string",
  • "assign_User_ID": "string",
  • "complete_Date": "2019-08-24T14:15:22Z",
  • "complete_Message": "string",
  • "complete_User_ID": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "event_ID": 0,
  • "key_Column1": "string",
  • "key_Column2": "string",
  • "key_Column3": "string",
  • "key_Column4": "string",
  • "key_Column5": "string",
  • "key_DataType1": "string",
  • "key_DataType2": "string",
  • "key_DataType3": "string",
  • "key_DataType4": "string",
  • "key_DataType5": "string",
  • "key_Value1": "string",
  • "key_Value2": "string",
  • "key_Value3": "string",
  • "key_Value4": "string",
  • "key_Value5": "string",
  • "process_Date": "2019-08-24T14:15:22Z",
  • "process_Message": "string",
  • "process_User_ID": "string",
  • "reject_Date": "2019-08-24T14:15:22Z",
  • "reject_Message": "string",
  • "reject_User_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "user_ID": "string",
  • "workflowTask_Seq": 0,
  • "workflow_Key": 0,
  • "workflow_Type": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete WorkflowDetail
Deletes an WorkflowDetail


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
workflowDetailKey
required
integer <int32> 
WorkflowDetail Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/workflow-details/{workflowDetailKey}
Request samples 
Create or Update Batch WorkflowDetail
Create or Update multiple WorkflowDetail 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 
workflowDetail_Key
required
integer <int32> 
Unique identifier for the workflow table. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
assign_Date
string or null <date-time> 
Date when the workflow item was assigned.


 
assign_Message
string or null
Message that was given to the assignment.


 
assign_User_ID
string or null  <= 20 characters 
ID of the User who assigned the workflow item.


 
complete_Date
string or null <date-time> 
Date when the workflow item was completed.


 
complete_Message
string or null
Message that was given to the completion.


 
complete_User_ID
string or null  <= 20 characters 
ID of the User who completed the workflow item.


 
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


 
event_ID
integer or null <int32> 
No longer in use


 
key_Column1
string or null  <= 128 characters 
Defines the subject of 'Key_Value1'.


 
key_Column2
string or null  <= 128 characters 
Defines the subject of 'Key_Value2'.


 
key_Column3
string or null  <= 128 characters 
Defines the subject of 'Key_Value3'.


 
key_Column4
string or null  <= 128 characters 
Defines the subject of 'Key_Value4'.


 
key_Column5
string or null  <= 128 characters 
Defines the subject of 'Key_Value5'.


 
key_DataType1
string or null  <= 32 characters 
Identifies the type of data of the value specified by 'Key_Value1'.


 
key_DataType2
string or null  <= 32 characters 
Identifies the type of data of the value specified by 'Key_Value2'.


 
key_DataType3
string or null  <= 32 characters 
Identifies the type of data of the value specified by 'Key_Value3'.


 
key_DataType4
string or null  <= 32 characters 
Identifies the type of data of the value specified by 'Key_Value4'.


 
key_DataType5
string or null  <= 32 characters 
Identifies the type of data of the value specified by 'Key_Value5'.


 
key_Value1
string or null  <= 128 characters 
Value of the subject specified by 'Key_Column1'.


 
key_Value2
string or null  <= 128 characters 
Value of the subject specified by 'Key_Column2'.


 
key_Value3
string or null  <= 128 characters 
Value of the subject specified by 'Key_Column3'.


 
key_Value4
string or null  <= 128 characters 
Value of the subject specified by 'Key_Column4'.


 
key_Value5
string or null  <= 128 characters 
Value of the subject specified by 'Key_Column5'.


 
process_Date
string or null <date-time> 
Date when the workflow item was processed.


 
process_Message
string or null
Message that was given to the process.


 
process_User_ID
string or null  <= 20 characters 
ID of the User who processed the workflow item.


 
reject_Date
string or null <date-time> 
Date when the workflow item was rejected.


 
reject_Message
string or null
Message that was given to the rejection.


 
reject_User_ID
string or null  <= 20 characters 
ID of the User who rejected the workflow item.


 
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


 
user_ID
string or null  <= 20 characters 
ID of the User whom the workflow detail was assigned to.


 
workflowTask_Seq
integer or null <int32> 
Sequential identifier for the workflow table.


 
workflow_Key
integer or null <int32> 
Identifier of the workflow.


 
workflow_Type
string or null  <= 32 characters 
Type of the associated workflow.


 
Responses 
207
Success


401
Unauthorized


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