ItemScheduleAPI interface
Methods
| cancel |
|
| create |
|
| delete |
This API is used to delete schedule given item object id, job definition id and item job type. |
| get |
|
| get |
|
| list |
An item can have multiple job types, each with its own distinct job schedule. This API is used to retrieve schedule list for specific item. |
| run |
|
| update |
Method Details
cancelItemJob(ItemJobInstanceBaseParams)
function cancelItemJob(jobParams: ItemJobInstanceBaseParams): Promise<CancelItemJobResult>Parameters
- jobParams
-
ItemJobInstanceBaseParams
Returns
Promise<CancelItemJobResult>
createItemScheduledJobs(CreateItemScheduleParams)
function createItemScheduledJobs(createItemScheduledJobs: CreateItemScheduleParams): Promise<ItemSchedule>Parameters
- createItemScheduledJobs
- CreateItemScheduleParams
Returns
Promise<ItemSchedule>
deleteItemScheduledJobs(DeleteItemScheduleParams)
This API is used to delete schedule given item object id, job definition id and item job type.
function deleteItemScheduledJobs(deleteItemScheduleParams: DeleteItemScheduleParams): Promise<DeleteItemScheduleResult>Parameters
- deleteItemScheduleParams
- DeleteItemScheduleParams
Returns
Promise<DeleteItemScheduleResult>
getItemJobHistory(GetItemJobHistoryParams)
function getItemJobHistory(getHistoryParams: GetItemJobHistoryParams): Promise<ItemJobHistory>Parameters
- getHistoryParams
- GetItemJobHistoryParams
Returns
Promise<ItemJobHistory>
getItemScheduledJobs(string)
Warning
This API is now deprecated.
use listItemSchedules instead.
function getItemScheduledJobs(objectId: string): Promise<ItemSchedule>Parameters
- objectId
-
string
Returns
Promise<ItemSchedule>
listItemSchedules(ListItemSchedulesParams)
An item can have multiple job types, each with its own distinct job schedule. This API is used to retrieve schedule list for specific item.
function listItemSchedules(listItemSchedulesParams: ListItemSchedulesParams): Promise<ListItemSchedulesResponse>Parameters
- listItemSchedulesParams
- ListItemSchedulesParams
Include the object id of the item.
Returns
Promise<ListItemSchedulesResponse>
runItemJob(RunItemJobParams)
function runItemJob(jobParams: RunItemJobParams): Promise<ItemJobInstance>Parameters
- jobParams
- RunItemJobParams
Returns
Promise<ItemJobInstance>
updateItemScheduledJobs(CreateItemScheduleParams)
function updateItemScheduledJobs(updateItemScheduleParams: CreateItemScheduleParams): Promise<ItemSchedule>Parameters
- updateItemScheduleParams
- CreateItemScheduleParams
Returns
Promise<ItemSchedule>