ItemScheduleAPI interface
Methods
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>
getItemJobHistory(GetItemJobHistoryParams)
function getItemJobHistory(getHistoryParams: GetItemJobHistoryParams): Promise<ItemJobHistory>
Parameters
- getHistoryParams
- GetItemJobHistoryParams
Returns
Promise<ItemJobHistory>
getItemScheduledJobs(string)
function getItemScheduledJobs(objectId: string): Promise<ItemSchedule>
Parameters
- objectId
-
string
Returns
Promise<ItemSchedule>
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>