Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Schedule

The schedule object

Properties

Optional description

description: undefined | string

Detailed description for the object.

Optional frequencyDetails

Optional identifier

identifier: undefined | string

Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.

Optional isDaylightAdjustmentEnabled

isDaylightAdjustmentEnabled: undefined | false | true

A flag to indicate daylight saving.

Optional key

key: undefined | string

Generated key that can be used in API calls to identify schedule. On scenarios where reference to the schedule is needed, a value can be passed in create.

Optional metadata

metadata: model.ObjectMetadata

Optional modelType

modelType: undefined | string

The type of the object.

Optional modelVersion

modelVersion: undefined | string

This is a version number that is used by the service to upgrade objects if needed through releases of the service.

Optional name

name: undefined | string

Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Optional objectStatus

objectStatus: undefined | number

The status of an object that can be set to value 1 for shallow references across objects, other values reserved. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional objectVersion

objectVersion: undefined | number

This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional parentRef

parentRef: model.ParentReference

Optional timezone

timezone: undefined | string

The timezone for the schedule.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Schedule): object

getJsonObj