2. REST API

The REANA-Workflow-Controller component offers a REST API for managing workflows. Detailed REST API documentation can be found here.

REANA Workflow Controller REST API.

reana_workflow_controller.rest.close_interactive_session(workflow_id_or_name)

Close an interactive workflow session.

reana_workflow_controller.rest.create_workflow()

Create workflow and its workspace.

reana_workflow_controller.rest.delete_file(workflow_id_or_name, file_name)

Delete the specified file.

reana_workflow_controller.rest.download_file(workflow_id_or_name, file_name)

Returns the requested file.

reana_workflow_controller.rest.get_files(workflow_id_or_name)

Returns the workspace file list.

reana_workflow_controller.rest.get_specification_diff(workflow_a, workflow_b, output_format='unified')

` <_static/api.html#operation/>`_

reana_workflow_controller.rest.get_workflow_diff(workflow_id_or_name_a, workflow_id_or_name_b)

Get diff between two workflows.

reana_workflow_controller.rest.get_workflow_logs(workflow_id_or_name)

Returns logs of a specific workflow from a workflow engine.

reana_workflow_controller.rest.get_workflow_parameters(workflow_id_or_name)

Get workflow parameters.

reana_workflow_controller.rest.get_workflow_status(workflow_id_or_name)

Get workflow status.

reana_workflow_controller.rest.get_workflows()

Returns all workflows.

reana_workflow_controller.rest.get_workspace_diff(workflow_a, workflow_b, brief=False, context_lines=5)

` <_static/api.html#operation/>`_

reana_workflow_controller.rest.move_files(workflow_id_or_name)

Move files within workspace.

reana_workflow_controller.rest.open_interactive_session(workflow_id_or_name, interactive_session_type)

Start an interactive session inside the workflow workspace.

reana_workflow_controller.rest.set_workflow_status(workflow_id_or_name)

Set workflow status.

reana_workflow_controller.rest.upload_file(workflow_id_or_name)

Adds a file to the workspace.