Report Series Process Templates

Create ReportSeriesProcessTemplate

Creates a new ReportSeriesProcessTemplate

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reportSeriesProcessTemplate_Key
required
integer <int32>

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

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

reportSeriesProcess_Key
required
integer <int32>

ID of the report series process that the template is related to. 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.

reportSeries_Filter
string or null

Identifies the filter that is being applied to the series templates.

reportSeries_Key
required
integer <int32>

ID of the report series that the process template is related to. 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.

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-process-templates
Request samples
{
  • "reportSeriesProcessTemplate_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "reportSeriesProcess_Key": 0,
  • "reportSeries_Filter": "string",
  • "reportSeries_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ReportSeriesProcessTemplate

Lists all ReportSeriesProcessTemplate

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
reportSeriesKey
integer <int32>

Filter by reportSeriesKey

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-process-templates
Request samples 
Response samples 
No sample
Get ReportSeriesProcessTemplate
Gets ReportSeriesProcessTemplate


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportSeriesProcessTemplateKey
required
integer <int32> 
ReportSeriesProcessTemplate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/report-series-process-templates/{reportSeriesProcessTemplateKey}
Request samples 
Response samples 
No sample
Update ReportSeriesProcessTemplate
Updates a specific ReportSeriesProcessTemplate.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportSeriesProcessTemplateKey
required
integer <int32> 
ReportSeriesProcessTemplate Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
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


 
reportSeriesProcess_Key
required
integer <int32> 
ID of the report series process that the template is related to.  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.


 
reportSeries_Filter
string or null
Identifies the filter that is being applied to the series templates.


 
reportSeries_Key
required
integer <int32> 
ID of the report series that the process template is related to.  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.


 
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-process-templates/{reportSeriesProcessTemplateKey}
Request samples 
{
  • "reportSeriesProcessTemplate_Key": 0,
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "reportSeriesProcess_Key": 0,
  • "reportSeries_Filter": "string",
  • "reportSeries_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ReportSeriesProcessTemplate
Deletes an ReportSeriesProcessTemplate


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportSeriesProcessTemplateKey
required
integer <int32> 
ReportSeriesProcessTemplate Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/report-series-process-templates/{reportSeriesProcessTemplateKey}
Request samples 
Create or Update Batch ReportSeriesProcessTemplate
Create or Update multiple ReportSeriesProcessTemplate 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 
reportSeriesProcessTemplate_Key
required
integer <int32> 
ID of the report series process template.  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.


 
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


 
reportSeriesProcess_Key
required
integer <int32> 
ID of the report series process that the template is related to.  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.


 
reportSeries_Filter
string or null
Identifies the filter that is being applied to the series templates.


 
reportSeries_Key
required
integer <int32> 
ID of the report series that the process template is related to.  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.


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