Report Queue Schedules

Create ReportQueueSchedule

Creates a new ReportQueueSchedule

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reportQueueSchedule_Key
required
integer <int32>

Key field identifying a specific report queue schedule 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.

email_Address
string or null <= 128 characters

Optional field for storing the associated email address

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

ID of the report event that will be performed 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.

reportQueue_Key
required
integer <int32>

ID of the report queue. 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.

save_Location
string or null <= 256 characters

Optional field for storing the location where the report will be saved

schedule_Type
string or null <= 16 characters

Optional field for storing the type of report schedule

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-schedules
Request samples
{
  • "reportQueueSchedule_Key": 0,
  • "email_Address": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "event_ID": 0,
  • "reportQueue_Key": 0,
  • "save_Location": "string",
  • "schedule_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ReportQueueSchedule

Lists all ReportQueueSchedule

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
reportQueueKey
integer <int32>

Filter by ReportQueue_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-schedules
Request samples 
Response samples 
No sample
Get ReportQueueSchedule
Gets ReportQueueSchedule


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportQueueScheduleKey
required
integer <int32> 
ReportQueueSchedule Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/report-queue-schedules/{reportQueueScheduleKey}
Request samples 
Response samples 
No sample
Update ReportQueueSchedule
Updates a specific ReportQueueSchedule.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportQueueScheduleKey
required
integer <int32> 
ReportQueueSchedule Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
reportQueueSchedule_Key
required
integer <int32> 
Key field identifying a specific report queue schedule  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.


 
email_Address
string or null  <= 128 characters 
Optional field for storing the associated email address


 
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
required
integer <int32> 
ID of the report event that will be performed  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.


 
reportQueue_Key
required
integer <int32> 
ID of the report queue.  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.


 
save_Location
string or null  <= 256 characters 
Optional field for storing the location where the report will be saved


 
schedule_Type
string or null  <= 16 characters 
Optional field for storing the type of report schedule


 
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-schedules/{reportQueueScheduleKey}
Request samples 
{
  • "reportQueueSchedule_Key": 0,
  • "email_Address": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "event_ID": 0,
  • "reportQueue_Key": 0,
  • "save_Location": "string",
  • "schedule_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ReportQueueSchedule
Deletes an ReportQueueSchedule


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportQueueScheduleKey
required
integer <int32> 
ReportQueueSchedule Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/report-queue-schedules/{reportQueueScheduleKey}
Request samples 
Create or Update Batch ReportQueueSchedule
Create or Update multiple ReportQueueSchedule 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 
reportQueueSchedule_Key
required
integer <int32> 
Key field identifying a specific report queue schedule  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.


 
email_Address
string or null  <= 128 characters 
Optional field for storing the associated email address


 
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
required
integer <int32> 
ID of the report event that will be performed  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.


 
reportQueue_Key
required
integer <int32> 
ID of the report queue.  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.


 
save_Location
string or null  <= 256 characters 
Optional field for storing the location where the report will be saved


 
schedule_Type
string or null  <= 16 characters 
Optional field for storing the type of report schedule


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