Update an Active Report Schedule

Updates a schedule having Status as 'Active'.

PUT/csapi/v1.3/reports/schedule/{reportingScheduleID}

Input ParametersInput Parameters

Parameter	Mandatory/Optional	Data Type	Description
displayColumns	Mandatory	string	Specify the columns to include in the report. Multiple columns should be comma-separated. When unspecified, all report columns will be included. When an empty value is provided, only default columns will be included. Valid Values: repo, uuid, sha, severity, firstDetected, qdsScore, riskScore, qid and so on.
eventEndTime	Mandatory	string	Specify the end date and time for the schedule. Time must be in UTC.
eventTime	Mandatory	string	Specify the start date and time for the schedule. For example, 2023-02-16T19:30:00Z. Time must be in UTC.
expireAfter	Mandatory	string	Specify a time period after which the report expires and gets deleted from your account. The valid values are (days): 1, 7, 30, or 90.
reportScheduleDetails	Mandatory	-----	Specify the below parameters to define a schedule. Specify 'null' if you do not want to create a recurrent report schedule. In that case, the report is triggered for only once (on the time specified in eventTime).
customMessage	Optional	string	Message to be shown in the update notification email.
emailNotification	Optional	boolean	Choose to send scheduled report through an email. Valid Values: 0 or 1. '0' indicates 'no', and '1' indicates 'yes'.
emailSubject	Optional	string	Subject email of the update notification.
recipient	Optional	string	Mandatory if 'emailNotification' is choosen. Email Id of the person whom you want to send the report update notification.
recurrenceType	Mandatory	string	Specify the recurrence frequency as DAILY or WEEKLY or MONTHLY.
sendAsAttachment	Optional	boolean	Choose to send scheduled report through an attachment. Valid Values: 0 or 1. '0' indicates 'no', and '1' indicates 'yes'.
selectedDayOfWeeks	Mandatory	string	Specify a day on which the report is triggered every week. This parameter is valid only if the recurrenceType is WEEKLY. The valid values are the names of days. Specify null if this parameter is not applicable.
zip	Optional	integer	Choose to send scheduled report through a Zip file. Valid Values: 0 or 1. '0' indicates 'no', and '1' indicates 'yes'.

Sample: Update an Active Report ScheduleSample: Update an Active Report Schedule

API Request

curl -X 'PUT' \
  '<qualys_base_url>/csapi/v1.3/reports/schedule/6e8f7a20-91cb-11ef-9f40-ad02a75af93a' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "displayColumns": [
        "repo",
        "uuid",
        "sha",
        "severity",
        "firstDetected",
        "riskScore",
        "qdsScore",
        "qid",
        "imageId"
      ],
  "expireAfter": "90",
  "eventTime": "2024-10-24T06:41:51.864Z",
  "eventEndTime": "2024-12-30T05:41:51.864Z",
  "reportScheduleDetails": {
    "recurrenceType": "WEEKLY",
    "selectedDayOfWeeks": [
      "THURSDAY"
    ]
  },
  "zip": "1",
  "emailNotification": "1",
  "sendAsAttachment": "1",
  "recipient": "jack_reader@rediffmail.com, john_doe@gmail.com",
  "emailSubject": "Test email for edit schedule",
  "customMessage": "Report-message"
}'

Response

 { "message": "Details updated successfully for reportScheduleId 6e8f7a20-91cb-11ef-9f40-ad02a75af93a" }