Report Series Process Arguments

Create ReportSeriesProcessArg

Creates a new ReportSeriesProcessArg

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 to which the argument is related. Note: This field is marked as NOT NULL in the database and therefore required by the API.

argument_Name
required
string [ 1 .. 256 ] characters

Name for the report series process argument.

argument_Description
string or null <= 1024 characters

Description of the report series process argument.

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_Column
integer or null <int32>

Optional field for storing any additional notes about the report series process argument

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/{reportSeriesProcessKey}/arguments
Request samples
{
  • "reportSeriesProcess_Key": 0,
  • "argument_Name": "string",
  • "argument_Description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "note_Column": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ReportSeriesProcessArg

Lists all ReportSeriesProcessArg for the given reportSeriesProcessKey

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

ReportSeriesProcess Key

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/{reportSeriesProcessKey}/arguments
Request samples 
Response samples 
No sample
Get ReportSeriesProcessArg
Gets ReportSeriesProcessArg


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


 
argumentName
required
string
Argument Name


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


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


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


 
argumentName
required
string
Argument Name


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
argument_Name
required
string  [ 1 .. 256 ] characters 
Name for the report series process argument.


 
argument_Description
string or null  <= 1024 characters 
Description of the report series process argument.


 
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_Column
integer or null <int32> 
Optional field for storing any additional notes about the report series process argument


 
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}/arguments/{argumentName}
Request samples 
{
  • "reportSeriesProcess_Key": 0,
  • "argument_Name": "string",
  • "argument_Description": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "note_Column": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ReportSeriesProcessArg
Deletes an ReportSeriesProcessArg


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


 
argumentName
required
string
Argument Name


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/report-series-processes/{reportSeriesProcessKey}/arguments/{argumentName}
Request samples 
Create or Update Batch ReportSeriesProcessArg
Create or Update multiple ReportSeriesProcessArg at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


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


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
argument_Name
required
string  [ 1 .. 256 ] characters 
Name for the report series process argument.


 
argument_Description
string or null  <= 1024 characters 
Description of the report series process argument.


 
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_Column
integer or null <int32> 
Optional field for storing any additional notes about the report series process argument


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