Schedules

A Schedule is a named, reusable weekday-and-time schedule shared by scheduled resources across a Site.

List Schedules

SDK Method

\Files\Model\Schedule::list;

Return Object

Schedule[]

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

try {
  $schedules = \Files\Model\Schedule::list();
  foreach ($schedules as $schedule) {
    // Operate on $schedule
  }
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Show Schedule

SDK Method

\Files\Model\Schedule::find;

Return Object

Schedule

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
id
int64
Required		Schedule ID.

Example Request

try {
  $schedule = \Files\Model\Schedule::find($id);
  // Operate on $schedule
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Create Schedule

SDK Method

\Files\Model\Schedule::create;

Return Object

Schedule

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
name
string
Required		Schedule name.
schedule_days_of_week
array(int64)
Required		0-based weekdays used by the Schedule. 0 is Sunday.
schedule_times_of_day
array(string)
Required		Times of day in HH:MM format (24-hour).
schedule_time_zone
string		Time zone for scheduled times. If not set, times are interpreted as UTC.
holiday_region
string		Optional holiday region on which linked resources do not run.

Example Request

try {
  $schedule = \Files\Model\Schedule::create([
    'name' => "Weekday overnight",
    'schedule_days_of_week' => [1,2,3,4,5],
    'schedule_times_of_day' => ["01:00"]
  ]);
  // Operate on $schedule
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Update Schedule

SDK Method

$schedule->update;

Return Object

Schedule

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
name
string		Schedule name.
schedule_days_of_week
array(int64)		0-based weekdays used by the Schedule. 0 is Sunday.
schedule_times_of_day
array(string)		Times of day in HH:MM format (24-hour).
schedule_time_zone
string		Time zone for scheduled times. If not set, times are interpreted as UTC.
holiday_region
string		Optional holiday region on which linked resources do not run.

Example Request

try {
  // Find the schedule object by its id.
  $schedule = \Files\Model\Schedule::find(id);
  $schedule->update([
    'name' => "Weekday overnight"
  ]);
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Delete Schedule

SDK Method

$schedule->delete;

Return Object

No return value.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Example Request

try {
  // Find the schedule object by its id.
  $schedule = \Files\Model\Schedule::find(id);
  $schedule->delete();
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

The Schedule Object

Some of the methods above return a Schedule object. The attributes of this object are listed below.

AttributeDescription
id
int64		Schedule ID.
name
string		Schedule name.
schedule_days_of_week
array(int64)		0-based weekdays used by the Schedule. 0 is Sunday.
schedule_times_of_day
array(string)		Times of day in HH:MM format (24-hour).
schedule_time_zone
string		Time zone for scheduled times. If not set, times are interpreted as UTC.
holiday_region
string		Optional holiday region on which linked resources do not run.
human_readable_schedule
string		Human-readable Schedule description.
created_at
date-time		Creation time.
updated_at
date-time		Last update time.