Process Logging

Create VBAProcessLog

Creates a new VBAProcessLog

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
vbaProcessLog_Key
required
integer <int32>

Unique Identifier for the VBAProcessLog table 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

log_Message
string or null

Message provided from the process.

log_Reference_Column1
string or null <= 128 characters

A column that the log references.

log_Reference_Column2
string or null <= 128 characters

A column that the log references.

log_Reference_Column3
string or null <= 128 characters

A column that the log references.

log_Reference_Column4
string or null <= 128 characters

A column that the log references.

log_Reference_Column5
string or null <= 128 characters

A column that the log references.

log_Reference_Value1
string or null

A value that the log references.

log_Reference_Value2
string or null

A value that the log references.

log_Reference_Value3
string or null

A value that the log references.

log_Reference_Value4
string or null

A value that the log references.

log_Reference_Value5
string or null

A value that the log references.

log_Result
string or null <= 32 characters

Result of the process.

log_Type
string or null <= 32 characters

Type of 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

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.

Responses
200

Success

401

Unauthorized

post/vbaprocesses/{vBAProcessKey}/types/{vBAProcessType}/logs
Request samples
{
  • "vbaProcessLog_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "log_Message": "string",
  • "log_Reference_Column1": "string",
  • "log_Reference_Column2": "string",
  • "log_Reference_Column3": "string",
  • "log_Reference_Column4": "string",
  • "log_Reference_Column5": "string",
  • "log_Reference_Value1": "string",
  • "log_Reference_Value2": "string",
  • "log_Reference_Value3": "string",
  • "log_Reference_Value4": "string",
  • "log_Reference_Value5": "string",
  • "log_Result": "string",
  • "log_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "vbaProcess_Key": 0,
  • "vbaProcess_Type": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List VBAProcessLog

List VBAProcessLogs or the given VBAProcessKey and VBAProcessType

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}/logs
Request samples 
Response samples 
No sample
Get VBAProcessLog
Gets VBAProcessLog


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


 
vBAProcessType
required
string
VBAProcess Type


 
vBAProcessLogKey
required
integer <int32> 
VBAProcessLog Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


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


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


 
vBAProcessType
required
string
VBAProcess Type


 
vBAProcessLogKey
required
integer <int32> 
VBAProcessLog Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
vbaProcessLog_Key
required
integer <int32> 
Unique Identifier for the VBAProcessLog table 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


 
log_Message
string or null
Message provided from the process.


 
log_Reference_Column1
string or null  <= 128 characters 
A column that the log references.


 
log_Reference_Column2
string or null  <= 128 characters 
A column that the log references.


 
log_Reference_Column3
string or null  <= 128 characters 
A column that the log references.


 
log_Reference_Column4
string or null  <= 128 characters 
A column that the log references.


 
log_Reference_Column5
string or null  <= 128 characters 
A column that the log references.


 
log_Reference_Value1
string or null
A value that the log references.


 
log_Reference_Value2
string or null
A value that the log references.


 
log_Reference_Value3
string or null
A value that the log references.


 
log_Reference_Value4
string or null
A value that the log references.


 
log_Reference_Value5
string or null
A value that the log references.


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


 
log_Type
string or null  <= 32 characters 
Type of 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


 
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.


 
Responses 
200
Success


401
Unauthorized


put/vbaprocesses/{vBAProcessKey}/types/{vBAProcessType}/logs/{vBAProcessLogKey}
Request samples 
{
  • "vbaProcessLog_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "log_Message": "string",
  • "log_Reference_Column1": "string",
  • "log_Reference_Column2": "string",
  • "log_Reference_Column3": "string",
  • "log_Reference_Column4": "string",
  • "log_Reference_Column5": "string",
  • "log_Reference_Value1": "string",
  • "log_Reference_Value2": "string",
  • "log_Reference_Value3": "string",
  • "log_Reference_Value4": "string",
  • "log_Reference_Value5": "string",
  • "log_Result": "string",
  • "log_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "vbaProcess_Key": 0,
  • "vbaProcess_Type": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete VBAProcessLog
Deletes an VBAProcessLog


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


 
vBAProcessType
required
string
VBAProcess Type


 
vBAProcessLogKey
required
integer <int32> 
VBAProcessLog Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/vbaprocesses/{vBAProcessKey}/types/{vBAProcessType}/logs/{vBAProcessLogKey}
Request samples 
Update Batch VBAProcessLog
Updates or Creates multiple VBAProcessLogs


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
 Array 
vbaProcessLog_Key
required
integer <int32> 
Unique Identifier for the VBAProcessLog table 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


 
log_Message
string or null
Message provided from the process.


 
log_Reference_Column1
string or null  <= 128 characters 
A column that the log references.


 
log_Reference_Column2
string or null  <= 128 characters 
A column that the log references.


 
log_Reference_Column3
string or null  <= 128 characters 
A column that the log references.


 
log_Reference_Column4
string or null  <= 128 characters 
A column that the log references.


 
log_Reference_Column5
string or null  <= 128 characters 
A column that the log references.


 
log_Reference_Value1
string or null
A value that the log references.


 
log_Reference_Value2
string or null
A value that the log references.


 
log_Reference_Value3
string or null
A value that the log references.


 
log_Reference_Value4
string or null
A value that the log references.


 
log_Reference_Value5
string or null
A value that the log references.


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


 
log_Type
string or null  <= 32 characters 
Type of 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


 
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.


 
Responses 
207
Success


401
Unauthorized


put/vbaprocesses/{vBAProcessKey}/types/{vBAProcessType}/logs-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}