3.1 KiB
V2 API
Warning
(2014-10-5): API described in this document might slightly change within a short period of time (2-3 weeks) and should be now considered experimental. Mistral team is now actively working on stabilization.
This API describes the ways of interacting with Mistral service via HTTP protocol using Representational State Transfer concept (ReST).
Basics
Media Types
Currently this API relies on JSON to represent states of REST resources.
Error States
The common HTTP Response Status Codes (https://github.com/for-GET/know-your-http-well/blob/master/status-codes.md) are used.
Application Root [/]
Application Root provides links to all possible API methods for Mistral. URLs for other resources described below are relative to Application Root.
API v2 Root [/v2/]
All API v2 urls are relative to API v2 root.
Workbooks
mistral.api.controllers.v2.workbook.Workbook
name is immutable. tags is a list of values associated with a workbook that a user can use to group workbooks by some criteria (deployment workbooks, Big Data processing workbooks etc.). Note that name and tags get inferred from workbook definition when Mistral service receives a POST request. So they can't be changed in another way.
mistral.api.controllers.v2.workbook.Workbooks
mistral.api.controllers.v2.workbook:WorkbooksController
Workflows
mistral.api.controllers.v2.workflow.Workflow
name is immutable. tags is a list of values associated with a workflow that a user can use to group workflows by some criteria. Note that name and tags get inferred from workflow definition when Mistral service receives a POST request. So they can't be changed in another way.
mistral.api.controllers.v2.workflow.Workflows
mistral.api.controllers.v2.workflow:WorkflowsController
Actions
mistral.api.controllers.v2.action.Action
mistral.api.controllers.v2.action.Actions
mistral.api.controllers.v2.action:ActionsController
Executions
mistral.api.controllers.v2.execution.Execution
mistral.api.controllers.v2.execution.Executions
mistral.api.controllers.v2.execution:ExecutionsController
Tasks
When a workflow starts Mistral creates an execution. It in turn consists of a set of tasks. So Task is an instance of a task described in a Workflow that belongs to a particular execution.
mistral.api.controllers.v2.task.Task
mistral.api.controllers.v2.task.Tasks
mistral.api.controllers.v2.task:TasksController
mistral.api.controllers.v2.task:ExecutionTasksController