Task Scheduler REST API - v1
This API describes the REST interface to interact with the Task Scheduler
BasePath:/task-scheduler
Access
[ Jump to Models ]
Table of Contents
post /api/v1/tasksdelete /api/v1/tasks/{taskId}delete /api/v1/tasksget /api/v1/tasks/{taskId}get /api/v1/tasks/{taskId}/resultsget /api/v1/tasksdelete /api/v1/removeAllTasksput /api/v1/tasks/{taskId}/resetStatusget /api/v1/results
Create a scheduler task (createTask)
Create a scheduler task
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (optional)
Body Parameter — Request to schedule a new task. The task can contain multiple sub-tasks depending on the task type.
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«object»
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
Up
delete /api/v1/tasks/{taskId}
Delete a scheduler task (deleteTask)
Delete a scheduler task
Path parameters
taskId (required)
Path Parameter — taskId
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«object»
401
Unauthorized
204
No Content
403
Forbidden
Delete all task objects (deleteTasks)
Delete all task objects
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«object»
401
Unauthorized
204
No Content
403
Forbidden
Up
get /api/v1/tasks/{taskId}
Query a task object (getRequest)
Query a task object
Path parameters
taskId (required)
Path Parameter — taskId
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
Task
401
Unauthorized
403
Forbidden
404
Not Found
Up
get /api/v1/tasks/{taskId}/results
Query all results associated with the given task (getTaskExecutionResult)
Query all results associated with the given task
Path parameters
taskId (required)
Path Parameter — taskId
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«TaskExecutionResult»»
401
Unauthorized
403
Forbidden
404
Not Found
Query all task objects (getTasks)
Query all task objects
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«Task»»
401
Unauthorized
403
Forbidden
404
Not Found
Up
delete /api/v1/removeAllTasks
Delete all task objects - Deprecated (removeAllTasks)
Delete all task objects - Deprecated
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«object»
401
Unauthorized
204
No Content
403
Forbidden
Up
put /api/v1/tasks/{taskId}/resetStatus
Reset the execution status of a task and all its subtasks (resetTaskStatus)
Reset the execution status of a task and all its subtasks
Path parameters
taskId (required)
Path Parameter — taskId
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«Task»
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
Query all task execution results (getTaskExecutionResults)
Query all task execution results
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
success
ResponseData«List«TaskExecutionResult»»
401
Unauthorized
403
Forbidden
404
Not Found
[ Jump to Methods ]
Table of Contents
JSONObjectRecurrenceInfoRequest«TaskRequest»ResponseData«List«TaskExecutionResult»»ResponseData«List«Task»»ResponseData«Task»ResponseData«object»Response«List«TaskExecutionResult»»Response«List«Task»»Response«Task»Response«object»SubTaskSubTaskRecurrenceInfoSubTaskRequestTaskTaskExecutionResultTaskRequest
recurrenceType (optional)
String Specifies the recurrence type
NEVER
DAILY
WEEKLY
MONTHLY
recurEvery (optional)
Integer Specifies the interval between every occurrence. The interval unit is based on the recurrence type
startDate (optional)
String Specifies the start date of the recurrence. Sub-task execution will start on the same day if the start date is not specified
endDate (optional)
String Specifies the end date of the recurrence. This field is required if expiresOnType is defined as END_BY
expiresOnType (optional)
String Specifies the termination policy of the recurrence. The sub-task can be executed forever, end after a number of occurrences, or end by an end date
NO_END_DATE
END_AFTER
END_BY
endAfterOccurrence (optional)
Integer Specifies the number of occurrences of the sub-task execution
dayOfWeekSet (optional)
array[String] Specifies the days of week at which the sub-task has to be executed
dayOfMonth (optional)
Integer Specifies the day of month at which the sub-task has to be executed
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
id (optional)
name (optional)
operationRole (optional)
executionDate (optional)
executionTime (optional)
executionStatus (optional)
NOT_EXECUTED
FAILED
SUCCESS
recurrenceInfo (optional)
method (optional)
GET
POST
HEAD
OPTIONS
PUT
PATCH
DELETE
TRACE
uri (optional)
payload (optional)
recurrenceType (optional)
NEVER
DAILY
WEEKLY
MONTHLY
recurEvery (optional)
startDate (optional)
endDate (optional)
expiresOnType (optional)
NO_END_DATE
END_AFTER
END_BY
endAfterOccurrence (optional)
daysOfWeek (optional)
dayOfMonth (optional)
name (optional)
String Specifies a custom name for the sub-task
taskRoleName (optional)
String Specifies the role of the sub-task
startDate (optional)
String Specifies an execution date for the sub-task if the sub-task is a onetime task
startTime (optional)
String Specifies the execution time of the sub-task
interval (optional)
Integer Specifies an execution interval for the sub-task (deprecated)
intervalTimeUnit (optional)
String Specifies the interval time unit for the sub-task (deprecated)
NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS
method (optional)
String Specifies the southbound api HTTP request method
GET
POST
HEAD
OPTIONS
PUT
PATCH
DELETE
TRACE
uri (optional)
String Specifies the URI of the southbound request
payload (optional)
JSONObject Payload is a json object containing all the information a REST API will require in terms of a valid REST request.
repeats (optional)
Boolean Specifies whether this is a recurring or a onetime task
recurrenceInfo (optional)
version (optional)
creator (optional)
lastUpdate (optional)
timeStamp (optional)
id (optional)
taskId (optional)
taskName (optional)
taskStatus (optional)
ENABLED
DISABLED
NOT_SCHEDULED
SCHEDULED
DONE
ERROR
executionStatus (optional)
NOT_EXECUTED
FAILED
SUCCESS
appId (optional)
runningSubtaskId (optional)
subtaskList (optional)
id (optional)
resultId (optional)
taskId (optional)
subTaskId (optional)
result (optional)
NOT_EXECUTED
FAILED
SUCCESS
status (optional)
executionTime (optional)
subTaskName (optional)
taskName (optional)
String Specifies a client-defined custom name for the task
appId (optional)
String Specifies the client-defined, custom Application ID of the task
subTasks (optional)
taskType (optional)
String Specifies the type of the task
BANDWIDTH_CALENDAR
SYSTEM_BACKUP
NOT_SPECIFIED