Tasks API

The task suite of Rest API methods allows to create, start, stop and list SymetryML Kafka stream applications. These applications are meant to automatically perform prediction on a Kafka Topic and then save the prediction results in another Kafka topic.

There is a maximum number of task that can be run at the same time. This number is controlled by the sml.task.max SymetryML control parameter. Please consult the Installation Guide - SymetryML REST Configuration for more details on how to set this parameters. The default value for this sml.task.max parameter is 4. Please consult the SML Kafka Stream Application Documentation for details.

Some additional parameters can be set inside the TaskInfo JSON data structure with the params map field:

Task Create

This API function creates a Task. Please see Data Source Encryption for information on how to encrypt TaskInfo data structures.

URL

POST /symetry/rest/{cid}/tasks/create [Body=TaskInfo (encrypted)]

HTTP Responses

Task Start

This rest endpoint start a task.

URL

GET /symetry/rest/{cid}/tasks/{tid}/start

HTTP Responses

Task Start

This rest endpoint stop a task.

URL

GET /symetry/rest/{cid}/tasks/{tid}/stop

HTTP Responses

Task List

This rest endpoint return a list of tasks that belong to a given project for a given user.

URL

GET /{cid}/tasks

HTTP Responses

HTTP Response Entity

Delete a Task

Delete a task If the task is running it will first be stopped.

URL

DELETE /symetry/rest/{cid}/tasks/{tid}

Canonical URL Parameters

HTTP Responses

Task Status

This rest endpoint return information about a task.

URL

GET /symetry/rest/{cid}/tasks/{tid}

HTTP Responses

HTTP Response Entity

Status Parameter returned