Schedule

What can you do with Schedule?


Properties

Property Details
id
"id": 852
Type: Number
This is the unique numeric identifier for the Schedule
ownerId
"ownerId": 356
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
firstScheduleStart
"firstScheduleStart": "2005-04-11T14:56:24"
Type: Date
scheduleEventTypeId
"scheduleEventTypeId": 444
Type: Number
Unique identifier for the associated ScheduleEventType object.
scheduleStatusTypeId
"scheduleStatusTypeId": 847
Type: Number
Unique identifier for the associated ScheduleStatusType object.
frequency
"frequency": 656
Type: Number
frequencyTypeId
"frequencyTypeId": 18
Type: Number
Unique identifier for the associated FrequencyType object.
monthlyRecurTypeId
"monthlyRecurTypeId": 212
Type: Number
Unique identifier for the associated MonthlyRecurType object.
scheduleData
"scheduleData": "Hello World"
Type: String


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • firstScheduleStart
  • scheduleEventTypeId
  • scheduleStatusTypeId
  • frequency
  • frequencyTypeId
  • monthlyRecurTypeId
  • scheduleData

DataFlow PATCH objects:


End Points

DELETEapi/v1/Schedule/{id:int}
Delete an instance of the Schedule object.
GETapi/v1/Schedule
Retrieve all of the Schedule objects.
GETapi/v1/Schedule/Metadata
Retrieve all of the meta data details of the Schedule object.
GETapi/v1/Schedule/Metadata/{option}
Retrieve all the meta data details of the Schedule object based on provided options.
{option}Metadata options for the Schedule object.
GETapi/v1/Schedule/Paged
Retreive all of the Schedule objects in a paged fashion.
GETapi/v1/Schedule/{id:int}
Retrieve an instance of the Schedule object by it's ID.
{id:int}Unique identifier for the Schedule object.
POSTapi/v1/Schedule
Create a new instance of the Schedule object.
PUTapi/v1/Schedule/{id:int}
Update an existing instance of the Schedule object.