Skip to content

Create ReportQueueSchedule

Request

Creates a new ReportQueueSchedule

Security
apiKeyAuth and bearerAuth
Headers
vbasoftware-databasestringrequired

Target database

Bodyapplication/jsonrequired
reportQueueSchedule_Keyinteger, (int32)required

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_Addressstring or null, <= 128 characters

Optional field for storing the associated email address

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

event_IDinteger, (int32)required

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_Keyinteger, (int32)required

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_Locationstring or null, <= 256 characters

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

schedule_Typestring or null, <= 16 characters

Optional field for storing the type of report schedule

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

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

Responses

Success

Bodyapplication/json
dataobject
errorobject
debugobject
Response
{
  "data": { … },
  "error": { … },
  "debug": { … }
}