Processes

Create VBAProcess

Creates a new VBAProcess

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
vbaProcess_Key
required
integer <int32>

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

vbaProcess_Type
required
string [ 1 .. 32 ] characters

Type used to determine the process that triggers.

description
string or null <= 512 characters

Description of the process.

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

process_End
string or null <date-time>

Date and time the process ended.

process_Result
string or null <= 32 characters

Result of the process.

process_Start
string or null <date-time>

Date and time the process started.

process_User
string or null <= 20 characters

User that started the process.

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/vbaprocesses
Request samples
{
  • "vbaProcess_Key": 0,
  • "vbaProcess_Type": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "process_End": "2019-08-24T14:15:22Z",
  • "process_Result": "string",
  • "process_Start": "2019-08-24T14:15:22Z",
  • "process_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

Get VBAProcess

Gets VBAProcess

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

VBAProcess Key

vBAProcessType
required
string

VBAProcess Type

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/vbaprocesses/{vBAProcessKey}/types/{vBAProcessType}
Request samples 
Response samples 
No sample
Update VBAProcess
Updates a specific VBAProcess.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
vBAProcessKey
required
integer <int32> 
VBAProcess Key


 
vBAProcessType
required
string
VBAProcess Type


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
vbaProcess_Type
required
string  [ 1 .. 32 ] characters 
Type used to determine the process that triggers.


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


 
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


 
process_End
string or null <date-time> 
Date and time the process ended.


 
process_Result
string or null  <= 32 characters 
Result of the process.


 
process_Start
string or null <date-time> 
Date and time the process started.


 
process_User
string or null  <= 20 characters 
User that started the process.


 
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/vbaprocesses/{vBAProcessKey}/types/{vBAProcessType}
Request samples 
{
  • "vbaProcess_Key": 0,
  • "vbaProcess_Type": "string",
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "process_End": "2019-08-24T14:15:22Z",
  • "process_Result": "string",
  • "process_Start": "2019-08-24T14:15:22Z",
  • "process_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete VBAProcess
Deletes an VBAProcess


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
vBAProcessKey
required
integer <int32> 
VBAProcess Key


 
vBAProcessType
required
string
VBAProcess Type


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/vbaprocesses/{vBAProcessKey}/types/{vBAProcessType}
Request samples