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