Schedule Object

Defines the schema for configuring a schedule.

API Endpoint

https://api.bigpanda.io/resources/v1.0/schedules

Supported Methods

POST, GET, PATCH

Parameters

The Schedules object schema includes the following attributes:

Attribute

Description

Type

Example

id

System-generated unique identifier for a schedule.

String

"id": "590b68f31f"

name

User defined name for a schedule.

String

"name": "Weekend Maintenance for Plan-SJC"

description

Brief user defined summary of the schedule.

String

"description": "Scheduling the Maintenance window for the weekend."

starts_on

Date and time the schedule starts in Unix epoch format.

Long

"starts_on": 1493989407

ends_on

Date and time the schedule ends in Unix epoch format.

Long

"ends_on": 1495089407

duration

The calculated time between the ends_on and starts_on in seconds.

Long

"duration": 100000

created_on

Date and time the schedule was created in Unix epoch format.

Long

"created_on": 1493922189

created_by

The ID of the user who created the schedule.

String

"created_by": "Administrator 1"

updated_on

Date and time the plan was last updated in Unix epoch format.

Long

"updated_on": 1372854204

updated_by

The ID of the user who last updated the schedule.

String

"updated_by": "Administrator 2"

active

Indicates if the schedule is active and will be processed on the start time.

Boolean

"active": true