tasks-controller/org.artofdev.tasks.controller/TasksRestController

TasksRestController

@RestController

@RequestMapping(value = ["/api/"])

class TasksRestController(config: TaskControllerConfig, taskService: TaskService, taskRepo: TaskRepo, pluginManagerService: PluginManagerService)

Constructors

TasksRestController

constructor(config: TaskControllerConfig, taskService: TaskService, taskRepo: TaskRepo, pluginManagerService: PluginManagerService)

Functions

cancelTask

@PostMapping(value = ["/task/cancel/{taskId}"])

fun cancelTask(@RequestHeader headers: HttpHeaders, @PathVariable(value = "taskId") taskId: Long): Task

createTask

@PutMapping(value = ["/tasks"])

fun createTask(@RequestHeader headers: HttpHeaders, @RequestBody request: TaskRequest): Task

endTask

@PostMapping(value = ["/task/end/{taskId}"])

fun endTask(@RequestHeader headers: HttpHeaders, @RequestBody request: EndTaskRequest, @PathVariable(value = "taskId") taskId: Long): Task

getPipelineTasksResults

@GetMapping(value = ["/pipeline/task-results/{pipelineTaskId}"])

fun getPipelineTasksResults(@RequestHeader headers: HttpHeaders, @PathVariable(value = "pipelineTaskId") pipelineTaskId: Long, @RequestParam(value = "taskTypeHid", required = false) taskTypeHids: List<String>?, @PageableDefault(size = 100, sort = ["id"], direction = Sort.Direction.ASC) pageable: Pageable): Page<PipelineTaskResult>

getTask

@GetMapping(value = ["/tasks/{taskId}"])

fun getTask(@RequestHeader headers: HttpHeaders, @PathVariable(value = "taskId") taskId: Long): Task

getTaskByHid

@GetMapping(value = ["/tasksByHid/{taskHid}"])

fun getTaskByHid(@RequestHeader headers: HttpHeaders, @PathVariable(value = "taskHid") taskHid: String): ResponseEntity<Task>

getTaskInput

@GetMapping(value = ["/task/input/{taskId}"])

fun getTaskInput(@RequestHeader headers: HttpHeaders, @PathVariable(value = "taskId") taskId: Long): TaskData?

getTaskProgress

@GetMapping(value = ["/task/progress/{taskId}"])

fun getTaskProgress(@RequestHeader headers: HttpHeaders, @PathVariable(value = "taskId") taskId: Long): TaskProgress?

getTaskResult

@GetMapping(value = ["/task/result/{taskId}"])

fun getTaskResult(@RequestHeader headers: HttpHeaders, @PathVariable(value = "taskId") taskId: Long): TaskResult

getTasks

@GetMapping(value = ["/tasks"])

fun getTasks(@RequestHeader headers: HttpHeaders, @RequestParam(value = "runningStatus", required = false) runningStatuses: List<Task.RunningStatus>?, @RequestParam(value = "taskTypeHid", required = false) taskTypeHids: List<String>?, @RequestParam(value = "taskTypeCategory", required = false) taskTypeCategory: TaskTypeCategory?, @RequestParam(value = "extId", required = false) extId: String?, @RequestParam(value = "pipelineTaskId", required = false) pipelineTaskId: Long?, @PageableDefault(size = 100, sort = ["id"], direction = Sort.Direction.ASC) pageable: Pageable): Page<TaskWithProgress>

getTaskTypeHids

@GetMapping(value = ["/task-type-hids"])

fun getTaskTypeHids(@RequestHeader headers: HttpHeaders): List<String>

getTaskTypes

@GetMapping(value = ["/task-types"])

fun getTaskTypes(@RequestHeader headers: HttpHeaders): List<TaskType>

handleIllegalArgumentException

@ExceptionHandler(value = [IllegalArgumentException::class])

fun handleIllegalArgumentException(ex: IllegalArgumentException): ResponseEntity<String?>

rerunTask

@PostMapping(value = ["/task/rerun/{taskId}"])

fun rerunTask(@RequestHeader headers: HttpHeaders, @PathVariable(value = "taskId") taskId: Long): Task

startTask

@PostMapping(value = ["/task/start/{taskId}"])

fun startTask(@RequestHeader headers: HttpHeaders, @PathVariable(value = "taskId") taskId: Long): Task?

takeTaskForExecution

@PostMapping(value = ["/task/takeForExec"])

fun takeTaskForExecution(@RequestHeader headers: HttpHeaders, @RequestParam(value = "execTypeHid") execTypeHid: String, @RequestParam(value = "execHid") execHid: String): ResponseEntity<TaskExecDataResponse>