Delete Report Schedule

This API helps you delete a report schedule.


User Privilege

You must have Delete privilege on the report schedule.

Syntax

The syntax for calling this method is:

DELETE /<Base_Url>/reportSchedule/{reportScheduleId}

For example, DELETE https://123.123.123.123/vCenter-CB/api/reportSchedule/15

URL Parameters

You can provide a optional boolean parameter, deleteAssociatedReports, in the URL. If set to true, all the generated reports that are associated with the schedule are deleted.

Request Parameters

The API does not need a request XML.

API Response

The API returns an XML that provides the status of the operation.

A sample response is provided here.

Error Response

The following table explains the error codes displayed by the API.

Error code

Description

VCB_ERR_REP_SCHEDULE_TASK_NOT_FOUND

Scheduled task information for a given schedule is not found in the database.

VCB_ERR_REP_SCHEDULE_NOT_FOUND                                

Report schedule for the specified report schedule ID is not found in the database.