ScheduleViewObject

The schedule listing object.

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

scheduleItemId

The content item (ID) that the schedule is attached to

-

string

endDate

Schedule's end date

-

integer

Api2: int64 - epoch time in milliseconds, Api3: String according to iso8601

description

Schedule's description

-

string

type

Schedule's type

-

ScheduleType

scheduleItemName

The content item (Name) that the schedule is attached to

-

string

createdDate

Schedule's create date

-

integer

Api2: int64 - epoch time in milliseconds, Api3: String according to iso8601

scheduleDataType

Schedule repetition type enumeration

-

ScheduleDataType

createdBy

Schedule's creator

-

string

name

Schedule's name or caption

-

string

tenantId

The tenant id of the Schedule's creator

-

string

scheduleId

Schedule's system ID

-

string

startDate

Schedule's start date

-

integer

Api2: int64 - epoch time in milliseconds, Api3: String according to iso8601

status

Schedule status enumeration

-

ScheduleStatus

Usages
  • /API2/tasks/findSchedule
  • /API2/tasks/getSchedulesForUser
  • /API3/tasks/findSchedule
  • /API3/tasks/getSchedulesForUser