Process Automation

Send Report Email

Sends an email with attached report

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
parentActivityId
string or null

Activity ID that spawned this

when
string or null <date-time>
object (CallbackDTO)
object (CallbackDTO)
reportId
string or null

ID of the Report

exportType
string or null

Export Type. Valid values are: Excel, Html, Pdf, Word, PPT, CSV

siteId
string or null

Client specific Site ID within the report server. This is typically their Client ID, but may be different based on client needs.

filename
string or null

Filename of the report.

object or null

An object of report parameters Required if a report requires them.

from
string or null

The sender of the email containing the report. This should be a valid email address.

recipients
Array of strings or null

All recipients of the email containing the report. Each entry should be a valid email address.

subject
string or null

Subject of the email for the report.

body
string or null

Body content of the email for the report.

Responses
200

Success

401

Unauthorized

post/process-automation/report/email
Request samples
{
  • "parentActivityId": "string",
  • "when": "2019-08-24T14:15:22Z",
  • "onSuccess": {
    },
  • "onFailure": {
    },
  • "reportId": "string",
  • "exportType": "string",
  • "siteId": "string",
  • "filename": "string",
  • "reportParameters": {
    },
  • "from": "string",
  • "recipients": [
    ],
  • "subject": "string",
  • "body": "string"
}
Response samples
{
  • "data": "string",
  • "error": {
    },
  • "debug": {
    }
}

Send Report Fax

Sends a report via fax

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
parentActivityId
string or null

Activity ID that spawned this

when
string or null <date-time>
object (CallbackDTO)
object (CallbackDTO)
reportId
string or null

ID of the Report

exportType
string or null

Export Type. Valid values are: Excel, Html, Pdf, Word, PPT, CSV

siteId
string or null

Client specific Site ID within the report server. This is typically their Client ID, but may be different based on client needs.

filename
string or null

Filename of the report.

object or null

A json object of report parameters Required if a report requires them.

faxNumber
string or null

Fax destination

Responses
200

Success

401

Unauthorized

post/process-automation/report/fax
Request samples
{
  • "parentActivityId": "string",
  • "when": "2019-08-24T14:15:22Z",
  • "onSuccess": {
    },
  • "onFailure": {
    },
  • "reportId": "string",
  • "exportType": "string",
  • "siteId": "string",
  • "filename": "string",
  • "reportParameters": {
    },
  • "faxNumber": "string"
}
Response samples
{
  • "data": "string",
  • "error": {
    },
  • "debug": {
    }
}

Send or schedule SMS

Sends or schedules an SMS

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
parentActivityId
string or null

Activity ID that spawned this

when
string or null <date-time>
object (CallbackDTO)
object (CallbackDTO)
senderClientId
string or null

The 3 chatacter ID for the Client to bill for the message

toNumber
string or null

The number to send the SMS

content
string or null

The content of the SMS

Responses
200

Success

401

Unauthorized

post/process-automation/sms
Request samples
{
  • "parentActivityId": "string",
  • "when": "2019-08-24T14:15:22Z",
  • "onSuccess": {
    },
  • "onFailure": {
    },
  • "senderClientId": "string",
  • "toNumber": "string",
  • "content": "string"
}
Response samples
{
  • "data": "string",
  • "error": {
    },
  • "debug": {
    }
}