Report Series

Create ReportSeries

Creates a new ReportSeries

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reportSeries_Key
required
integer <int32>

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

series_Date
string or null <date-time>

Date when the automation will begin/began.

series_Description
string or null <= 512 characters

Description of the report series.

series_Status
string or null <= 32 characters

Identifies the current status of the report series.

series_Type
string or null <= 32 characters

Identifies the automation type for the report series.

series_User
string or null <= 16 characters

User ID of the person either initiating or running the report series

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-series
Request samples
{
  • "reportSeries_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "series_Date": "2019-08-24T14:15:22Z",
  • "series_Description": "string",
  • "series_Status": "string",
  • "series_Type": "string",
  • "series_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ReportSeries

Lists all ReportSeries

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
seriesType
string

Series Type (STANDARD | TEMPLATE)

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-series
Request samples 
Response samples 
No sample
List ReportSeries Users
Lists all ReportSeries


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-series-users
Request samples 
Response samples 
No sample
Get ReportSeries
Gets ReportSeries


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportSeriesKey
required
integer <int32> 
ReportSeries Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/report-series/{reportSeriesKey}
Request samples 
Response samples 
No sample
Update ReportSeries
Updates a specific ReportSeries.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportSeriesKey
required
integer <int32> 
ReportSeries Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
series_Date
string or null <date-time> 
Date when the automation will begin/began.


 
series_Description
string or null  <= 512 characters 
Description of the report series.


 
series_Status
string or null  <= 32 characters 
Identifies the current status of the report series.


 
series_Type
string or null  <= 32 characters 
Identifies the automation type for the report series.


 
series_User
string or null  <= 16 characters 
User ID of the person either initiating or running the report series


 
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-series/{reportSeriesKey}
Request samples 
{
  • "reportSeries_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "series_Date": "2019-08-24T14:15:22Z",
  • "series_Description": "string",
  • "series_Status": "string",
  • "series_Type": "string",
  • "series_User": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ReportSeries
Deletes an ReportSeries


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportSeriesKey
required
integer <int32> 
ReportSeries Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/report-series/{reportSeriesKey}
Request samples 
Create or Update Batch ReportSeries
Create or Update multiple ReportSeries 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 
reportSeries_Key
required
integer <int32> 
ID of the report series. 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


 
series_Date
string or null <date-time> 
Date when the automation will begin/began.


 
series_Description
string or null  <= 512 characters 
Description of the report series.


 
series_Status
string or null  <= 32 characters 
Identifies the current status of the report series.


 
series_Type
string or null  <= 32 characters 
Identifies the automation type for the report series.


 
series_User
string or null  <= 16 characters 
User ID of the person either initiating or running the report series


 
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-series-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}
Process Correspondence Tracking for Step Advanced API 
Given a specific ReportSeriesStep_Key, apply Correspondence Tracking if the Report on said step is trackable and the step has the appropriate tracking arguments.


SecurityapiKeyAuth and bearerAuth 
Request 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
reportSeriesStep_Key
integer <int32> 
 
report_File
string or null <byte> 
 
Responses 
200
Success


401
Unauthorized


post/process-correspondence-track-by-step
Request samples 
{
  • "reportSeriesStep_Key": 0,
  • "report_File": "string"
}
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}