Report Queues

Create ReportQueue

Creates a new ReportQueue

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reportQueue_Key
required
integer <int32>

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

queue_Date
string or null <date-time>

Date of the Queue.

queue_End
string or null <date-time>

End of the Queue.

queue_Printer
string or null <= 128 characters

Printer of the Queue.

queue_Priority
integer or null <int32>

Priority of the Queue.

queue_Start
string or null <date-time>

Start of the Queue.

queue_Status
string or null <= 32 characters

Status of the Queue.

queue_Type
string or null <= 32 characters

Type of the Queue.

queue_User
string or null <= 20 characters

User of the Queue.

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-queues
Request samples
{
  • "reportQueue_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "queue_Date": "2019-08-24T14:15:22Z",
  • "queue_End": "2019-08-24T14:15:22Z",
  • "queue_Printer": "string",
  • "queue_Priority": 0,
  • "queue_Start": "2019-08-24T14:15:22Z",
  • "queue_Status": "string",
  • "queue_Type": "string",
  • "queue_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ReportQueue

Lists all ReportQueue

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/report-queues
Request samples 
Response samples 
No sample
Get ReportQueue
Gets ReportQueue


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportQueueKey
required
integer <int32> 
ReportQueue Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/report-queues/{reportQueueKey}
Request samples 
Response samples 
No sample
Update ReportQueue
Updates a specific ReportQueue.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportQueueKey
required
integer <int32> 
ReportQueue Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
queue_Date
string or null <date-time> 
Date of the Queue.


 
queue_End
string or null <date-time> 
End of the Queue.


 
queue_Printer
string or null  <= 128 characters 
Printer of the Queue.


 
queue_Priority
integer or null <int32> 
Priority of the Queue.


 
queue_Start
string or null <date-time> 
Start of the Queue.


 
queue_Status
string or null  <= 32 characters 
Status of the Queue.


 
queue_Type
string or null  <= 32 characters 
Type of the Queue.


 
queue_User
string or null  <= 20 characters 
User of the Queue.


 
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-queues/{reportQueueKey}
Request samples 
{
  • "reportQueue_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "queue_Date": "2019-08-24T14:15:22Z",
  • "queue_End": "2019-08-24T14:15:22Z",
  • "queue_Printer": "string",
  • "queue_Priority": 0,
  • "queue_Start": "2019-08-24T14:15:22Z",
  • "queue_Status": "string",
  • "queue_Type": "string",
  • "queue_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ReportQueue
Deletes an ReportQueue


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportQueueKey
required
integer <int32> 
ReportQueue Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/report-queues/{reportQueueKey}
Request samples 
Create or Update Batch ReportQueue
Create or Update multiple ReportQueue 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 
reportQueue_Key
required
integer <int32> 
ID of the report queue. 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


 
queue_Date
string or null <date-time> 
Date of the Queue.


 
queue_End
string or null <date-time> 
End of the Queue.


 
queue_Printer
string or null  <= 128 characters 
Printer of the Queue.


 
queue_Priority
integer or null <int32> 
Priority of the Queue.


 
queue_Start
string or null <date-time> 
Start of the Queue.


 
queue_Status
string or null  <= 32 characters 
Status of the Queue.


 
queue_Type
string or null  <= 32 characters 
Type of the Queue.


 
queue_User
string or null  <= 20 characters 
User of the Queue.


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