Report Queue Details

Create ReportQueueDetail

Creates a new ReportQueueDetail

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

ReportQueue Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reportQueueDetail_Key
required
integer <int32>

ID of the report queue detail. 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_Export_File_Name
string or null <= 128 characters

File Name of the file to export.

queue_Export_Type
string or null <= 32 characters

Type of Export of the Queue.

queue_File
string or null <byte>

Used to store a file used by the Queue.

queue_Result
string or null <= 32 characters

Result code used when Queue completes.

queue_Result_Date
string or null <date-time>

Date the Result was updated.

queue_XML
string or null

Used to store XML used by the Queue.

reportDefinition_Key
integer or null <int32>

ID of the report definition.

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.

report_Library
string or null <= 128 characters

Identifies which report library the User wishes to choose from.

report_Object
string or null <= 64 characters

Indicates which report will be used with the automation step.

report_Save_Location
string or null <= 256 characters

Utilize the file explorer to choose a location where the report will be saved.

report_Save_Type
string or null <= 32 characters

File type used to save.

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

vbaGateway_Document_Category
string or null <= 32 characters

Identifies which category the document belongs to.

vbaGateway_Document_Field1
string or null <= 64 characters

Field1 of the VBAGateway_Document.

vbaGateway_Document_Field2
string or null <= 64 characters

Field2 of the VBAGateway_Document.

vbaGateway_Document_Field3
string or null <= 64 characters

Field3 of the VBAGateway_Document.

vbaGateway_Document_Field4
string or null <= 64 characters

Field4 of the VBAGateway_Document.

vbaGateway_Document_Field5
string or null <= 64 characters

Field5 of the VBAGateway_Document.

vbaGateway_Document_File
string or null <= 256 characters

File of the VBAGateway_Document.

vbaGateway_Document_Folder
string or null <= 256 characters

Folder of the VBAGateway_Document.

vbaGateway_Document_ID
string or null <= 64 characters

Name of the document.

vbaGateway_Document_Label
string or null <= 256 characters

Short description of the document.

vbaGateway_Document_Type
string or null <= 32 characters

Identifies the type associated with the document.

vbaGateway_Document_Value1
string or null <= 128 characters

Value1 of the VBAGateway_Document.

vbaGateway_Document_Value2
string or null <= 128 characters

Value2 of the VBAGateway_Document.

vbaGateway_Document_Value3
string or null <= 128 characters

Value3 of the VBAGateway_Document.

vbaGateway_Document_Value4
string or null <= 128 characters

Value4 of the VBAGateway_Document.

vbaGateway_Document_Value5
string or null <= 128 characters

Value5 of the VBAGateway_Document.

vbaGateway_UserID
string or null <uuid>

ID of the Gateway User who will receive the chosen document.

Responses
200

Success

401

Unauthorized

post/report-queues/{reportQueueKey}/details
Request samples
{
  • "reportQueueDetail_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "queue_Export_File_Name": "string",
  • "queue_Export_Type": "string",
  • "queue_File": "string",
  • "queue_Result": "string",
  • "queue_Result_Date": "2019-08-24T14:15:22Z",
  • "queue_XML": "string",
  • "reportDefinition_Key": 0,
  • "reportQueue_Key": 0,
  • "report_Library": "string",
  • "report_Object": "string",
  • "report_Save_Location": "string",
  • "report_Save_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "vbaGateway_Document_Category": "string",
  • "vbaGateway_Document_Field1": "string",
  • "vbaGateway_Document_Field2": "string",
  • "vbaGateway_Document_Field3": "string",
  • "vbaGateway_Document_Field4": "string",
  • "vbaGateway_Document_Field5": "string",
  • "vbaGateway_Document_File": "string",
  • "vbaGateway_Document_Folder": "string",
  • "vbaGateway_Document_ID": "string",
  • "vbaGateway_Document_Label": "string",
  • "vbaGateway_Document_Type": "string",
  • "vbaGateway_Document_Value1": "string",
  • "vbaGateway_Document_Value2": "string",
  • "vbaGateway_Document_Value3": "string",
  • "vbaGateway_Document_Value4": "string",
  • "vbaGateway_Document_Value5": "string",
  • "vbaGateway_UserID": "a8b19680-4553-4dc1-8618-a0ace7266c20"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ReportQueueDetail

Lists all ReportQueueDetail for the given reportQueueKey

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

ReportQueue Key

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/{reportQueueKey}/details
Request samples 
Response samples 
No sample
Get ReportQueueDetail
Gets ReportQueueDetail


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


 
reportQueueDetailKey
required
integer <int32> 
ReportQueueDetail Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


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


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


 
reportQueueDetailKey
required
integer <int32> 
ReportQueueDetail Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
reportQueueDetail_Key
required
integer <int32> 
ID of the report queue detail. 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_Export_File_Name
string or null  <= 128 characters 
File Name of the file to export.


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


 
queue_File
string or null <byte> 
Used to store a file used by the Queue.


 
queue_Result
string or null  <= 32 characters 
Result code used when Queue completes.


 
queue_Result_Date
string or null <date-time> 
Date the Result was updated.


 
queue_XML
string or null
Used to store XML used by the Queue.


 
reportDefinition_Key
integer or null <int32> 
ID of the report definition.


 
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.


 
report_Library
string or null  <= 128 characters 
Identifies which report library the User wishes to choose from.


 
report_Object
string or null  <= 64 characters 
Indicates which report will be used with the automation step.


 
report_Save_Location
string or null  <= 256 characters 
Utilize the file explorer to choose a location where the report will be saved.


 
report_Save_Type
string or null  <= 32 characters 
File type used to save.


 
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


 
vbaGateway_Document_Category
string or null  <= 32 characters 
Identifies which category the document belongs to.


 
vbaGateway_Document_Field1
string or null  <= 64 characters 
Field1 of the VBAGateway_Document.


 
vbaGateway_Document_Field2
string or null  <= 64 characters 
Field2 of the VBAGateway_Document.


 
vbaGateway_Document_Field3
string or null  <= 64 characters 
Field3 of the VBAGateway_Document.


 
vbaGateway_Document_Field4
string or null  <= 64 characters 
Field4 of the VBAGateway_Document.


 
vbaGateway_Document_Field5
string or null  <= 64 characters 
Field5 of the VBAGateway_Document.


 
vbaGateway_Document_File
string or null  <= 256 characters 
File of the VBAGateway_Document.


 
vbaGateway_Document_Folder
string or null  <= 256 characters 
Folder of the VBAGateway_Document.


 
vbaGateway_Document_ID
string or null  <= 64 characters 
Name of the document.


 
vbaGateway_Document_Label
string or null  <= 256 characters 
Short description of the document.


 
vbaGateway_Document_Type
string or null  <= 32 characters 
Identifies the type associated with the document.


 
vbaGateway_Document_Value1
string or null  <= 128 characters 
Value1 of the VBAGateway_Document.


 
vbaGateway_Document_Value2
string or null  <= 128 characters 
Value2 of the VBAGateway_Document.


 
vbaGateway_Document_Value3
string or null  <= 128 characters 
Value3 of the VBAGateway_Document.


 
vbaGateway_Document_Value4
string or null  <= 128 characters 
Value4 of the VBAGateway_Document.


 
vbaGateway_Document_Value5
string or null  <= 128 characters 
Value5 of the VBAGateway_Document.


 
vbaGateway_UserID
string or null <uuid> 
ID of the Gateway User who will receive the chosen document.


 
Responses 
200
Success


401
Unauthorized


put/report-queues/{reportQueueKey}/details/{reportQueueDetailKey}
Request samples 
{
  • "reportQueueDetail_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "queue_Export_File_Name": "string",
  • "queue_Export_Type": "string",
  • "queue_File": "string",
  • "queue_Result": "string",
  • "queue_Result_Date": "2019-08-24T14:15:22Z",
  • "queue_XML": "string",
  • "reportDefinition_Key": 0,
  • "reportQueue_Key": 0,
  • "report_Library": "string",
  • "report_Object": "string",
  • "report_Save_Location": "string",
  • "report_Save_Type": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "vbaGateway_Document_Category": "string",
  • "vbaGateway_Document_Field1": "string",
  • "vbaGateway_Document_Field2": "string",
  • "vbaGateway_Document_Field3": "string",
  • "vbaGateway_Document_Field4": "string",
  • "vbaGateway_Document_Field5": "string",
  • "vbaGateway_Document_File": "string",
  • "vbaGateway_Document_Folder": "string",
  • "vbaGateway_Document_ID": "string",
  • "vbaGateway_Document_Label": "string",
  • "vbaGateway_Document_Type": "string",
  • "vbaGateway_Document_Value1": "string",
  • "vbaGateway_Document_Value2": "string",
  • "vbaGateway_Document_Value3": "string",
  • "vbaGateway_Document_Value4": "string",
  • "vbaGateway_Document_Value5": "string",
  • "vbaGateway_UserID": "a8b19680-4553-4dc1-8618-a0ace7266c20"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ReportQueueDetail
Deletes an ReportQueueDetail


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


 
reportQueueDetailKey
required
integer <int32> 
ReportQueueDetail Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/report-queues/{reportQueueKey}/details/{reportQueueDetailKey}
Request samples 
Create or Update Batch ReportQueueDetail
Create or Update multiple ReportQueueDetail at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


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


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
reportQueueDetail_Key
required
integer <int32> 
ID of the report queue detail. 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_Export_File_Name
string or null  <= 128 characters 
File Name of the file to export.


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


 
queue_File
string or null <byte> 
Used to store a file used by the Queue.


 
queue_Result
string or null  <= 32 characters 
Result code used when Queue completes.


 
queue_Result_Date
string or null <date-time> 
Date the Result was updated.


 
queue_XML
string or null
Used to store XML used by the Queue.


 
reportDefinition_Key
integer or null <int32> 
ID of the report definition.


 
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.


 
report_Library
string or null  <= 128 characters 
Identifies which report library the User wishes to choose from.


 
report_Object
string or null  <= 64 characters 
Indicates which report will be used with the automation step.


 
report_Save_Location
string or null  <= 256 characters 
Utilize the file explorer to choose a location where the report will be saved.


 
report_Save_Type
string or null  <= 32 characters 
File type used to save.


 
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


 
vbaGateway_Document_Category
string or null  <= 32 characters 
Identifies which category the document belongs to.


 
vbaGateway_Document_Field1
string or null  <= 64 characters 
Field1 of the VBAGateway_Document.


 
vbaGateway_Document_Field2
string or null  <= 64 characters 
Field2 of the VBAGateway_Document.


 
vbaGateway_Document_Field3
string or null  <= 64 characters 
Field3 of the VBAGateway_Document.


 
vbaGateway_Document_Field4
string or null  <= 64 characters 
Field4 of the VBAGateway_Document.


 
vbaGateway_Document_Field5
string or null  <= 64 characters 
Field5 of the VBAGateway_Document.


 
vbaGateway_Document_File
string or null  <= 256 characters 
File of the VBAGateway_Document.


 
vbaGateway_Document_Folder
string or null  <= 256 characters 
Folder of the VBAGateway_Document.


 
vbaGateway_Document_ID
string or null  <= 64 characters 
Name of the document.


 
vbaGateway_Document_Label
string or null  <= 256 characters 
Short description of the document.


 
vbaGateway_Document_Type
string or null  <= 32 characters 
Identifies the type associated with the document.


 
vbaGateway_Document_Value1
string or null  <= 128 characters 
Value1 of the VBAGateway_Document.


 
vbaGateway_Document_Value2
string or null  <= 128 characters 
Value2 of the VBAGateway_Document.


 
vbaGateway_Document_Value3
string or null  <= 128 characters 
Value3 of the VBAGateway_Document.


 
vbaGateway_Document_Value4
string or null  <= 128 characters 
Value4 of the VBAGateway_Document.


 
vbaGateway_Document_Value5
string or null  <= 128 characters 
Value5 of the VBAGateway_Document.


 
vbaGateway_UserID
string or null <uuid> 
ID of the Gateway User who will receive the chosen document.


 
Responses 
207
Success


401
Unauthorized


put/report-queues/{reportQueueKey}/details-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}