Report Queue Logs

Create ReportQueueLog

Creates a new ReportQueueLog

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reportQueueLog_Key
required
integer <int32>

Key field identifying a specific report queue log entry Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

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_Action
string or null <= 256 characters

Identifier of the action that was performed for a report or for queue maintenance

log_Date
string or null <date-time>

Date of the action that was performed for a report or for queue maintenance

log_Message
string or null <= 4000 characters

Message associated with the action that was performed for a report or for queue maintenance

log_Result
string or null <= 256 characters

Result of the action that was performed for a report or for queue maintenance

reportQueueDetail_Key
required
integer <int32>

ID of the report queue detail Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

sharedObject_ID
required
integer <int32>

Allows the logging of IDs for any shared objects for the report. Not normally used. Note: The database will apply a default value of 0 for this field if a value is not provided. This field is also marked as NOT NULL in the database and therefore required by the API. If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.

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/report-queue-logs
Request samples
{
  • "reportQueueLog_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "log_Action": "string",
  • "log_Date": "2019-08-24T14:15:22Z",
  • "log_Message": "string",
  • "log_Result": "string",
  • "reportQueueDetail_Key": 0,
  • "sharedObject_ID": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ReportQueueLog

Lists all ReportQueueLog

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
reportQueueDetailKey
integer <int32>

Filter by ReportQueueDetail_Key

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/report-queue-logs
Request samples 
Response samples 
No sample
Get ReportQueueLog
Gets ReportQueueLog


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportQueueLogKey
required
integer <int32> 
ReportQueueLog Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/report-queue-logs/{reportQueueLogKey}
Request samples 
Response samples 
No sample
Update ReportQueueLog
Updates a specific ReportQueueLog.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportQueueLogKey
required
integer <int32> 
ReportQueueLog Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
reportQueueLog_Key
required
integer <int32> 
Key field identifying a specific report queue log entry  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
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_Action
string or null  <= 256 characters 
Identifier of the action that was performed for a report or for queue maintenance


 
log_Date
string or null <date-time> 
Date of the action that was performed for a report or for queue maintenance


 
log_Message
string or null  <= 4000 characters 
Message associated with the action that was performed for a report or for queue maintenance


 
log_Result
string or null  <= 256 characters 
Result of the action that was performed for a report or for queue maintenance


 
reportQueueDetail_Key
required
integer <int32> 
ID of the report queue detail  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
sharedObject_ID
required
integer <int32> 
Allows the logging of IDs for any shared objects for the report. Not normally used.  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
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/report-queue-logs/{reportQueueLogKey}
Request samples 
{
  • "reportQueueLog_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "log_Action": "string",
  • "log_Date": "2019-08-24T14:15:22Z",
  • "log_Message": "string",
  • "log_Result": "string",
  • "reportQueueDetail_Key": 0,
  • "sharedObject_ID": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ReportQueueLog
Deletes an ReportQueueLog


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportQueueLogKey
required
integer <int32> 
ReportQueueLog Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/report-queue-logs/{reportQueueLogKey}
Request samples 
Create or Update Batch ReportQueueLog
Create or Update multiple ReportQueueLog 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 
reportQueueLog_Key
required
integer <int32> 
Key field identifying a specific report queue log entry  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
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_Action
string or null  <= 256 characters 
Identifier of the action that was performed for a report or for queue maintenance


 
log_Date
string or null <date-time> 
Date of the action that was performed for a report or for queue maintenance


 
log_Message
string or null  <= 4000 characters 
Message associated with the action that was performed for a report or for queue maintenance


 
log_Result
string or null  <= 256 characters 
Result of the action that was performed for a report or for queue maintenance


 
reportQueueDetail_Key
required
integer <int32> 
ID of the report queue detail  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
sharedObject_ID
required
integer <int32> 
Allows the logging of IDs for any shared objects for the report. Not normally used.  Note: The database will apply a default value of 0 for this field if a value is not provided.  This field is also marked as NOT NULL in the database and therefore required by the API.  If you do not have a value for this field, supply the database default value of 0 to meet the API requirements and ensure that the functionality occurs as expected.


 
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/report-queue-logs-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}