Report Series Steps

Create ReportSeriesStep

Creates a new ReportSeriesStep

SecurityapiKeyAuth and bearerAuth
Request
header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
reportSeriesStep_Key
required
integer <int32>

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

eMail_Body
string or null <= 4000 characters

Body text of the email.

eMail_From
string or null <= 128 characters

Identifies the sender email.

eMail_Server
string or null <= 128 characters

Indicates the server over which the email will be sent.

eMail_Subject
string or null <= 256 characters

Subject line of the email.

eMail_To
string or null <= 128 characters

Indentifies the receiver email.

end_Date
string or null <date-time>

Indicates the date when the event will stop occurring.

end_Option
integer or null <int32>

Indicates how the event will end.

end_Time
string or null <date-time>

Indicates at what time the event will cease to occur on the defined date(s).

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

event_Priority
string or null <= 32 characters

Indicates the priority of the event.

event_Processor
string or null <= 64 characters

PowerBuilder object used to process.

event_Subject
string or null <= 256 characters

Describes the subject of the event.

event_UserGroup_Key
integer or null <int32>

Identifies the Group that will be notified by the event.

event_User_ID
string or null <= 16 characters

Identifies the User who will be notified by the event.

frequency
integer or null <int32>

Month the event occurs.

frequency_Factor
integer or null <int32>

Day the event occurs.

friday
required
boolean

Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.

interval_Option
integer or null <int32>

Interval Options are Days, Weekdays, Day in Month, Relative Day in Month, Date, or date in Month.

monday
required
boolean

Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.

note_Category
string or null <= 8 characters

Identifies which category that the note belongs to.

note_Data
string or null <= 4000 characters

Body text of the note.

note_Subject
string or null <= 64 characters

Subject line of the note.

relative_Frequency
integer or null <int32>

Day of the week the event occurs.

reportDefinition_Key
integer or null <int32>

ID of the report definition utilized in this step.

reportSeries_Key
required
integer <int32>

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

report_Criteria_Object
string or null <= 64 characters

Object of the Report_Criteria.

report_Library
string or null <= 128 characters

Identifies which report library the User wishes to choose from.

report_Object
string or null <= 64 characters

Indicates which report will be used with the automation step.

report_Printer
string or null <= 128 characters

Indicates which method will be used to print the selected report.

report_Save_Location
string or null <= 256 characters

Folder the report is saved to.

retry
integer or null <int32>

Retry of the Retry. Note: The database will apply a default value of 0 for this field if a value is not provided.

saturday
required
boolean

Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.

schedule_Interval
integer or null <int32>

Indicates how often the event will occur. The interval will determine which options are available for the event schedule.

start_Date
string or null <date-time>

Indicates the date when the event will begin occurring by the defined recurrence options.

start_Time
string or null <date-time>

Indicates at what time the event will occur on the defined date(s).

step_Date
string or null <date-time>

Date when the step will occur.

step_Delay
integer or null <int32>

Identifies the number of the selected time period that the step will be delayed by.

step_Delay_Type
string or null <= 32 characters

Identifies the time period that the step will be delayed by.

step_Description
string or null <= 512 characters

Description of the report series step.

step_Key
integer or null <int32>

Field used to flag a record for processing by Process Automation.

step_MetaData
string or null <= 512 characters

Generic column to store meta data.

step_Seq
required
integer <int32>

Identifies the sequence number assigned to the step. This number dictates which order the report series steps will occur (ascending order). Note: This field is marked as NOT NULL in the database and therefore required by the API.

step_Type
string or null <= 32 characters

Identifies the type associated with this step.

sunday
required
boolean

Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.

thursday
required
boolean

Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.

total_Occurrences
integer or null <int32>

Number of occurrences that will take place before the event ends.

tuesday
required
boolean

Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.

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

vbaGateway_Document_Category
string or null <= 32 characters

Identifies which category the document belongs to.

vbaGateway_Document_Field1
string or null <= 64 characters

Field1 of the VBAGateway_Document.

vbaGateway_Document_Field2
string or null <= 64 characters

Field2 of the VBAGateway_Document.

vbaGateway_Document_Field3
string or null <= 64 characters

Field3 of the VBAGateway_Document.

vbaGateway_Document_Field4
string or null <= 64 characters

Field4 of the VBAGateway_Document.

vbaGateway_Document_Field5
string or null <= 64 characters

Field5 of the VBAGateway_Document.

vbaGateway_Document_File
string or null <= 256 characters

File of the VBAGateway_Document.

vbaGateway_Document_Folder
string or null <= 256 characters

Folder of the VBAGateway_Document.

vbaGateway_Document_ID
string or null <= 64 characters

Name of the document.

vbaGateway_Document_Label
string or null <= 256 characters

Short description of the document.

vbaGateway_Document_Type
string or null <= 32 characters

Identifies the type associated with the document.

vbaGateway_Document_Value1
string or null <= 128 characters

Value1 of the VBAGateway_Document.

vbaGateway_Document_Value2
string or null <= 128 characters

Value2 of the VBAGateway_Document.

vbaGateway_Document_Value3
string or null <= 128 characters

Value3 of the VBAGateway_Document.

vbaGateway_Document_Value4
string or null <= 128 characters

Value4 of the VBAGateway_Document.

vbaGateway_Document_Value5
string or null <= 128 characters

Value5 of the VBAGateway_Document.

vbaGateway_UserID
string or null <uuid>

ID of the Gateway User who will receive the chosen document.

wednesday
required
boolean

Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.

Responses
200

Success

401

Unauthorized

post/report-series-steps
Request samples
{
  • "reportSeriesStep_Key": 0,
  • "eMail_Body": "string",
  • "eMail_From": "string",
  • "eMail_Server": "string",
  • "eMail_Subject": "string",
  • "eMail_To": "string",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "end_Option": 0,
  • "end_Time": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "event_Priority": "string",
  • "event_Processor": "string",
  • "event_Subject": "string",
  • "event_UserGroup_Key": 0,
  • "event_User_ID": "string",
  • "frequency": 0,
  • "frequency_Factor": 0,
  • "friday": true,
  • "interval_Option": 0,
  • "monday": true,
  • "note_Category": "string",
  • "note_Data": "string",
  • "note_Subject": "string",
  • "relative_Frequency": 0,
  • "reportDefinition_Key": 0,
  • "reportSeries_Key": 0,
  • "report_Criteria_Object": "string",
  • "report_Library": "string",
  • "report_Object": "string",
  • "report_Printer": "string",
  • "report_Save_Location": "string",
  • "retry": 0,
  • "saturday": true,
  • "schedule_Interval": 0,
  • "start_Date": "2019-08-24T14:15:22Z",
  • "start_Time": "2019-08-24T14:15:22Z",
  • "step_Date": "2019-08-24T14:15:22Z",
  • "step_Delay": 0,
  • "step_Delay_Type": "string",
  • "step_Description": "string",
  • "step_Key": 0,
  • "step_MetaData": "string",
  • "step_Seq": 0,
  • "step_Type": "string",
  • "sunday": true,
  • "thursday": true,
  • "total_Occurrences": 0,
  • "tuesday": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "vbaGateway_Document_Category": "string",
  • "vbaGateway_Document_Field1": "string",
  • "vbaGateway_Document_Field2": "string",
  • "vbaGateway_Document_Field3": "string",
  • "vbaGateway_Document_Field4": "string",
  • "vbaGateway_Document_Field5": "string",
  • "vbaGateway_Document_File": "string",
  • "vbaGateway_Document_Folder": "string",
  • "vbaGateway_Document_ID": "string",
  • "vbaGateway_Document_Label": "string",
  • "vbaGateway_Document_Type": "string",
  • "vbaGateway_Document_Value1": "string",
  • "vbaGateway_Document_Value2": "string",
  • "vbaGateway_Document_Value3": "string",
  • "vbaGateway_Document_Value4": "string",
  • "vbaGateway_Document_Value5": "string",
  • "vbaGateway_UserID": "a8b19680-4553-4dc1-8618-a0ace7266c20",
  • "wednesday": true
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List ReportSeriesStep

Lists all ReportSeriesStep

SecurityapiKeyAuth and bearerAuth
Request
query Parameters
reportSeriesKey
integer <int32>

Filter by ReportSeries_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-steps
Request samples 
Response samples 
No sample
Get ReportSeriesStep
Gets ReportSeriesStep


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportSeriesStepKey
required
integer <int32> 
ReportSeriesStep Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/report-series-steps/{reportSeriesStepKey}
Request samples 
Response samples 
No sample
Update ReportSeriesStep
Updates a specific ReportSeriesStep.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportSeriesStepKey
required
integer <int32> 
ReportSeriesStep Key


 
header Parameters
vbasoftware-database
required
string
Target database


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


 
eMail_Body
string or null  <= 4000 characters 
Body text of the email.


 
eMail_From
string or null  <= 128 characters 
Identifies the sender email.


 
eMail_Server
string or null  <= 128 characters 
Indicates the server over which the email will be sent.


 
eMail_Subject
string or null  <= 256 characters 
Subject line of the email.


 
eMail_To
string or null  <= 128 characters 
Indentifies the receiver email.


 
end_Date
string or null <date-time> 
Indicates the date when the event will stop occurring.


 
end_Option
integer or null <int32> 
Indicates how the event will end.


 
end_Time
string or null <date-time> 
Indicates at what time the event will cease to occur on the defined date(s).


 
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


 
event_Priority
string or null  <= 32 characters 
Indicates the priority of the event.


 
event_Processor
string or null  <= 64 characters 
PowerBuilder object used to process.


 
event_Subject
string or null  <= 256 characters 
Describes the subject of the event.


 
event_UserGroup_Key
integer or null <int32> 
Identifies the Group that will be notified by the event.


 
event_User_ID
string or null  <= 16 characters 
Identifies the User who will be notified by the event.


 
frequency
integer or null <int32> 
Month the event occurs.


 
frequency_Factor
integer or null <int32> 
Day the event occurs.


 
friday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
interval_Option
integer or null <int32> 
Interval Options are Days, Weekdays, Day in Month, Relative Day in Month, Date, or date in Month.


 
monday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
note_Category
string or null  <= 8 characters 
Identifies which category that the note belongs to.


 
note_Data
string or null  <= 4000 characters 
Body text of the note.


 
note_Subject
string or null  <= 64 characters 
Subject line of the note.


 
relative_Frequency
integer or null <int32> 
Day of the week the event occurs.


 
reportDefinition_Key
integer or null <int32> 
ID of the report definition utilized in this step.


 
reportSeries_Key
required
integer <int32> 
ID of the report series to which the step belongs. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
report_Criteria_Object
string or null  <= 64 characters 
Object of the Report_Criteria.


 
report_Library
string or null  <= 128 characters 
Identifies which report library the User wishes to choose from.


 
report_Object
string or null  <= 64 characters 
Indicates which report will be used with the automation step.


 
report_Printer
string or null  <= 128 characters 
Indicates which method will be used to print the selected report.


 
report_Save_Location
string or null  <= 256 characters 
Folder the report is saved to.


 
retry
integer or null <int32> 
Retry of the Retry. Note: The database will apply a default value of 0 for this field if a value is not provided.


 
saturday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
schedule_Interval
integer or null <int32> 
Indicates how often the event will occur. The interval will determine which options are available for the event schedule.


 
start_Date
string or null <date-time> 
Indicates the date when the event will begin occurring by the defined recurrence options.


 
start_Time
string or null <date-time> 
Indicates at what time the event will occur on the defined date(s).


 
step_Date
string or null <date-time> 
Date when the step will occur.


 
step_Delay
integer or null <int32> 
Identifies the number of the selected time period that the step will be delayed by.


 
step_Delay_Type
string or null  <= 32 characters 
Identifies the time period that the step will be delayed by.


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


 
step_Key
integer or null <int32> 
Field used to flag a record for processing by Process Automation.


 
step_MetaData
string or null  <= 512 characters 
Generic column to store meta data.


 
step_Seq
required
integer <int32> 
Identifies the sequence number assigned to the step. This number dictates which order the report series steps will occur (ascending order). Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
step_Type
string or null  <= 32 characters 
Identifies the type associated with this step.


 
sunday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
thursday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
total_Occurrences
integer or null <int32> 
Number of occurrences that will take place before the event ends.


 
tuesday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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


 
vbaGateway_Document_Category
string or null  <= 32 characters 
Identifies which category the document belongs to.


 
vbaGateway_Document_Field1
string or null  <= 64 characters 
Field1 of the VBAGateway_Document.


 
vbaGateway_Document_Field2
string or null  <= 64 characters 
Field2 of the VBAGateway_Document.


 
vbaGateway_Document_Field3
string or null  <= 64 characters 
Field3 of the VBAGateway_Document.


 
vbaGateway_Document_Field4
string or null  <= 64 characters 
Field4 of the VBAGateway_Document.


 
vbaGateway_Document_Field5
string or null  <= 64 characters 
Field5 of the VBAGateway_Document.


 
vbaGateway_Document_File
string or null  <= 256 characters 
File of the VBAGateway_Document.


 
vbaGateway_Document_Folder
string or null  <= 256 characters 
Folder of the VBAGateway_Document.


 
vbaGateway_Document_ID
string or null  <= 64 characters 
Name of the document.


 
vbaGateway_Document_Label
string or null  <= 256 characters 
Short description of the document.


 
vbaGateway_Document_Type
string or null  <= 32 characters 
Identifies the type associated with the document.


 
vbaGateway_Document_Value1
string or null  <= 128 characters 
Value1 of the VBAGateway_Document.


 
vbaGateway_Document_Value2
string or null  <= 128 characters 
Value2 of the VBAGateway_Document.


 
vbaGateway_Document_Value3
string or null  <= 128 characters 
Value3 of the VBAGateway_Document.


 
vbaGateway_Document_Value4
string or null  <= 128 characters 
Value4 of the VBAGateway_Document.


 
vbaGateway_Document_Value5
string or null  <= 128 characters 
Value5 of the VBAGateway_Document.


 
vbaGateway_UserID
string or null <uuid> 
ID of the Gateway User who will receive the chosen document.


 
wednesday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
200
Success


401
Unauthorized


put/report-series-steps/{reportSeriesStepKey}
Request samples 
{
  • "reportSeriesStep_Key": 0,
  • "eMail_Body": "string",
  • "eMail_From": "string",
  • "eMail_Server": "string",
  • "eMail_Subject": "string",
  • "eMail_To": "string",
  • "end_Date": "2019-08-24T14:15:22Z",
  • "end_Option": 0,
  • "end_Time": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "event_Priority": "string",
  • "event_Processor": "string",
  • "event_Subject": "string",
  • "event_UserGroup_Key": 0,
  • "event_User_ID": "string",
  • "frequency": 0,
  • "frequency_Factor": 0,
  • "friday": true,
  • "interval_Option": 0,
  • "monday": true,
  • "note_Category": "string",
  • "note_Data": "string",
  • "note_Subject": "string",
  • "relative_Frequency": 0,
  • "reportDefinition_Key": 0,
  • "reportSeries_Key": 0,
  • "report_Criteria_Object": "string",
  • "report_Library": "string",
  • "report_Object": "string",
  • "report_Printer": "string",
  • "report_Save_Location": "string",
  • "retry": 0,
  • "saturday": true,
  • "schedule_Interval": 0,
  • "start_Date": "2019-08-24T14:15:22Z",
  • "start_Time": "2019-08-24T14:15:22Z",
  • "step_Date": "2019-08-24T14:15:22Z",
  • "step_Delay": 0,
  • "step_Delay_Type": "string",
  • "step_Description": "string",
  • "step_Key": 0,
  • "step_MetaData": "string",
  • "step_Seq": 0,
  • "step_Type": "string",
  • "sunday": true,
  • "thursday": true,
  • "total_Occurrences": 0,
  • "tuesday": true,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "vbaGateway_Document_Category": "string",
  • "vbaGateway_Document_Field1": "string",
  • "vbaGateway_Document_Field2": "string",
  • "vbaGateway_Document_Field3": "string",
  • "vbaGateway_Document_Field4": "string",
  • "vbaGateway_Document_Field5": "string",
  • "vbaGateway_Document_File": "string",
  • "vbaGateway_Document_Folder": "string",
  • "vbaGateway_Document_ID": "string",
  • "vbaGateway_Document_Label": "string",
  • "vbaGateway_Document_Type": "string",
  • "vbaGateway_Document_Value1": "string",
  • "vbaGateway_Document_Value2": "string",
  • "vbaGateway_Document_Value3": "string",
  • "vbaGateway_Document_Value4": "string",
  • "vbaGateway_Document_Value5": "string",
  • "vbaGateway_UserID": "a8b19680-4553-4dc1-8618-a0ace7266c20",
  • "wednesday": true
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete ReportSeriesStep
Deletes an ReportSeriesStep


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
reportSeriesStepKey
required
integer <int32> 
ReportSeriesStep Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


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


 
eMail_Body
string or null  <= 4000 characters 
Body text of the email.


 
eMail_From
string or null  <= 128 characters 
Identifies the sender email.


 
eMail_Server
string or null  <= 128 characters 
Indicates the server over which the email will be sent.


 
eMail_Subject
string or null  <= 256 characters 
Subject line of the email.


 
eMail_To
string or null  <= 128 characters 
Indentifies the receiver email.


 
end_Date
string or null <date-time> 
Indicates the date when the event will stop occurring.


 
end_Option
integer or null <int32> 
Indicates how the event will end.


 
end_Time
string or null <date-time> 
Indicates at what time the event will cease to occur on the defined date(s).


 
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


 
event_Priority
string or null  <= 32 characters 
Indicates the priority of the event.


 
event_Processor
string or null  <= 64 characters 
PowerBuilder object used to process.


 
event_Subject
string or null  <= 256 characters 
Describes the subject of the event.


 
event_UserGroup_Key
integer or null <int32> 
Identifies the Group that will be notified by the event.


 
event_User_ID
string or null  <= 16 characters 
Identifies the User who will be notified by the event.


 
frequency
integer or null <int32> 
Month the event occurs.


 
frequency_Factor
integer or null <int32> 
Day the event occurs.


 
friday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
interval_Option
integer or null <int32> 
Interval Options are Days, Weekdays, Day in Month, Relative Day in Month, Date, or date in Month.


 
monday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
note_Category
string or null  <= 8 characters 
Identifies which category that the note belongs to.


 
note_Data
string or null  <= 4000 characters 
Body text of the note.


 
note_Subject
string or null  <= 64 characters 
Subject line of the note.


 
relative_Frequency
integer or null <int32> 
Day of the week the event occurs.


 
reportDefinition_Key
integer or null <int32> 
ID of the report definition utilized in this step.


 
reportSeries_Key
required
integer <int32> 
ID of the report series to which the step belongs. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
report_Criteria_Object
string or null  <= 64 characters 
Object of the Report_Criteria.


 
report_Library
string or null  <= 128 characters 
Identifies which report library the User wishes to choose from.


 
report_Object
string or null  <= 64 characters 
Indicates which report will be used with the automation step.


 
report_Printer
string or null  <= 128 characters 
Indicates which method will be used to print the selected report.


 
report_Save_Location
string or null  <= 256 characters 
Folder the report is saved to.


 
retry
integer or null <int32> 
Retry of the Retry. Note: The database will apply a default value of 0 for this field if a value is not provided.


 
saturday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
schedule_Interval
integer or null <int32> 
Indicates how often the event will occur. The interval will determine which options are available for the event schedule.


 
start_Date
string or null <date-time> 
Indicates the date when the event will begin occurring by the defined recurrence options.


 
start_Time
string or null <date-time> 
Indicates at what time the event will occur on the defined date(s).


 
step_Date
string or null <date-time> 
Date when the step will occur.


 
step_Delay
integer or null <int32> 
Identifies the number of the selected time period that the step will be delayed by.


 
step_Delay_Type
string or null  <= 32 characters 
Identifies the time period that the step will be delayed by.


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


 
step_Key
integer or null <int32> 
Field used to flag a record for processing by Process Automation.


 
step_MetaData
string or null  <= 512 characters 
Generic column to store meta data.


 
step_Seq
required
integer <int32> 
Identifies the sequence number assigned to the step. This number dictates which order the report series steps will occur (ascending order). Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
step_Type
string or null  <= 32 characters 
Identifies the type associated with this step.


 
sunday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
thursday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
total_Occurrences
integer or null <int32> 
Number of occurrences that will take place before the event ends.


 
tuesday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
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


 
vbaGateway_Document_Category
string or null  <= 32 characters 
Identifies which category the document belongs to.


 
vbaGateway_Document_Field1
string or null  <= 64 characters 
Field1 of the VBAGateway_Document.


 
vbaGateway_Document_Field2
string or null  <= 64 characters 
Field2 of the VBAGateway_Document.


 
vbaGateway_Document_Field3
string or null  <= 64 characters 
Field3 of the VBAGateway_Document.


 
vbaGateway_Document_Field4
string or null  <= 64 characters 
Field4 of the VBAGateway_Document.


 
vbaGateway_Document_Field5
string or null  <= 64 characters 
Field5 of the VBAGateway_Document.


 
vbaGateway_Document_File
string or null  <= 256 characters 
File of the VBAGateway_Document.


 
vbaGateway_Document_Folder
string or null  <= 256 characters 
Folder of the VBAGateway_Document.


 
vbaGateway_Document_ID
string or null  <= 64 characters 
Name of the document.


 
vbaGateway_Document_Label
string or null  <= 256 characters 
Short description of the document.


 
vbaGateway_Document_Type
string or null  <= 32 characters 
Identifies the type associated with the document.


 
vbaGateway_Document_Value1
string or null  <= 128 characters 
Value1 of the VBAGateway_Document.


 
vbaGateway_Document_Value2
string or null  <= 128 characters 
Value2 of the VBAGateway_Document.


 
vbaGateway_Document_Value3
string or null  <= 128 characters 
Value3 of the VBAGateway_Document.


 
vbaGateway_Document_Value4
string or null  <= 128 characters 
Value4 of the VBAGateway_Document.


 
vbaGateway_Document_Value5
string or null  <= 128 characters 
Value5 of the VBAGateway_Document.


 
vbaGateway_UserID
string or null <uuid> 
ID of the Gateway User who will receive the chosen document.


 
wednesday
required
boolean
Indicates that the event should occur on this day of the week. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
207
Success


401
Unauthorized


put/report-series-steps-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}