TAG LINE
TAG LINE
SMALL TITLE
System defined schedules for all jobs.
identity READ-ONLY | "identity": 7 Type: Number This is the unique numeric identifier for the Schedule |
ownerId READ-ONLY | "ownerId": 16 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 |
scheduleEventTypeId | "scheduleEventTypeId": 18 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": 10 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": 14 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": 0 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. |
| GET | Schedule/DataExport |
| Retrieve all of the Schedule objects. | |
Retrieve all of the Schedule objects. GET Schedule/DataExport HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 2,
"ownerName": "Sample Text Data",
"name": "Import Exception Retry",
"firstScheduleStart": "2021-04-26T15:25:27.587Z",
"scheduleEventTypeId": 15,
"scheduleEventTypeName": "Sample Text Data",
"scheduleStatusTypeId": 17,
"scheduleStatusTypeName": "Sample Text Data",
"frequency": "1",
"monthlyRecurTypeId": 0,
"monthlyRecurTypeName": "Sample Text Data",
"scheduleData": "Sample Text Data",
"scheduleFrequencyTypeId": 20,
"scheduleFrequencyTypeName": "Sample Text Data"
}
]
} | |
| GET | Schedule/Rerate |
| Retrieve all of the Schedule objects. | |
Retrieve all of the Schedule objects. GET Schedule/Rerate HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 3,
"ownerName": "Sample Text Data",
"name": "Import Exception Retry",
"firstScheduleStart": "2021-04-26T15:25:27.587Z",
"scheduleEventTypeId": 12,
"scheduleEventTypeName": "Sample Text Data",
"scheduleStatusTypeId": 23,
"scheduleStatusTypeName": "Sample Text Data",
"frequency": "1",
"monthlyRecurTypeId": 17,
"monthlyRecurTypeName": "Sample Text Data",
"scheduleData": "Sample Text Data",
"scheduleFrequencyTypeId": 23,
"scheduleFrequencyTypeName": "Sample Text Data"
}
]
} | |
| POST | Schedule/BillRun |
| Create a new instance of the Schedule object. | |
Create a new instance of the Schedule object. POST Schedule/BillRun
{
"name": "Import Exception Retry",
"firstScheduleStart": "2021-04-26T15:25:27.587Z",
"scheduleEventTypeId": 20,
"scheduleStatusTypeId": 14,
"frequency": "1",
"monthlyRecurTypeId": 14,
"scheduleData": "Sample Text Data",
"scheduleFrequencyTypeId": 18
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 20,
"ownerName": "Sample Text Data",
"name": "Import Exception Retry",
"firstScheduleStart": "2021-04-26T15:25:27.587Z",
"scheduleEventTypeId": 16,
"scheduleEventTypeName": "Sample Text Data",
"scheduleStatusTypeId": 11,
"scheduleStatusTypeName": "Sample Text Data",
"frequency": "1",
"monthlyRecurTypeId": 18,
"monthlyRecurTypeName": "Sample Text Data",
"scheduleData": "Sample Text Data",
"scheduleFrequencyTypeId": 18,
"scheduleFrequencyTypeName": "Sample Text Data"
}
]
}
} | |
| POST | Schedule/DataExport |
| Create a new instance of the Schedule object. | |
Create a new instance of the Schedule object. POST Schedule/DataExport
{
"name": "Import Exception Retry",
"firstScheduleStart": "2021-04-26T15:25:27.587Z",
"scheduleEventTypeId": 5,
"scheduleStatusTypeId": 8,
"frequency": "1",
"monthlyRecurTypeId": 19,
"scheduleData": "Sample Text Data",
"scheduleFrequencyTypeId": 16
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 25,
"ownerName": "Sample Text Data",
"name": "Import Exception Retry",
"firstScheduleStart": "2021-04-26T15:25:27.587Z",
"scheduleEventTypeId": 27,
"scheduleEventTypeName": "Sample Text Data",
"scheduleStatusTypeId": 23,
"scheduleStatusTypeName": "Sample Text Data",
"frequency": "1",
"monthlyRecurTypeId": 26,
"monthlyRecurTypeName": "Sample Text Data",
"scheduleData": "Sample Text Data",
"scheduleFrequencyTypeId": 6,
"scheduleFrequencyTypeName": "Sample Text Data"
}
]
}
} | |
| POST | Schedule/Rerate |
| Create a new instance of the Schedule object. | |
Create a new instance of the Schedule object. POST Schedule/Rerate
{
"name": "Import Exception Retry",
"firstScheduleStart": "2021-04-26T15:25:27.587Z",
"scheduleEventTypeId": 2,
"scheduleStatusTypeId": 2,
"frequency": "1",
"monthlyRecurTypeId": 7,
"scheduleData": "Sample Text Data",
"scheduleFrequencyTypeId": 20
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 21,
"ownerName": "Sample Text Data",
"name": "Import Exception Retry",
"firstScheduleStart": "2021-04-26T15:25:27.587Z",
"scheduleEventTypeId": 15,
"scheduleEventTypeName": "Sample Text Data",
"scheduleStatusTypeId": 16,
"scheduleStatusTypeName": "Sample Text Data",
"frequency": "1",
"monthlyRecurTypeId": 26,
"monthlyRecurTypeName": "Sample Text Data",
"scheduleData": "Sample Text Data",
"scheduleFrequencyTypeId": 18,
"scheduleFrequencyTypeName": "Sample Text Data"
}
]
}
} | |
| PUT | Schedule/DataExport/{id} |
| Update an existing instance of the Schedule object. | |
Update an existing instance of the Schedule object. PUT Schedule/DataExport/{id}
{
"identity": 1,
"name": "Import Exception Retry",
"firstScheduleStart": "2021-04-26T15:25:27.587Z",
"scheduleEventTypeId": 21,
"scheduleStatusTypeId": 11,
"frequency": "1",
"monthlyRecurTypeId": 18,
"scheduleData": "Sample Text Data",
"scheduleFrequencyTypeId": 12
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 6,
"ownerName": "Sample Text Data",
"name": "Import Exception Retry",
"firstScheduleStart": "2021-04-26T15:25:27.587Z",
"scheduleEventTypeId": 18,
"scheduleEventTypeName": "Sample Text Data",
"scheduleStatusTypeId": 14,
"scheduleStatusTypeName": "Sample Text Data",
"frequency": "1",
"monthlyRecurTypeId": 24,
"monthlyRecurTypeName": "Sample Text Data",
"scheduleData": "Sample Text Data",
"scheduleFrequencyTypeId": 25,
"scheduleFrequencyTypeName": "Sample Text Data"
}
]
}
} | |
| PUT | Schedule/Rerate/{id} |
| Update an existing instance of the Schedule object. | |
Update an existing instance of the Schedule object. PUT Schedule/Rerate/{id}
{
"identity": 1,
"name": "Import Exception Retry",
"firstScheduleStart": "2021-04-26T15:25:27.587Z",
"scheduleEventTypeId": 21,
"scheduleStatusTypeId": 16,
"frequency": "1",
"monthlyRecurTypeId": 20,
"scheduleData": "Sample Text Data",
"scheduleFrequencyTypeId": 5
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 17,
"ownerName": "Sample Text Data",
"name": "Import Exception Retry",
"firstScheduleStart": "2021-04-26T15:25:27.587Z",
"scheduleEventTypeId": 27,
"scheduleEventTypeName": "Sample Text Data",
"scheduleStatusTypeId": 18,
"scheduleStatusTypeName": "Sample Text Data",
"frequency": "1",
"monthlyRecurTypeId": 4,
"monthlyRecurTypeName": "Sample Text Data",
"scheduleData": "Sample Text Data",
"scheduleFrequencyTypeId": 27,
"scheduleFrequencyTypeName": "Sample Text Data"
}
]
}
} | |