Report Series Processes

Create ReportSeriesProcess

Creates a new ReportSeriesProcess

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reportSeriesProcess_Key
required
integer <int32>

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

description
string or null <= 512 characters

Description of the report series process.

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

note_Category
string or null <= 8 characters

Indicates which category notes for this report series will be assigned.

pA_Stored_Proc
string or null <= 256 characters

Name of the stored procedure that corresponds to the Report Series used in VBAReport.

trigger_Description
string or null <= 2056 characters

Description of how the report series will trigger.

trigger_Option
string or null <= 64 characters

This flag enables an option used by Process Automation.

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-processes
Request samples
{
  • "reportSeriesProcess_Key": 0,
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "note_Category": "string",
  • "pA_Stored_Proc": "string",
  • "trigger_Description": "string",
  • "trigger_Option": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ReportSeriesProcess

Lists all ReportSeriesProcess

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-processes
Request samples 
Response samples 
No sample
Get ReportSeriesProcess
Gets ReportSeriesProcess


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportSeriesProcessKey
required
integer <int32> 
ReportSeriesProcess Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/report-series-processes/{reportSeriesProcessKey}
Request samples 
Response samples 
No sample
Update ReportSeriesProcess
Updates a specific ReportSeriesProcess.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportSeriesProcessKey
required
integer <int32> 
ReportSeriesProcess Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
reportSeriesProcess_Key
required
integer <int32> 
ID of the report series process. Note: This field is marked as NOT NULL in the database and therefore required by the API.


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


 
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


 
note_Category
string or null  <= 8 characters 
Indicates which category notes for this report series will be assigned.


 
pA_Stored_Proc
string or null  <= 256 characters 
Name of the stored procedure that corresponds to the Report Series used in VBAReport.


 
trigger_Description
string or null  <= 2056 characters 
Description of how the report series will trigger.


 
trigger_Option
string or null  <= 64 characters 
This flag enables an option used by Process Automation.


 
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-processes/{reportSeriesProcessKey}
Request samples 
{
  • "reportSeriesProcess_Key": 0,
  • "description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "note_Category": "string",
  • "pA_Stored_Proc": "string",
  • "trigger_Description": "string",
  • "trigger_Option": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ReportSeriesProcess
Deletes an ReportSeriesProcess


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportSeriesProcessKey
required
integer <int32> 
ReportSeriesProcess Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/report-series-processes/{reportSeriesProcessKey}
Request samples 
Create or Update Batch ReportSeriesProcess
Create or Update multiple ReportSeriesProcess 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 
reportSeriesProcess_Key
required
integer <int32> 
ID of the report series process. Note: This field is marked as NOT NULL in the database and therefore required by the API.


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


 
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


 
note_Category
string or null  <= 8 characters 
Indicates which category notes for this report series will be assigned.


 
pA_Stored_Proc
string or null  <= 256 characters 
Name of the stored procedure that corresponds to the Report Series used in VBAReport.


 
trigger_Description
string or null  <= 2056 characters 
Description of how the report series will trigger.


 
trigger_Option
string or null  <= 64 characters 
This flag enables an option used by Process Automation.


 
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-processes-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}