Skip to content
Jakub Klímek edited this page Mar 24, 2016 · 10 revisions

REST API

URL Method Description
/api/v1/execute?uri={IRI} POST Starts execution of given pipeline, determiend by {IRI}. The IRI must be of a local pipeline, ie. obtained from /resources/pipelines. Response contains ID of newly created execution.
URL Method Description
/resources/components GET Return list of all stored components.
/resources/components/{id} GET Return detail of the component.
/resources/components/{id}/configuration GET Return component's default configuration.
/resources/pipelines GET Return list of all stored pipelines.
/resources/pipelines/{id} GET Return detail of the pipeline.
/resources/pipelines/{id} DELETE Delete the pipeline.
/resources/pipelines/{id} POST Create a new empty pipeline and return its ID.
/resources/pipelines/{id}?unchecked={UNCHECKED} PUT Set content of given pipeline. UNCHECKED is true pipeline is saved in the save form as it was given. If it's false application tries to convert pipeline and all components URI to so they are dereferencable on the machine. UNCHECKED should be tru when importing pipeline.
/resources/executions GET Return list of all stored executions.
/resources/executions/{id} GET Return detail of the executions.
/resources/executions/{id} DELETE Delete given execution.
/resources/executions/{id}/messages GET Return messages emitted in the execution.
/resources/executions/{id}/logs GET Return log file for the execution.
/resources/executions/{id}/labels GET Return labels for all resource used in execution.
/resources/executions/{id}/debug GET Return debug data for the execution.
Clone this wiki locally