Webservice: Task

interaction with scheduled tasks [Commercial editions only]

Index Method Request(s) Response Description
1 listTasks sid
task list of all available tasks
2 getTask sid
name
task gets a specific task
3 enable sid
name
enables a task
4 disable sid
name
disables a task
5 getLog sid
name
gets the log file of a given task
6 start sid
name
starts a task
7 stop sid
name
gracefully stops a task

Method #1: listTasks

list of all available tasks

Request

Name Type Required Multiple Description
     sid
String Y

Response

Name Type Required Multiple Description
     task
WSTask Y Y
          name
String Y unique identifier
          status
Int Y 0 = idle, 1 = running, 2 = stopping
          size
Long Y total number of units of work
          progress
Long Y number of units of work already processed
          completion
Int Y completion percentage
          indeterminate
Boolean Y if false this task is not able to calculate the size of the elaboration
          concurrent
Boolean Y if true this task supports concurrent executions
          enabled
Boolean Y if true this task is enabled and available for execution

Method #2: getTask

gets a specific task

Request

Name Type Required Multiple Description
     sid
String Y
     name
String Y

Response

Name Type Required Multiple Description
     task
WSTask Y
          name
String Y unique identifier
          status
Int Y 0 = idle, 1 = running, 2 = stopping
          size
Long Y total number of units of work
          progress
Long Y number of units of work already processed
          completion
Int Y completion percentage
          indeterminate
Boolean Y if false this task is not able to calculate the size of the elaboration
          concurrent
Boolean Y if true this task supports concurrent executions
          enabled
Boolean Y if true this task is enabled and available for execution

Method #3: enable

enables a task

Request

Name Type Required Multiple Description
     sid
String Y
     name
String Y

Method #4: disable

disables a task

Request

Name Type Required Multiple Description
     sid
String Y
     name
String Y

Method #5: getLog

gets the log file of a given task

Request

Name Type Required Multiple Description
     sid
String Y
     name
String Y

Response

Name Type Required Multiple Description
    
DataHandler Y

Method #6: start

starts a task

Request

Name Type Required Multiple Description
     sid
String Y
     name
String Y

Method #7: stop

gracefully stops a task

Request

Name Type Required Multiple Description
     sid
String Y
     name
String Y