Mistral/RestAPIv2 - Revision history

D0ugal at 12:40, 6 March 2018

2018-03-06T12:40:13Z

Rakhmerov: Replaced content with "Please see the spec at: http://docs.openstack.org/developer/mistral/developer/webapi/v2.html"

2015-10-25T12:42:05Z

Replaced content with "Please see the spec at: http://docs.openstack.org/developer/mistral/developer/webapi/v2.html"

Show changes

Nikolay: /* Cron Trigger [/cron_triggers/{id}] */

2015-07-01T11:12:11Z

‎Cron Trigger [/cron_triggers/{id}]

Show changes

Nikolay: /* Mistral API v2 */

2015-07-01T10:50:19Z

‎Mistral API v2

Nikolay: /* Environment [/environments/{name}] */

2015-05-12T10:12:11Z

‎Environment [/environments/{name}]

Nikolay: /* Mistral API v2 */

2015-05-06T12:58:29Z

‎Mistral API v2

Nikolay: /* Action Execution [/tasks/{id}] */

2015-05-06T09:28:09Z

‎Action Execution [/tasks/{id}]

Nikolay: /* Action Execution [/action_executions/{action-execution-id}] */

2015-05-06T09:27:44Z

‎Action Execution [/action_executions/{action-execution-id}]

Show changes

Nikolay: /* Mistral API v2 */

2015-05-06T08:49:09Z

‎Mistral API v2

Nikolay: /* Task [/tasks/{id}] */

2015-05-06T08:43:10Z

‎Task [/tasks/{id}]

← Older revision		Revision as of 12:40, 6 March 2018
Line 1:		Line 1:
−	Please see the ~~spec at: http~~://docs.openstack.org~~/developer~~/mistral/~~developer~~/~~webapi~~/v2.html	+	== This Wiki is no longer maintained ==
		+
		+	Please see the [https://docs.openstack.org/mistral/latest/api/index.html Mistral API documentation].

@@ Line 447: / Line 447: @@
       "updated_at": "2014-09-25 03:35:36"
+  }
 === Task [/tasks/{id}] ===

← Older revision		Revision as of 10:12, 12 May 2015
Line 641:		Line 641:

	=== Environment [/environments/{name}] ===		=== Environment [/environments/{name}] ===
		+
		+	Environment contains a set of variables which can be used in specific workflow. Using Environment possible to create and map action default values - just provide '__actions' key in 'variables'. All these variables can be accessed in workflow DSL by <% $.__env %> expression. Example:
		+
		+
		+	workflow:
		+	tasks:
		+	task1:
		+	action: std.echo output=<% $.__env.my_echo_output %>
		+
		+	Example of creating action defaults:
		+
		+	...ENV...
		+	"variables": {
		+	"__actions": {
		+	"std.echo": {
		+	"output": "my_output"
		+	}
		+	}
		+	},
		+	...ENV...
		+

	Environment has the following attributes:		Environment has the following attributes:

← Older revision		Revision as of 12:58, 6 May 2015
Line 638:		Line 638:
	"state": "ERROR"		"state": "ERROR"
	}		}
		+
		+
		+	=== Environment [/environments/{name}] ===
		+
		+	Environment has the following attributes:
		+
		+	* id
		+	* name
		+	* description
		+	* variables
		+	* scope
		+	* created_at
		+	* updated_at
		+
		+	'''name''' is immutable.
		+
		+	==== URL Parameters ====
		+
		+	* name - Environment name.
		+
		+	==== Model ====
		+
		+	{
		+	"name" : "my_env",
		+	"description": "My cool env",
		+	"variables" : "{
		+	\"var1\": 3,
		+	\"var2\": \"hello\"
		+	}",
		+	"created_at" : "2014-09-25 03:35:36",
		+	"updated_at" : "2014-09-25 03:35:36",
		+	}
		+
		+	==== Retrieve Environment list [GET] ====
		+	* '''URL:''' /environments
		+	* '''Status:''' 200
		+	* '''Returns:''' List of Environments
		+
		+	'''Response'''
		+	{
		+	"environments": [
		+	{
		+	"name" : "my_env",
		+	"description": "My cool env",
		+	"variables" : "{}",
		+	"created_at" : "2014-09-25 03:35:36",
		+	"updated_at" : "2014-09-25 03:35:36",
		+	}
		+	]
		+	}
		+
		+	==== Retrieve a single Environment [GET] ====
		+	* '''URL:''' /environments/{environment_name}
		+	* '''Status:''' 200
		+	* '''Returns:''' Environment
		+
		+	'''Response'''
		+	{
		+	"name" : "my_env",
		+	"description": "My cool env",
		+	"variables" : "{}",
		+	"created_at" : "2014-09-25 03:35:36",
		+	"updated_at" : "2014-09-25 03:35:36",
		+	}
		+
		+	==== Create an Environment [POST] ====
		+	To create a new Environment simply provide a JSON structure containing at least attributes 'name' and 'variables'.
		+
		+	* '''URL:''' /environments
		+	* '''Status:''' 201
		+	* '''Returns:''' created Environment
		+
		+	'''Request (application/json)'''
		+	{
		+	"name" : "my_env",
		+	"variables": "{\"my_var\": 33}"
		+	}
		+
		+	==== Update an Environment [PUT] ====
		+	To modify an Environment simply send a JSON structure containing attributes 'name' and 'variables'.
		+
		+	* '''URL:''' /environments
		+	* '''Status:''' 200
		+	* '''Returns:''' Environment
		+
		+	'''Request example'''
		+	{
		+	"name" : "my_env",
		+	"variables": "{\"my_var\": 33}"
		+	}
		+
		+	==== Delete an Environment [DELETE] ====
		+
		+	* '''URL:''' /environments/{environment_name}
		+	* '''Status:''' 204
		+	* '''Returns:''' No content

← Older revision		Revision as of 09:28, 6 May 2015
Line 536:		Line 536:


−	=== Action Execution [/~~tasks~~/{id}] ===	+	=== Action Execution [/action_executions/{id}] ===
	When a Task starts Mistral creates a set of Action Executions. So Action Execution is an instance of a action call described in a Workflow Task that belongs to a particular execution.		When a Task starts Mistral creates a set of Action Executions. So Action Execution is an instance of a action call described in a Workflow Task that belongs to a particular execution.

← Older revision		Revision as of 08:49, 6 May 2015
Line 534:		Line 534:
	* '''Status:''' 200		* '''Status:''' 200
	* '''Returns:''' Action Execution list		* '''Returns:''' Action Execution list
		+
		+
		+	=== Action Execution [/tasks/{id}] ===
		+	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.
		+
		+	A Task has the following attributes:
		+
		+	* id
		+	* name
		+	* wf_name
		+	* execution_id
		+	* result
		+	* input
		+	* output
		+	* created_at
		+	* updated_at
		+
		+	"'''state'''" can take one of the following values:
		+
		+	* IDLE
		+	* RUNNING
		+	* SUCCESS
		+	* ERROR
		+	* DELAYED
		+
		+	==== URL Parameters ====
		+	* id (string) - Task id.
		+
		+	==== Model ====
		+	{
		+	"id": "12434234",
		+	"name": "create_vm",
		+	"workflow_name": "my_workflow",
		+	"execution_id": "12304593450234",
		+	"input": {
		+	"image_id": "1-2-3-4"
		+	},
		+	"state": "RUNNING",
		+	"created_at": "2014-09-25 03:35:36",
		+	"updated_at": "2014-09-25 03:35:36"
		+	}
		+
		+	==== Retrieve Task list [GET] ====
		+
		+	* '''URL:''' /tasks
		+	* '''Status:''' 200
		+	* '''Returns:''' Task list
		+
		+	'''Response example'''
		+	{
		+	"tasks": [
		+	{
		+	"id": "12434234",
		+	"name": "create_vm",
		+	"workflow_name": "my_workflow",
		+	"execution_id": "12304593450234",
		+	"input": {
		+	"image_id": "1-2-3-4"
		+	},
		+	"state": "SUCCESS",
		+	"created_at": "2014-09-25 03:35:36",
		+	"updated_at": "2014-09-25 03:35:36"
		+	},
		+	{
		+	"id": "12434235",
		+	"name": "associate_ip",
		+	"workflow_name": "my_workflow",
		+	"execution_id": "12304593450234",
		+	"input": {
		+	"vm_id": "1-2-3-4"
		+	},
		+	"state": "RUNNING",
		+	"created_at": "2014-09-25 03:35:36",
		+	"updated_at": "2014-09-25 03:35:36"
		+	},
		+	]
		+	}
		+
		+	==== Retrieve a single task [GET] ====
		+
		+	* '''URL:''' /tasks/{task-id}
		+	* '''Status:''' 200
		+	* '''Returns:''' Task
		+
		+	==== Update a task [PUT] ====
		+	The only two sensible fields to update are '''"state"''' and '''"result"'''. When using asynchronous processing they can be used to notify Mistral with task state and result.
		+
		+	* '''URL:''' /tasks/{task-id}
		+	* '''Status:''' 200
		+	* '''Returns:''' Task
		+
		+	'''Request example'''
		+	{
		+	"id": "12434234",
		+	"state": "ERROR"
		+	}

@@ Line 455: / Line 455: @@
 * id
 * name
-* wf_name
+* workflow_name
-* execution_id
+* workflow_execution_id
 * result
-* input
+* published
 * created_at
 * updated_at
@@ Line 530: / Line 529: @@
 * '''Returns:''' Task
-==== Update a task [PUT] ====
+==== Retrieve Action Execution list related to specific Task [GET] ====
-* '''URL:''' /tasks/{task-id}
+* '''URL:''' /tasks/{task-id}/action_executions
 * '''Status:''' 200
-* '''Returns:''' Task
+* '''Returns:''' Action Execution list