Report Series Step Args

Create ReportSeriesStepArg

Creates a new ReportSeriesStepArg

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reportSeriesStepArg_Key
required
integer <int32>

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

argument_Name
string or null <= 256 characters

Name of the step argument.

argument_Type
string or null <= 32 characters

Identifies the type associated with the argument.

argument_Value
string or null <= 512 characters

The value of the 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

reportSeriesStep_Key
required
integer <int32>

ID of the report series step that the argument is associated with. 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-step-args
Request samples
{
  • "reportSeriesStepArg_Key": 0,
  • "argument_Name": "string",
  • "argument_Type": "string",
  • "argument_Value": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "reportSeriesStep_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ReportSeriesStepArg

Lists all ReportSeriesStepArg

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
reportSeriesStepKey
integer <int32>

Filter by ReportSeriesStep_Key

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-step-args
Request samples 
Response samples 
No sample
Get ReportSeriesStepArg
Gets ReportSeriesStepArg


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportSeriesStepArgKey
required
integer <int32> 
ReportSeriesStepArg Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/report-series-step-args/{reportSeriesStepArgKey}
Request samples 
Response samples 
No sample
Update ReportSeriesStepArg
Updates a specific ReportSeriesStepArg.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportSeriesStepArgKey
required
integer <int32> 
ReportSeriesStepArg Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
argument_Name
string or null  <= 256 characters 
Name of the step argument.


 
argument_Type
string or null  <= 32 characters 
Identifies the type associated with the argument.


 
argument_Value
string or null  <= 512 characters 
The value of the 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


 
reportSeriesStep_Key
required
integer <int32> 
ID of the report series step that the argument is associated with.  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-step-args/{reportSeriesStepArgKey}
Request samples 
{
  • "reportSeriesStepArg_Key": 0,
  • "argument_Name": "string",
  • "argument_Type": "string",
  • "argument_Value": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "reportSeriesStep_Key": 0,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ReportSeriesStepArg
Deletes an ReportSeriesStepArg


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportSeriesStepArgKey
required
integer <int32> 
ReportSeriesStepArg Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/report-series-step-args/{reportSeriesStepArgKey}
Request samples 
Create or Update Batch ReportSeriesStepArg
Create or Update multiple ReportSeriesStepArg 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 
reportSeriesStepArg_Key
required
integer <int32> 
ID of the report series step argument.  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.


 
argument_Name
string or null  <= 256 characters 
Name of the step argument.


 
argument_Type
string or null  <= 32 characters 
Identifies the type associated with the argument.


 
argument_Value
string or null  <= 512 characters 
The value of the 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


 
reportSeriesStep_Key
required
integer <int32> 
ID of the report series step that the argument is associated with.  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-step-args-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}