Update a Schedule

put

https://helios.cohesity.com/heliosreporting/api/v1/public/schedules/{id}

Update schedule for a given id.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Specifies the id of the schedule.

Body Params

Request body params in order to update a schedule.

reportId

string | null

required

Specifies id of the report that is scheduled.

name

string | null

The name of the schedule.

scheduleTime

object

required

Specifies the time parameters of a schedule for a report.

state

string | null

enum

State of the schedule. Can be Active/Inactive.

Allowed:

emailSubject

string | null

Subject to be sent in the email.

emailIds

array of strings or null | null

Email ids to which schedule needs to be sent.

emailIds

reportFormat

array of strings or null | null

The formats in which the report has been requested. Can be PDF/CSV/XLS/HTML.

reportFormat

latestTask

object

Definition of a task.

filters

array of objects | null

Specifies list of global filters that are applicable to given components in the report.

filters

layout

string | null

The layout of the report which needs to be exported.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200Success

defaultError