Task Scheduler REST API - v1

This API describes the REST interface to interact with the Task Scheduler

More information:
Customer documentation
https://infoproducts.alcatel-lucent.com/cgi-bin/doc_welc.pl
Technical support
http://support.alcatel-lucent.com
Documentation feedback
documentation.feedback@nokia.com
BasePath:/task-scheduler

Access

Methods

[ Jump to Models ]

Table of Contents

  1. post /api/v1/tasks
  2. delete /api/v1/tasks/{taskId}
  3. get /api/v1/tasks/{taskId}
  4. get /api/v1/tasks/{taskId}/results
  5. get /api/v1/results
  6. get /api/v1/tasks
  7. delete /api/v1/removeAllTasks
  8. put /api/v1/tasks/{taskId}/resetStatus
Up
post /api/v1/tasks
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

ResponseData«object»

Produces

This API call produces the following media types according to the Accept 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

ResponseData«object»

Produces

This API call produces the following media types according to the Accept 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

Task

Produces

This API call produces the following media types according to the Accept 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

ResponseData«List«TaskExecutionResult»»

Produces

This API call produces the following media types according to the Accept 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

Up
get /api/v1/results
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

ResponseData«List«TaskExecutionResult»»

Produces

This API call produces the following media types according to the Accept 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

Up
get /api/v1/tasks
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

ResponseData«List«Task»»

Produces

This API call produces the following media types according to the Accept 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 (removeAllTasks)
Delete all task objects

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«object»

Produces

This API call produces the following media types according to the Accept 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

ResponseData«Task»

Produces

This API call produces the following media types according to the Accept 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

Up

Models

[ Jump to Methods ]

Table of Contents

  1. JSONObject
  2. RecurrenceInfo
  3. Request«TaskRequest»
  4. ResponseData«List«TaskExecutionResult»»
  5. ResponseData«List«Task»»
  6. ResponseData«Task»
  7. ResponseData«object»
  8. Response«List«TaskExecutionResult»»
  9. Response«List«Task»»
  10. Response«Task»
  11. Response«object»
  12. SubTask
  13. SubTaskRecurrenceInfo
  14. SubTaskRequest
  15. Task
  16. TaskExecutionResult
  17. TaskRequest

JSONObject Up

empty (optional)

RecurrenceInfo Up

recurrenceType (optional)
String Specifies the recurrence type
Enum:
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
Enum:
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

Request«TaskRequest» Up

data (optional)

ResponseData«List«TaskExecutionResult»» Up

response (optional)

ResponseData«List«Task»» Up

response (optional)

ResponseData«Task» Up

response (optional)

ResponseData«object» Up

response (optional)

Response«List«TaskExecutionResult»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«Task»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«Task» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«object» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

SubTask Up

id (optional)
name (optional)
operationRole (optional)
executionDate (optional)
executionTime (optional)
executionStatus (optional)
Enum:
NOT_EXECUTED
FAILED
SUCCESS
recurrenceInfo (optional)
method (optional)
Enum:
GET
POST
HEAD
OPTIONS
PUT
PATCH
DELETE
TRACE
uri (optional)
payload (optional)

SubTaskRecurrenceInfo Up

recurrenceType (optional)
Enum:
NEVER
DAILY
WEEKLY
MONTHLY
recurEvery (optional)
startDate (optional)
endDate (optional)
expiresOnType (optional)
Enum:
NO_END_DATE
END_AFTER
END_BY
endAfterOccurrence (optional)
daysOfWeek (optional)
dayOfMonth (optional)

SubTaskRequest Up

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)
Enum:
NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS
method (optional)
String Specifies the southbound api HTTP request method
Enum:
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)
RecurrenceInfo Specifies the recurrence information

Task Up

version (optional)
creator (optional)
lastUpdate (optional)
timeStamp (optional)
id (optional)
taskId (optional)
taskName (optional)
taskStatus (optional)
Enum:
ENABLED
DISABLED
NOT_SCHEDULED
SCHEDULED
DONE
ERROR
executionStatus (optional)
Enum:
NOT_EXECUTED
FAILED
SUCCESS
appId (optional)
runningSubtaskId (optional)
subtaskList (optional)

TaskExecutionResult Up

id (optional)
resultId (optional)
taskId (optional)
subTaskId (optional)
result (optional)
Enum:
NOT_EXECUTED
FAILED
SUCCESS
status (optional)
executionTime (optional)
subTaskName (optional)

TaskRequest Up

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)
array[SubTaskRequest] The list of sub-tasks associated with this task
taskType (optional)
String Specifies the type of the task
Enum:
BANDWIDTH_CALENDAR
SYSTEM_BACKUP
NOT_SPECIFIED