# Update ReportSeriesStep

Updates a specific ReportSeriesStep.

Endpoint: PUT /report-series-steps/{reportSeriesStepKey}
Version: v1
Security: apiKeyAuth, bearerAuth

## Header parameters:

  - `vbasoftware-database` (string, required)
    Target database

## Path parameters:

  - `reportSeriesStepKey` (integer, required)
    ReportSeriesStep Key

## Request fields (application/json):

  - `reportSeriesStep_Key` (integer, required)
    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,null)
    Body text of the email.

  - `eMail_From` (string,null)
    Identifies the sender email.

  - `eMail_Server` (string,null)
    Indicates the server over which the email will be sent.

  - `eMail_Subject` (string,null)
    Subject line of the email.

  - `eMail_To` (string,null)
    Indentifies the receiver email.

  - `end_Date` (string,null)
    Indicates the date when the event will stop occurring.

  - `end_Option` (integer,null)
    Indicates how the event will end.

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

  - `entry_Date` (string)
    Date record was first added to the system

  - `entry_User` (string,null)
    User that first added the record to the system

  - `event_Priority` (string,null)
    Indicates the priority of the event.

  - `event_Processor` (string,null)
    PowerBuilder object used to process.

  - `event_Subject` (string,null)
    Describes the subject of the event.

  - `event_UserGroup_Key` (integer,null)
    Identifies the Group that will be notified by the event.

  - `event_User_ID` (string,null)
    Identifies the User who will be notified by the event.

  - `frequency` (integer,null)
    Month the event occurs.

  - `frequency_Factor` (integer,null)
    Day the event occurs.

  - `friday` (boolean, required)
    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,null)
    Interval Options are Days, Weekdays, Day in Month, Relative Day in Month, Date, or date in Month.

  - `monday` (boolean, required)
    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,null)
    Identifies which category that the note belongs to.

  - `note_Data` (string,null)
    Body text of the note.

  - `note_Subject` (string,null)
    Subject line of the note.

  - `relative_Frequency` (integer,null)
    Day of the week the event occurs.

  - `reportDefinition_Key` (integer,null)
    ID of the report definition utilized in this step.

  - `reportSeries_Key` (integer, required)
    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,null)
    Object of the Report_Criteria.

  - `report_Library` (string,null)
    Identifies which report library the User wishes to choose from.

  - `report_Object` (string,null)
    Indicates which report will be used with the automation step.

  - `report_Printer` (string,null)
    Indicates which method will be used to print the selected report.

  - `report_Save_Location` (string,null)
    Folder the report is saved to.

  - `retry` (integer,null)
    Retry of the Retry. Note: The database will apply a default value of 0 for this field if a value is not provided.

  - `saturday` (boolean, required)
    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,null)
    Indicates how often the event will occur. The interval will determine which options are available for the event schedule.

  - `start_Date` (string,null)
    Indicates the date when the event will begin occurring by the defined recurrence options.

  - `start_Time` (string,null)
    Indicates at what time the event will occur on the defined date(s).

  - `step_Date` (string,null)
    Date when the step will occur.

  - `step_Delay` (integer,null)
    Identifies the number of the selected time period that the step will be delayed by.

  - `step_Delay_Type` (string,null)
    Identifies the time period that the step will be delayed by.

  - `step_Description` (string,null)
    Description of the report series step.

  - `step_Key` (integer,null)
    Field used to flag a record for processing by Process Automation.

  - `step_MetaData` (string,null)
    Generic column to store meta data.

  - `step_Seq` (integer, required)
    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,null)
    Identifies the type associated with this step.

  - `sunday` (boolean, required)
    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` (boolean, required)
    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,null)
    Number of occurrences that will take place before the event ends.

  - `tuesday` (boolean, required)
    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 the record was last updated in the system

  - `update_User` (string,null)
    User that last updated the record in the system

  - `vbaGateway_Document_Category` (string,null)
    Identifies which category the document belongs to.

  - `vbaGateway_Document_Field1` (string,null)
    Field1 of the VBAGateway_Document.

  - `vbaGateway_Document_Field2` (string,null)
    Field2 of the VBAGateway_Document.

  - `vbaGateway_Document_Field3` (string,null)
    Field3 of the VBAGateway_Document.

  - `vbaGateway_Document_Field4` (string,null)
    Field4 of the VBAGateway_Document.

  - `vbaGateway_Document_Field5` (string,null)
    Field5 of the VBAGateway_Document.

  - `vbaGateway_Document_File` (string,null)
    File of the VBAGateway_Document.

  - `vbaGateway_Document_Folder` (string,null)
    Folder of the VBAGateway_Document.

  - `vbaGateway_Document_ID` (string,null)
    Name of the document.

  - `vbaGateway_Document_Label` (string,null)
    Short description of the document.

  - `vbaGateway_Document_Type` (string,null)
    Identifies the type associated with the document.

  - `vbaGateway_Document_Value1` (string,null)
    Value1 of the VBAGateway_Document.

  - `vbaGateway_Document_Value2` (string,null)
    Value2 of the VBAGateway_Document.

  - `vbaGateway_Document_Value3` (string,null)
    Value3 of the VBAGateway_Document.

  - `vbaGateway_Document_Value4` (string,null)
    Value4 of the VBAGateway_Document.

  - `vbaGateway_Document_Value5` (string,null)
    Value5 of the VBAGateway_Document.

  - `vbaGateway_UserID` (string,null)
    ID of the Gateway User who will receive the chosen document.

  - `wednesday` (boolean, required)
    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.

  - `fax_Number` (string,null)
    For FAX step type, this indicates the fax number to send the fax to.

  - `text_Number` (string,null)
    For TEXT step type, this indicates the phone number to send the text to.

  - `text_Message` (string,null)
    For TEXT step type, this indicates the message to send in the text.

  - `sftP_User` (string,null)

  - `sftP_Password` (string,null)

  - `sftP_Host` (string,null)

  - `sftP_Port` (integer,null)

  - `sftP_Protocol` (integer,null)

  - `sftP_Passive` (boolean)

  - `sftP_Path` (string,null)

  - `sftP_File_Name` (string,null)

  - `activity_ID` (string,null)

  - `step_Error_Message` (string,null)

## Response 200 fields (text/plain):

  - `data` (object)

  - `data.reportSeriesStep_Key` (integer, required)
    ID of the report series step. Note: This field is marked as NOT NULL in the database and therefore required by the API.

  - `data.eMail_Body` (string,null)
    Body text of the email.

  - `data.eMail_From` (string,null)
    Identifies the sender email.

  - `data.eMail_Server` (string,null)
    Indicates the server over which the email will be sent.

  - `data.eMail_Subject` (string,null)
    Subject line of the email.

  - `data.eMail_To` (string,null)
    Indentifies the receiver email.

  - `data.end_Date` (string,null)
    Indicates the date when the event will stop occurring.

  - `data.end_Option` (integer,null)
    Indicates how the event will end.

  - `data.end_Time` (string,null)
    Indicates at what time the event will cease to occur on the defined date(s).

  - `data.entry_Date` (string)
    Date record was first added to the system

  - `data.entry_User` (string,null)
    User that first added the record to the system

  - `data.event_Priority` (string,null)
    Indicates the priority of the event.

  - `data.event_Processor` (string,null)
    PowerBuilder object used to process.

  - `data.event_Subject` (string,null)
    Describes the subject of the event.

  - `data.event_UserGroup_Key` (integer,null)
    Identifies the Group that will be notified by the event.

  - `data.event_User_ID` (string,null)
    Identifies the User who will be notified by the event.

  - `data.frequency` (integer,null)
    Month the event occurs.

  - `data.frequency_Factor` (integer,null)
    Day the event occurs.

  - `data.friday` (boolean, required)
    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.

  - `data.interval_Option` (integer,null)
    Interval Options are Days, Weekdays, Day in Month, Relative Day in Month, Date, or date in Month.

  - `data.monday` (boolean, required)
    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.

  - `data.note_Category` (string,null)
    Identifies which category that the note belongs to.

  - `data.note_Data` (string,null)
    Body text of the note.

  - `data.note_Subject` (string,null)
    Subject line of the note.

  - `data.relative_Frequency` (integer,null)
    Day of the week the event occurs.

  - `data.reportDefinition_Key` (integer,null)
    ID of the report definition utilized in this step.

  - `data.reportSeries_Key` (integer, required)
    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.

  - `data.report_Criteria_Object` (string,null)
    Object of the Report_Criteria.

  - `data.report_Library` (string,null)
    Identifies which report library the User wishes to choose from.

  - `data.report_Object` (string,null)
    Indicates which report will be used with the automation step.

  - `data.report_Printer` (string,null)
    Indicates which method will be used to print the selected report.

  - `data.report_Save_Location` (string,null)
    Folder the report is saved to.

  - `data.retry` (integer,null)
    Retry of the Retry. Note: The database will apply a default value of 0 for this field if a value is not provided.

  - `data.saturday` (boolean, required)
    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.

  - `data.schedule_Interval` (integer,null)
    Indicates how often the event will occur. The interval will determine which options are available for the event schedule.

  - `data.start_Date` (string,null)
    Indicates the date when the event will begin occurring by the defined recurrence options.

  - `data.start_Time` (string,null)
    Indicates at what time the event will occur on the defined date(s).

  - `data.step_Date` (string,null)
    Date when the step will occur.

  - `data.step_Delay` (integer,null)
    Identifies the number of the selected time period that the step will be delayed by.

  - `data.step_Delay_Type` (string,null)
    Identifies the time period that the step will be delayed by.

  - `data.step_Description` (string,null)
    Description of the report series step.

  - `data.step_Key` (integer,null)
    Field used to flag a record for processing by Process Automation.

  - `data.step_MetaData` (string,null)
    Generic column to store meta data.

  - `data.step_Seq` (integer, required)
    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.

  - `data.step_Type` (string,null)
    Identifies the type associated with this step.

  - `data.sunday` (boolean, required)
    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.

  - `data.thursday` (boolean, required)
    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.

  - `data.total_Occurrences` (integer,null)
    Number of occurrences that will take place before the event ends.

  - `data.tuesday` (boolean, required)
    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.

  - `data.update_Date` (string)
    Date the record was last updated in the system

  - `data.update_User` (string,null)
    User that last updated the record in the system

  - `data.vbaGateway_Document_Category` (string,null)
    Identifies which category the document belongs to.

  - `data.vbaGateway_Document_Field1` (string,null)
    Field1 of the VBAGateway_Document.

  - `data.vbaGateway_Document_Field2` (string,null)
    Field2 of the VBAGateway_Document.

  - `data.vbaGateway_Document_Field3` (string,null)
    Field3 of the VBAGateway_Document.

  - `data.vbaGateway_Document_Field4` (string,null)
    Field4 of the VBAGateway_Document.

  - `data.vbaGateway_Document_Field5` (string,null)
    Field5 of the VBAGateway_Document.

  - `data.vbaGateway_Document_File` (string,null)
    File of the VBAGateway_Document.

  - `data.vbaGateway_Document_Folder` (string,null)
    Folder of the VBAGateway_Document.

  - `data.vbaGateway_Document_ID` (string,null)
    Name of the document.

  - `data.vbaGateway_Document_Label` (string,null)
    Short description of the document.

  - `data.vbaGateway_Document_Type` (string,null)
    Identifies the type associated with the document.

  - `data.vbaGateway_Document_Value1` (string,null)
    Value1 of the VBAGateway_Document.

  - `data.vbaGateway_Document_Value2` (string,null)
    Value2 of the VBAGateway_Document.

  - `data.vbaGateway_Document_Value3` (string,null)
    Value3 of the VBAGateway_Document.

  - `data.vbaGateway_Document_Value4` (string,null)
    Value4 of the VBAGateway_Document.

  - `data.vbaGateway_Document_Value5` (string,null)
    Value5 of the VBAGateway_Document.

  - `data.vbaGateway_UserID` (string,null)
    ID of the Gateway User who will receive the chosen document.

  - `data.wednesday` (boolean, required)
    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.

  - `data.fax_Number` (string,null)
    For FAX step type, this indicates the fax number to send the fax to.

  - `data.text_Number` (string,null)
    For TEXT step type, this indicates the phone number to send the text to.

  - `data.text_Message` (string,null)
    For TEXT step type, this indicates the message to send in the text.

  - `data.sftP_User` (string,null)

  - `data.sftP_Password` (string,null)

  - `data.sftP_Host` (string,null)

  - `data.sftP_Port` (integer,null)

  - `data.sftP_Protocol` (integer,null)

  - `data.sftP_Passive` (boolean)

  - `data.sftP_Path` (string,null)

  - `data.sftP_File_Name` (string,null)

  - `data.activity_ID` (string,null)

  - `data.step_Error_Message` (string,null)

  - `error` (object)

  - `error.detail` (string,null)
    A human-readable explanation specific to this occurrence of the problem.

  - `error.instance` (string,null)
    A URI reference that identifies the specific occurrence of the problem.It may
or may not yield further information if dereferenced.

  - `error.status` (integer)
    The HTTP status code([RFC7231], Section 6) generated by the origin server for
this occurrence of the problem.

  - `error.title` (string,null)
    A short, human-readable summary of the problem type.It SHOULD NOT change from
occurrence to occurrence of the problem, except for purposes of localization(e.g.,
using proactive content negotiation; see[RFC7231], Section 3.4).

  - `error.type` (string,null)
    A URI reference [RFC3986] that identifies the problem type. This specification
encourages that, when dereferenced, it provide human-readable documentation for
the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member
is not present, its value is assumed to be "about:blank".

  - `debug` (object)

  - `debug.activityID` (string, required)


## Response 401 fields