Skip to main content

Get all Schedules​

Select

SaaS
Customer Managed

This operation returns a list of schedules.

More Details

Query Parameters
  • clientId int32

    The client ID for the client.

  • storagepolicyId int32

    The storage policy ID for the storage policy.

  • admin int32

    The option to return administrator schedules for a storage policy. This request parameter must be used with the storagepolicyId request parameter. Allowed value: 1

  • apptypeId int32

    The application type ID for the agent types associated with the schedule. Check more details to get valid values.

  • instanceId int32

    The instance ID for the instance.

  • backupsetId int32

    The backup set ID for the backup set

  • subclientId int32

    The subclient ID for the subclient.

  • operationType string

    Possible values: [BACKUP, ARCHIVE, CONTENT_INDEXING, RESTORE, DRBACKUP, DATA_AGING, DOWNLOAD_UPDATES, INSTALL_UPDATES]

    The type of operation.

  • isSystem boolean

    The filter returns only the system created schedules when the value is true.

  • workflowId int32

    The workflow ID for the workflow

Responses

OK

Schema
  • taskDetail object[]
  • taskOperation int32
  • associations object[]
  • srmReportSet int32
  • type int32
  • srmTemplateId int32
  • subclientId int32
  • clientGroupId int32
  • storagePolicyId int32
  • copyId int32
  • applicationId int32
  • backupsetId int32
  • instanceId int32
  • srmReportType int32
  • sidbStoreId int32
  • clientSidePackage boolean
  • clientId int32
  • sidbStoreName string
  • copyName string
  • agentlessPolicyId int32
  • mediaAgentId int32
  • _type_ int32
  • appName string
  • consumeLicense boolean
  • flags object
  • exclude boolean
  • task object
  • GUID string

    The globally unique identifier for the task.

  • description string

    The description of the schedule.

  • ownerId int32

    An internal reference number for the user who created the schedule.

  • runUserId int32
  • taskType int32

    The type of task.

  • ownerName string

    The name of the user who created the schedule

  • policyType int32

    The type of schedule.

  • taskName string

    The name of the schedule.

  • alertId int32

    The system-generated ID assigned to the alert.

  • taskId int32

    The system-generated ID assigned to the schedule.

  • taskFlags object
  • isEZOperation boolean
  • uninstalled boolean

    Indicates whether the client associated with the schedule is uninstalled.

  • disabled boolean
  • originalCC object
  • commCellId int32

    The CommCell ID of the CommServe.

  • appGroup object
  • subTasks object[]
  • relativeTime int32
  • subTaskOperation int32
  • subTask object
  • subTaskOrder int32
  • subTaskType int32
  • flags int32
  • operationType int32
  • subTaskId int32
  • pattern object
  • active_end_occurence int32
  • freq_subday_interval int32
  • freq_type int32
  • patternId int32
  • flags int32
  • description string
  • active_end_time int32
  • skipOccurence int32
  • skipDayNumber int32
  • active_start_time int32
  • freq_restart_interval int32
  • active_start_date int32
  • freq_interval int32
  • freq_relative_interval int32
  • freq_recurrence_factor int32
  • calendar object
  • calendarId int32
  • timeZone object
  • TimeZoneID int32
  • options object
  • backupOpts object
  • mediaOpt object
  • auxcopyJobOption object
  • maxNumberOfStreams int32
  • useMaximumStreams boolean
  • adminOpts object
  • archiveCheckOption object
  • ddbVerificationLevel int32
  • jobsToVerify int32
  • allCopies boolean
  • backupLevel int32
GET /schedules

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
clientId — query
storagepolicyId — query
admin — query
apptypeId — query
instanceId — query
backupsetId — query
subclientId — query
operationType — query
isSystem — query
workflowId — query
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/Schedules' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'