Schedule

(API Version v9)

System defined schedules for all jobs.

What can you do with Schedule?

POST Schedule/BillRun
Create a new instance of the Schedule object.

Properties

Property Details

identity READ-ONLY	"identity": 5 Type: Number This is the unique numeric identifier for the Schedule
ownerId READ-ONLY	"ownerId": 21 Type: Number Unique identifier for the associated Owner object.
ownerName READ-ONLY	"ownerName": "Sample Name" Type: String The name of the object associated with the ownerId property.
name	"name": "Import Exception Retry" Type: String System defined name for the Schedule.
firstScheduleStart	"firstScheduleStart": "2021-04-26T15:25:27.587Z" Type: Date Date the Schedule was first run. Date and time values are specified in the ISO 8601 format.
scheduleEventTypeId	"scheduleEventTypeId": 7 Type: Number Unique identifier for the associated ScheduleEventType object.
scheduleEventTypeName	"scheduleEventTypeName": "Sample Name" Type: String The name of the object associated with the scheduleEventTypeId property.
scheduleStatusTypeId	"scheduleStatusTypeId": 18 Type: Number Unique identifier for the associated ScheduleStatusType object.
scheduleStatusTypeName	"scheduleStatusTypeName": "Sample Name" Type: String The name of the object associated with the scheduleStatusTypeId property.
frequency	"frequency": 1 Type: Number The frequency the schedule operates at.
monthlyRecurTypeId	"monthlyRecurTypeId": 25 Type: Number Unique identifier for the associated MonthlyRecurType object.
monthlyRecurTypeName	"monthlyRecurTypeName": "Sample Name" Type: String The name of the object associated with the monthlyRecurTypeId property.
scheduleData	"scheduleData": "Hello World" Type: String Additional data required for the schedule.
scheduleFrequencyTypeId	"scheduleFrequencyTypeId": 24 Type: Number Unique identifier for the associated ScheduleFrequencyType object.
scheduleFrequencyTypeName	"scheduleFrequencyTypeName": "Sample Name" Type: String The name of the object associated with the scheduleFrequencyTypeId property.

End Points

Create a new instance of the Schedule object.

POST Schedule/BillRun

{
    "name": "Import Exception Retry",
    "firstScheduleStart": "2021-04-26T15:25:27.587Z",
    "scheduleEventTypeId": 10,
    "scheduleStatusTypeId": 5,
    "frequency": "1",
    "monthlyRecurTypeId": 14,
    "scheduleData": "Sample Text Data",
    "scheduleFrequencyTypeId": 19
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 0,
                "ownerName": "Sample Text Data",
                "name": "Import Exception Retry",
                "firstScheduleStart": "2021-04-26T15:25:27.587Z",
                "scheduleEventTypeId": 14,
                "scheduleEventTypeName": "Sample Text Data",
                "scheduleStatusTypeId": 27,
                "scheduleStatusTypeName": "Sample Text Data",
                "frequency": "1",
                "monthlyRecurTypeId": 19,
                "monthlyRecurTypeName": "Sample Text Data",
                "scheduleData": "Sample Text Data",
                "scheduleFrequencyTypeId": 7,
                "scheduleFrequencyTypeName": "Sample Text Data"
            }
        ]
    }
}