Report Queue Details

Operations

Create ReportQueueDetail

Request

Creates a new ReportQueueDetail

Security

apiKeyAuth and bearerAuth

Path

reportQueueKeyinteger, (int32)required

ReportQueue Key

vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired

reportQueueDetail_Keyinteger, (int32)required

ID of the report queue detail. Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Datestring, (date-time)

Date record was first added to the system

entry_Userstring or null, <= 20 characters

User that first added the record to the system

queue_Export_File_Namestring or null, <= 128 characters

File Name of the file to export.

queue_Export_Typestring or null, <= 32 characters

Type of Export of the Queue.

queue_Filestring or null, (byte)

Used to store a file used by the Queue.

queue_Resultstring or null, <= 32 characters

Result code used when Queue completes.

queue_Result_Datestring or null, (date-time)

Date the Result was updated.

queue_XMLstring or null

Used to store XML used by the Queue.

reportDefinition_Keyinteger or null, (int32)

ID of the report definition.

reportQueue_Keyinteger, (int32)required

ID of the report queue. Note: This field is marked as NOT NULL in the database and therefore required by the API.

report_Librarystring or null, <= 128 characters

Identifies which report library the User wishes to choose from.

report_Objectstring or null, <= 64 characters

Indicates which report will be used with the automation step.

report_Save_Locationstring or null, <= 256 characters

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

report_Save_Typestring or null, <= 32 characters

File type used to save.

update_Datestring, (date-time)

Date the record was last updated in the system

update_Userstring or null, <= 20 characters

User that last updated the record in the system

vbaGateway_Document_Categorystring or null, <= 32 characters

Identifies which category the document belongs to.

vbaGateway_Document_Field1string or null, <= 64 characters

Field1 of the VBAGateway_Document.

vbaGateway_Document_Field2string or null, <= 64 characters

Field2 of the VBAGateway_Document.

vbaGateway_Document_Field3string or null, <= 64 characters

Field3 of the VBAGateway_Document.

vbaGateway_Document_Field4string or null, <= 64 characters

Field4 of the VBAGateway_Document.

vbaGateway_Document_Field5string or null, <= 64 characters

Field5 of the VBAGateway_Document.

vbaGateway_Document_Filestring or null, <= 256 characters

File of the VBAGateway_Document.

vbaGateway_Document_Folderstring or null, <= 256 characters

Folder of the VBAGateway_Document.

vbaGateway_Document_IDstring or null, <= 64 characters

Name of the document.

vbaGateway_Document_Labelstring or null, <= 256 characters

Short description of the document.

vbaGateway_Document_Typestring or null, <= 32 characters

Identifies the type associated with the document.

vbaGateway_Document_Value1string or null, <= 128 characters

Value1 of the VBAGateway_Document.

vbaGateway_Document_Value2string or null, <= 128 characters

Value2 of the VBAGateway_Document.

vbaGateway_Document_Value3string or null, <= 128 characters

Value3 of the VBAGateway_Document.

vbaGateway_Document_Value4string or null, <= 128 characters

Value4 of the VBAGateway_Document.

vbaGateway_Document_Value5string or null, <= 128 characters

Value5 of the VBAGateway_Document.

vbaGateway_UserIDstring or null, (uuid)

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

curl -i -X POST \
  'https://vbapi.vbasoftware.com/vbasoftware/report-queues/{reportQueueKey}/details' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'vbasoftware-database: string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "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"
  }'

Responses

Success

Bodyapplication/json

dataobject

errorobject

debugobject

Response

{
  "data": { … },
  "error": { … },
  "debug": { … }
}