This page contains the description of the REST interface to the Meandre Infrastructure version 1.4
- 1. Introduction
- 2. About requests
- 3. Location requests
- 4. Repository requests
- 4.1 dump
- 4.2 regenerate
- 4.3 list_components
- 4.4 list_flows
- 4.5 tags
- 4.6 tags_components
- 4.7 tags_flows
- 4.8 components_by_tag
- 4.9 flows_by_tag
- 4.10 describe
- 4.11 describe_component
- 4.12 describe_all_components
- 4.13 describe_flow
- 4.14 describe_all_flows
- 4.15 search_components
- 4.16 search_flows
- 4.17 remove
- 4.18 add
- 4.19 add_flow_description
- 4.20 clear
- 5. Public requests
- 6. Publish requests
- 7. Execute requests
- 7.1 flow
- 7.2 list_running_flows
- 7.3 url
- 7.4 web_component_url
- 7.5 uri_flow
- 7.6 clean_uri_flow
- 7.7 repository
- 8. Coordinator requests
- 9. Job requests
- 10. Server requests
- 11. Security requests
- 11.1 current_roles
- 11.2 roles_of_user
- 11.3 users
- 11.4 user
- 11.5 valid_roles
- 11.6 grant_roles
- 11.7 revoke_roles
- 11.8 create_users
- 11.9 remove_users
- 11.10 update_users
- 11.11 revoke_all_roles
- 12. Running flow admin requests
1. Introduction
The Meandre infrastructure has the ability to expose its functionality via a web-based Application Programming Interface (API). This document is a reference for that functionality, and aims to serve as a reference for developers building tools that communicate to the Meandre infrastructure.
Web APIs come in a several styles. Some require users to pass chunks of XML data back and forth, but most use a simple method known as the RESTful approach. REST stands for Representational State Transfer
, a process that uses URLs as "interfaces" for reading and writing information to a service. Meandre core webservices rely heavily on the REST approach.
When parameters are provided, multiple addition of the parameters produce the execution of the service for each of the provided elements. That is, if a rest command requires parameter X, passing ?X=value1&X=value2... will trigger the service to loop through the values, providing and aggregated response as a result.
Responses can be classified in two types:
- Responses that return RDF
- Responses that return non RDF information
RDF responses support three dialects: RDF/XML, TTL, and N-TRIPLE. That is, for a given request, the <format> extension controls what format the response is it going to be in. If the <format> is specified as rdf, ttl, or nt, it will return, respectively, RDF/XML, TTL, or N-TRIPLE. Non RDF responses have also been standardized and supports four formats: JSON, plain text, XML, and HTML---noted as json, txt, xml, html. HTML format is provided by rendering convenience on the browser to provide a light weight interface to the infrastructure. The HTML interface won't be discussed in this section, since detailed information can be found on the Meandre Infrastructure HTML interface v. 1.4 page. For each of the other formats responses has been standardized as follows:
JSON response schema example
TXT response schema example
XML response example
2. About requests
The about requests provide information about the Meandre infrastructure.
2.1 version
| Description | Returns the version of the Meandre infrastructure. |
| URL | http://<meandre_host>:<meandre_port>/services/about/installation.<format> |
| Method | GET |
| Since | 1.4.0 vcli (Sara) |
| Role required | none |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
2.2 plugins
| Description | Returns Meandre plugin information. Does require authentication. |
| URL | http://<meandre_host>:<meandre_port>/services/about/plugins.<format> |
| Method | GET |
| Since | 1.1vcli (Carquinyoli) renamed to plugins on 1.4 vcli |
| Role required | none |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
2.3 installation
| Description | Returns Meandre installation information. Does require authentication. |
| URL | http://<meandre_host>:<meandre_port>/services/about/installation.<format> |
| Method | GET |
| Since | 1.1 vcli (Carquinyoli) |
| Role required | http://www.meandre.org/accounting/property/action/Admin |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
2.4 valid_roles
| Description | Returns the list of valid roles that can be assigned to a user. Does require authentication |
| URL | http://<meandre_host>:<meandre_port>/services/about/valid_roles.<format> |
| Method | GET |
| Since | 1.4.0 vcli |
| Role required | none |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
2.5 user_roles
| Description | Returns the current list of roles assign to the authenticated user. Does require authentication. |
| URL | http://<meandre_host>:<meandre_port>/services/about/user_roles.<format> |
| Method | GET |
| Since | 1.4.0 vcli |
| Role required | none |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
3. Location requests
Allow the user to manage and query the set of locations used to build the Meandre repository.
3.1 list
| Description | Returns the Meandre list of current locations used to assemble the repository. Does require authentication. |
| URL | http://<meandre_host>:<meandre_port>/services/locations/list.<format> |
| Method | GET |
| Since | 1.1 vcli (Carquinyoli) |
| Role required | http://www.meandre.org/accounting/property/action/Repository |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
3.2 add
| Description | Adds a new location to the Meandre list of current locations used to assemble the repository. Does require authentication.If the location can be added correctly, the call returns the new location information. If the call fails to add a location, it returns a bad request error code. If the location already exists, the call updates the description and returns the new location information |
| URL | http://<meandre_host>:<meandre_port>/services/locations/list.<format> |
| Method | GET |
| Since | 1.1 vcli (Carquinyoli) |
| Role required | http://www.meandre.org/accounting/property/action/Repository |
| Formats | json, txt, xml, html |
| Parameters | location (Required. The new location URL to add. Location needs to be in a supported RDF dialect) description (Required. The URL description) |
JSON response example
TXT response example
XML response example
3.3. remove
| Description | Removes a location from the Meandre list of current locations used to assemble the repository. Does require authentication. If the location can be removed correctly, the call returns the location removed. If the call fails to remove a location it returns a bad precondition error code. |
| URL | http://<meandre_host>:<meandre_port>/services/locations/remove.<format> |
| Method | GET |
| Since | 1.1 vcli (Carquinyoli) |
| Role required | http://www.meandre.org/accounting/property/action/Repository |
| Formats | json, txt, xml, html |
| Parameters | location (Required. The location URL to remove. Location needs to be in a supported RDF dialect) |
JSON response example
TXT response example
XML response example
4. Repository requests
Allow the user to query the Meandre repository of published components by the running instance. Does require authentication. There is only one public repository per Meandre running instance.
4.1 dump
| Description | Returns the Meandre repository of components for the current logged user. Does require authentication. |
| URL | http://<meandre_host>:<meandre_port>/services/repository/dump.<format> |
| Method | GET |
| Since | 1.1 vcli (Carquinyoli) |
| Role required | http://www.meandre.org/accounting/property/action/Repository |
| Formats | rdf, ttl, nt |
| Parameters | none |
RDF/XML response example
TTL response example
4.2 regenerate
| Description | Regenerates the user Meandre repository based on user listed locations. Components and flows not present on those locations are not removed/modified. Does require authentication. If the operation succeeds, it returns plain text containing "Repository successfully regenerated" |
| URL | http://<meandre_host>:<meandre_port>/services/repository/regenerate.<format> |
| Method | GET |
| Since | 1.1 vcli (Carquinyoli) |
| Role required | http://www.meandre.org/accounting/property/action/Repository |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
4.3 list_components
| Description | Lists all available Meandre components for the requesting user, each stated with a Meandre URI. Does require authentication. |
| URL | http://<meandre_host>:<meandre_port>/services/repository/list_components.<format> |
| Method | GET |
| Since | 1.1 vcli (Carquinyoli) |
| Role required | http://www.meandre.org/accounting/property/action/Repository |
| Formats | json, txt, xml, html |
| Parameters | order (Optional The sort order in which the flows should be returned: 'date' or 'name') limit (Optional Maximum number of results to return) |
JSON response example
TXT response example
XML response example
4.4 list_flows
| Description | Lists the available Meandre flows for the requesting user, each stated with a Meandre URI. Does require authentication. |
| URL | http://<meandre_host>:<meandre_port>/services/repository/list_flows.<format> |
| Method | GET |
| Since | 1.1 vcli (Carquinyoli) |
| Role required | http://www.meandre.org/accounting/property/action/Repository |
| Formats | json, txt, xml, html |
| Parameters | order (Optional The sort order in which the flows should be returned: 'date' or 'name') limit (Optional Maximum number of results to return) |
JSON response example
TXT response example
XML response example
4.5 tags
| Description | Lists all the available Meandre tags for the requesting user. Does require authentication. |
| URL | http://<meandre_host>:<meandre_port>/services/repository/tags.<format> |
| Method | GET |
| Since | 1.1 vcli (Carquinyoli) |
| Role required | http://www.meandre.org/accounting/property/action/Repository |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
4.6 tags_components
| Description | Lists the available Meandre components tags for the requesting user. Does require authentication. |
| URL | http://<meandre_host>:<meandre_port>/services/repository/tags_components.<format> |
| Method | GET |
| Since | 1.1 vcli (Carquinyoli) |
| Role required | http://www.meandre.org/accounting/property/action/Repository |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
4.7 tags_flows
| Description | Lists the available Meandre flow tags for the requesting user. Does require authentication. |
| URL | http://<meandre_host>:<meandre_port>/services/repository/tags_flows.<format> |
| Method | GET |
| Since | 1.1 vcli (Carquinyoli) |
| Role required | http://www.meandre.org/accounting/property/action/Repository |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
4.8 components_by_tag
| Description | Returns the list of Meandre components for the requesting user that match the query tag issued. Does require authentication. |
| URL | http://<meandre_host>:<meandre_port>/services/repository/components_by_tag.<format> |
| Method | GET |
| Since | 1.1 vcli (Carquinyoli) |
| Role required | http://www.meandre.org/accounting/property/action/Repository |
| Formats | json, txt, xml, html |
| Parameters | tag (Required The tag) |
JSON response example using ?tag=object
TXT response example using ?tag=object
XML response example using ?tag=object
4.9 flows_by_tag
| Description | Returns the list of Meandre flows for the requesting user that match the query tag issued. Does require authentication. |
| URL | http://<meandre_host>:<meandre_port>/services/repository/flows_by_tag.<format> |
| Method | GET |
| Since | 1.1 vcli (Carquinyoli) |
| Role required | http://www.meandre.org/accounting/property/action/Repository |
| Formats | json, txt, xml, html |
| Parameters | tag (Required The tag) |
JSON response example using ?tag=demo
TXT response example using ?tag=demo
XML response example using ?tag=demo
4.10 describe
| Description | Returns the RDF describing the requested Meandre component/flow that matches the provided URI for the requesting user. Does require authentication. Returns an empty model if the provided URI is not known for the current, assembled repository. |
| URL | http://<meandre_host>:<meandre_port>/services/repository/describe.<format> |
| Method | GET |
| Since | 1.4 vcli (Sara) |
| Role required | http://www.meandre.org/accounting/property/action/Repository |
| Formats | rdf, ttl, nt |
| Parameters | uri (Required The URI of the requested component) |
RDF response example using ?uri=meandre://test.org/flow/test-hello-world-with-python-and-lisp/
TTL response example using ?uri=meandre://test.org/flow/test-hello-world-with-python-and-lisp/
4.11 describe_component
| Description | Returns the RDF describing the requested Meandre component that matches the provided URI for the requesting user. Does require authentication. Returns an empty model if the provided URI is not known for the current, assembled repository. |
| URL | http://<meandre_host>:<meandre_port>/services/repository/describe_component.<format> |
| Method | GET |
| Since | 1.4 vcli (Sara) |
| Role required | http://www.meandre.org/accounting/property/action/Repository |
| Formats | rdf, ttl, nt |
| Parameters | uri (Required The URI of the requested component) |
RDF response example
TTL response example
4.12 describe_all_components
| Description | Returns the RDF describing all the available Meandre components for the requesting user. Does require authentication. |
| URL | http://<meandre_host>:<meandre_port>/services/repository/describe_all_components.<format> |
| Method | GET |
| Since | 1.3.1vcli (Xuixo) |
| Role required | http://www.meandre.org/accounting/property/action/Repository |
| Formats | rdf, ttl, nt |
| Parameters | none |
Returns the same formated responses as other describe calls.
4.13 describe_flow
| Description | Returns the RDF describing the requested Meandre flow that matches the provided URI for the requesting user. Does require authentication. Returns an empty model if the provided URI is not known for the current, assembled repository. |
| URL | http://<meandre_host>:<meandre_port>/services/repository/describe_component.<format> |
| Method | GET |
| Since | 1.4 vcli (Sara) |
| Role required | http://www.meandre.org/accounting/property/action/Repository |
| Formats | rdf, ttl, nt |
| Parameters | uri (Required The URI of the requested flow) |
RDF response example using ?uri=meandre://test.org/flow/test-hello-world-with-python-and-lisp/
TTL response example using ?uri=meandre://test.org/flow/test-hello-world-with-python-and-lisp/
4.14 describe_all_flows
| Description | Returns the RDF describing all the available Meandre flows for the requesting user. Does require authentication. |
| URL | http://<meandre_host>:<meandre_port>/services/repository/describe_all_flows.<format> |
| Method | GET |
| Since | 1.3.1vcli (Xuixo) |
| Role required | http://www.meandre.org/accounting/property/action/Repository |
| Formats | rdf, ttl, nt |
| Parameters | none |
Returns the same formated responses as other describe calls.
4.15 search_components
| Description | Returns the list of Meandre components for the requesting user that match the user query issued. Does require authentication. |
| URL | http://<meandre_host>:<meandre_port>/services/repository/search_components.<format> |
| Method | GET |
| Since | 1.1vcli (Carquinyoli) |
| Role required | http://www.meandre.org/accounting/property/action/Repository |
| Formats | json, txt, xml, html |
| Parameters | q (Required The query to search) order (Optional The sort order in which the components should be returned: 'date' or 'name') limit (Optional Maximum number of results to return) |
Returns the same formated responses as other list calls.
4.16 search_flows
| Description | Returns the list of Meandre flow for the requesting user that match the user query issued. Does require authentication. |
| URL | http://<meandre_host>:<meandre_port>/services/repository/search_flows.<format> |
| Method | GET |
| Since | 1.1vcli (Carquinyoli) |
| Role required | http://www.meandre.org/accounting/property/action/Repository |
| Formats | json, txt, xml, html |
| Parameters | q (Required The query to search) order (Optional The sort order in which the components should be returned: 'date' or 'name') limit (Optional Maximum number of results to return) |
Returns the same formated responses as other list calls.
4.17 remove
| Description | Removes a URI (component or flow) from the current user's Meandre repository. Does require authentication. If it succeeds, the call returns the URI; otherwise it returns an empty response. |
| URL | http://<meandre_host>:<meandre_port>/services/repository/remove.<format> |
| Method | GET |
| Since | 1.1 vcli (Carquinyoli) |
| Role required | http://www.meandre.org/accounting/property/action/Repository |
| Formats | json, txt, xml, html |
| Parameters | uri (Required The URI of the requested component/flow) |
JSON response example
TXT response example
XML response example
4.18 add
| Description | Uploads a file containing a set of components and/or flows and adds them to the current user's Meandre repository. Does require authentication. This call also allows the user to upload multiple files at once. This is useful when creating upload forms containing multiple entries. The call return the list of added URIs (components and flows). If the repository RDF file contains things other than components, those elements are ignored. |
| URL | http://<meandre_host>:<meandre_port>/services/repository/add.<format> |
| Method | POST |
| Since | 1.1 vcli (Carquinyoli) |
| Role required | http://www.meandre.org/accounting/property/action/Repository |
| Formats | json, txt, xml, html |
| Parameters | repository (Required The multi part file containing the repository.) _context_ (Optional The context files containing the implementation of the components.) _embed_ (Optional If true, the provided uploaded contextes will be embedded into the RDF repository descriptors.) _overwrite_ (Optional If true, overwrites any existing descriptor in the RDF repository.) |
JSON response example
TXT response example
XML response example
4.19 add_flow_description
| Description | Uploads a flow descriptor and adds it to the current user's Meandre repository. Does require authentication. This call can deal with descriptors containing multiple flow descriptors. This is useful when creating upload forms containing multiple entries. If the repository RDF file contains things other than components, those elements are ignored. |
| URL | http://<meandre_host>:<meandre_port>/services/repository/add_flow_descriptors.<format> |
| Method | POST |
| Since | 1.1 vcli (Carquinyoli) |
| Role required | http://www.meandre.org/accounting/property/action/Repository |
| Formats | json, txt, xml, html |
| Parameters | repository (Required The multi part file containing the repository.) _overwrite_ (Optional If true, overwrites any existing descriptor in the RDF repository.) |
JSON response example
TXT response example
XML response example
4.20 clear
| Description | Removes all the components and flows from the requesting user repository. Does require authentication. If the operation succeeds, it returns plain text containing "Repository successfully emptied" |
| URL | http://<meandre_host>:<meandre_port>/services/repository/clear.<format> |
| Method | GET |
| Since | 1.4 vcli (Sara) |
| Role required | http://www.meandre.org/accounting/property/action/Repository |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
5. Public requests
The public requests are open wide request that do not require authentication. Anyone able to reach the server can invoke these requests
5.1 repository
| Description | Returns the Meandre repository of components (executable components and flow components) that has been published in this instance of the server. Does not require authentication. |
| URL | http://<meandre_host>:<meandre_port>/public/services/repository.<format> |
| Method | GET |
| Since | 1.1 vcli (Carquinyoli) |
| Role required | none |
| Formats | rdf, ttl, nt |
| Parameters | none |
5.2 demo_repository
| Description | Returns a demo Meandre repository of components (executable components and flow components). This demo repository serves no practical purpose, but to show some of the basic capabilities of a data-intensive data flow architecture. Does not require authentication. |
| URL | http://<meandre_host>:<meandre_port>/public/services/demo_repository.<format> |
| Method | GET |
| Since | 1.1vcli (Carquinyoli) |
| Role required | none |
| Formats | rdf, ttl, nt |
| Parameters | none |
5.3 ping
| Description | Given a ping request, returns a response with a pong message. |
| URL | http://<meandre_host>:<meandre_port>/public/services/ping.<format> |
| Method | GET |
| Since | 1.4 vcli (Sara) |
| Role required | none |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
6. Publish requests
Allow the users with proper publishing role capabilities to publish and unpublish Meandre components and flows to the publicly available server repository.
6.1 publish
| Description | Publishes a component or flow from the user repository to the public repository. Does require authentication. The URI provided is the URI of the component of flow published. If the publishing succeeds, the call returns the URI. If the component or flow has already been published, the publishing action is aborted and and an empty result is returned. |
| URL | http://<meandre_host>:<meandre_port>/services/publish/publish.<format> |
| Method | GET |
| Since | 1.1 vcli (Carquinyoli) |
| Role required | http://www.meandre.org/accounting/property/action/Publish |
| Formats | json, txt, xml, html |
| Parameters | uri (Required The URI of the component or flow to publish. This URI needs to exist on the users repository.) |
JSON response example
TXT response example
XML response example
6.2 publish_all
| Description | Publishes all components and flows from the user repository to the public repository. Does require authentication. If the component or flow has already been published, the publishing action is ignored . |
| URL | http://<meandre_host>:<meandre_port>/services/publish/publish_all.<format> |
| Method | GET |
| Since | 1.1 vcli (Carquinyoli) |
| Role required | http://www.meandre.org/accounting/property/action/Publish |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
6.3 list_published
| Description | List the URI of the executable components and flows currently published and reachable via the public server repository. |
| URL | http://<meandre_host>:<meandre_port>/services/publish/list_published.<format> |
| Method | GET |
| Since | 1.4 vcli (Sara) |
| Role required | http://www.meandre.org/accounting/property/action/Publish |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
6.4 unpublish
| Description | Unpublishes a component or flow from the user repository to the public repository. Does require authentication. The URI provided is the URI of the component of flow published. If the unpublishing succeeds, the call returns the URI. If the component or flow has already been unpublished or does not exist on the public repository, the unpublishing action is aborted and an empty result is returned. |
| URL | http://<meandre_host>:<meandre_port>/services/publish/unpublish.<format> |
| Method | GET |
| Since | 1.1 vcli (Carquinyoli) |
| Role required | http://www.meandre.org/accounting/property/action/Execution |
| Formats | json, txt, xml, html |
| Parameters | uri (Required The URI of the component or flow to unpublish. This URI needs to exist on the public repository.) |
JSON response example
TXT response example
XML response example
6.5 unpublish_all
| Description | Unpublishes all components and flows from the public repository. Does require authentication. If the unpublishing succeeds, the call returns all the unpublished URI. If the component or flow has already been unpublished or does not exist on the public repository, the unpublishing action is skiped. |
| URL | http://<meandre_host>:<meandre_port>/services/publish/unpublish_all.<format> |
| Method | GET |
| Since | 1.1 vcli (Carquinyoli) |
| Role required | http://www.meandre.org/accounting/property/action/Execution |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
7. Execute requests
7.1 flow
| Description | Executes a flow and returns the output of the execution console. Does require authentication. The output format differs on the amount of verbosity pushed to the console. The "txt" format is the most verbose, whereas "silent" just prints to the console whatever the flow prints to the standard output and to the standard error. |
| URL | http://<meandre_host>:<meandre_port>/services/execute/flow.<format> |
| Method | GET |
| Since | 1.1 vcli (Carquinyoli) |
| Role required | http://www.meandre.org/accounting/property/action/Execution |
| Formats | txt, silent |
| Parameters | uri (Required The URI of the flow to execute. This URI needs to exist on the users repository.) statistic (Optional If true, the final executions statistics are displayed.) token (Optional A unique token to be assigned to this execution request.) |
Silent execution without statistics
Verbose execution with statistics
XML response example
7.2 list_running_flows
| Description | Lists the URIs of running flow instances and the URL to their associated webUI. All running flows, regardless of whether they have a webui to display or not, will be represented by ONE url in this list. The list contains the direct webui URL and the proxyed version by the server. The URL, if called, will return a page that automatically refreshes. As successive webui's are ready for display, they will appear on this page automatically. When the flow ends, the page will cease updating. In the case of no webui's in the flow, the page will display a message to that effect when first displayed. |
| URL | http://<meandre_host>:<meandre_port>/services/execute/list_running_flows.<format> |
| Method | GET |
| Since | 1.1 vcli (Carquinyoli) — Added proxy information on 1.4 vcli (Sara) |
| Role required | http://www.meandre.org/accounting/property/action/Execution |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
7.3 url
| Description | Returns the webUI information for an interactive flow currently being run on the server. |
| URL | http://<meandre_host>:<meandre_port>/services/execute/url.<format> |
| Method | GET |
| Since | 1.3 vcli (Xuixo) |
| Role required | http://www.meandre.org/accounting/property/action/Execution |
| Formats | json, txt, xml, html |
| Parameters | uri (Required The flow instance uri target of the request.) |
JSON response example
TXT response example
XML response example
7.4 web_component_url
| Description | Returns the URIs of the currently active fragments for the given executing flow |
| URL | http://<meandre_host>:<meandre_port>/services/execute/web_component_url.<format> |
| Method | GET |
| Since | 1.3 vcli (Xuixo) |
| Role required | http://www.meandre.org/accounting/property/action/Execution |
| Formats | json, txt, xml, html |
| Parameters | uri (Required The flow instance uri target of the request.) |
JSON response example
TXT response example
XML response example
7.5 uri_flow
| Description | Returns the webUI information for an interactive flow currently which has been assigned to a given token being run on the Server. |
| URL | http://<meandre_host>:<meandre_port>/services/execute/uri_flow.<format> |
| Method | GET |
| Since | 1.3 vcli (Xuixo) |
| Role required | http://www.meandre.org/accounting/property/action/Execution |
| Formats | json, txt, xml, html |
| Parameters | token (Required The token associated to the flow instance target of the request.) |
JSON response example
TXT response example
XML response example
target of the request.) |
JSON response example
TXT response example
XML response example
7.6 clean_uri_flow
| Description | Cleans all the token execution information left behind to help third party clients to get the unique flow ID of a running flow. This call cleans all the information for flows that have already finished execution. |
| URL | http://<meandre_host>:<meandre_port>/services/execute/clean_uri_flow.<format> |
| Method | GET |
| Since | 1.4.5 vcli (Sara) |
| Role required | http://www.meandre.org/accounting/property/action/Admin |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
7.7 repository
| Description | Executes all the flows on the uploaded repository. It returns the output of the execution console. Does require authentication. The output format differs on the amount of verbosity pushed to the console. The "txt" format is the most verbose, whereas "silent" just prints to the console whatever the flow prints to the standard output and to the standard error. |
| URL | http://<meandre_host>:<meandre_port>/services/execute/repository.<format> |
| Method | POST |
| Since | 1.4 vcli (Sara) |
| Role required | http://www.meandre.org/accounting/property/action/Execution |
| Formats | txt, silent |
| Parameters | repository (Required The repository to execute.) |
8. Coordinator requests
The coordinator requests provide access to information information related to the Meandre Distributed Exchange Coordinator. This allows to monitor the behavior of a clustered server assembled by a set of Meandre servers
8.1 log
| Description | Returns the cluster log information. The contains an up-to-date view of the cluster status (I: initialized, R: running, U: unregistered, S: shutdown, D: dirty shutdown) and past events. |
| URL | http://<meandre_host>:<meandre_port>/services/coordinator/log.<format> |
| Method | GET |
| Since | 1.4 vcli (Sara) |
| Role required | http://www.meandre.org/accounting/property/action/Admin |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
8.2 status
| Description | Returns the cluster status information for each of the Meandre servers in a cluster (I: initialized, R: running, U: unregistered, S: shutdown, D: dirty shutdown). The contains an up-to-date view of the servers that form the cluster |
| URL | http://<meandre_host>:<meandre_port>/services/coordinator/status.<format> |
| Method | GET |
| Since | 1.4 vcli (Sara) |
| Role required | http://www.meandre.org/accounting/property/action/Admin |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
8.3 info
| Description | Returns the cluster information of the servers. The contains an up-to-date view of the servers information form the cluster. |
| URL | http://<meandre_host>:<meandre_port>/services/coordinator/info.<format> |
| Method | GET |
| Since | 1.4 vcli (Sara) |
| Role required | http://www.meandre.org/accounting/property/action/Admin |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
8.4 property
| Description | Returns miscellaneous properties used by the Meandre server when working in clustered mode. This properties are regularly read an updated by a server. |
| URL | http://<meandre_host>:<meandre_port>/services/coordinator/property.<format> |
| Method | GET |
| Since | 1.4 vcli (Sara) |
| Role required | http://www.meandre.org/accounting/property/action/Admin |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
9. Job requests
Job requests provide access to the jobs running, pending, or completed for a given server.
9.1 list_jobs_statuses
| Description | List the jobs track by the Meandre server. Jobs status provide access to the flow instance uri, the time stamp of the last update, the server tracking the job, and the status of the job (C: completed, A: aborted, K: killed, R: running, U: unknown). |
| URL | http://<meandre_host>:<meandre_port>/services/jobs/list_jobs_statuses.<format> |
| Method | GET |
| Since | 1.4 vcli (Sara) |
| Role required | http://www.meandre.org/accounting/property/action/Admin |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
9.2 job_console
| Description | Returns the up-to-date console of a given flow instance. The console returns always the latest information collected so far. |
| URL | http://<meandre_host>:<meandre_port>/services/jobs/job_console.<format> |
| Method | GET |
| Since | 1.4 vcli (Sara) |
| Role required | http://www.meandre.org/accounting/property/action/Execution |
| Formats | json, txt, xml, html |
| Parameters | uri (Required The flow instance uri of the targeted console output) |
JSON response example
TXT response example
XML response example
10. Server requests
The server request deal with the management of a server. They tend to be irreversible and server administrators should pay special attention
10.1 shutdown
| Description | This request starts the shutdown process for a Meandre server. This will also remove the server from a Meandre cluster if running in cluster mode. This process is irreversible and once the server has been shutdown the server may need to be restarted manually. The response contains a simple message indicating that the shutdown process has started. You may use the public ping service to test for the finalization of the shutdown process. |
| URL | http://<meandre_host>:<meandre_port>/services/server/shutdown.<format> |
| Method | GET |
| Since | 1.4 vcli (Sara) |
| Role required | http://www.meandre.org/accounting/property/action/Admin |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
11. Security requests
The security requests are targeted for administrators. They allow the creation and deletion of users and granting/revoking roles to the users.
11.1 current_roles
| Description | Returns the roles assigned to the user making the request. |
| URL | http://<meandre_host>:<meandre_port>/services/security/current_roles.<format> |
| Method | GET |
| Since | 1.4 vcli (Sara) |
| Role required | http://www.meandre.org/accounting/property/action/Admin |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
11.2 roles_of_user
| Description | Returns the list of Meandre roles assigned to the requesting user. Does require authentication. |
| URL | http://<meandre_host>:<meandre_port>/services/security/roles_of_user.<format> |
| Method | GET |
| Since | 1.3 vcli (Xuixo) |
| Role required | http://www.meandre.org/accounting/property/action/Admin |
| Formats | json, txt, xml, html |
| Parameters | user_name (Required The user name to check.) |
JSON response example
TXT response example
XML response example
11.3 users
| Description | Returns the list of all users with access to the Meandre server. Does require authentication. |
| URL | http://<meandre_host>:<meandre_port>/services/security/users.<format> |
| Method | GET |
| Since | 1.3 vcli (Xuixo) |
| Role required | http://www.meandre.org/accounting/property/action/Admin |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
11.4 user
| Description | Returns the information about the user specified as the parameter. Does require authentication |
| URL | http://<meandre_host>:<meandre_port>/services/security/user.<format> |
| Method | GET |
| Since | 1.3 vcli (Xuixo) |
| Role required | http://www.meandre.org/accounting/property/action/Admin |
| Formats | json, txt, xml, html |
| Parameters | user_name (Required The user name to check.) |
JSON response example
TXT response example
XML response example
11.5 valid_roles
| Description | Returns the list of all Meandre roles supported. Does require authentication. (Equivalent to the about valid_roles service) |
| URL | http://<meandre_host>:<meandre_port>/services/security/valid_roles.<format> |
| Method | GET |
| Since | 1.3 vcli (Xuixo) |
| Role required | http://www.meandre.org/accounting/property/action/Admin |
| Formats | json, txt, xml, html |
| Parameters | none |
JSON response example
TXT response example
XML response example
11.6 grant_roles
| Description | Grants the specified Meandre role to the specified user. Does require authentication. |
| URL | http://<meandre_host>:<meandre_port>/services/security/grant_roles.<format> |
| Method | GET |
| Since | 1.4 vcli (Sara) — renamed from the 1.3 vcli (Xuixo) assign_roles |
| Role required | http://www.meandre.org/accounting/property/action/Admin |
| Formats | json, txt, xml, html |
| Parameters | user_name (Required the user name given for the request) role_name (Required the role given for the request) |
JSON response example
TXT response example
XML response example
11.7 revoke_roles
| Description | Removes the specified Meandre role from the specified user. Does require authentication. |
| URL | http://<meandre_host>:<meandre_port>/services/security/grant_roles.<format> |
| Method | GET |
| Since | 1.3 vcli (Xuixo) |
| Role required | http://www.meandre.org/accounting/property/action/Admin |
| Formats | json, txt, xml, html |
| Parameters | user_name (Required the user name given for the request) role_name (Required the role given for the request) |
JSON response example
TXT response example
XML response example
11.8 create_users
| Description | Creates a new user with the specified user name, full name and password. Does require authentication. |
| URL | http://<meandre_host>:<meandre_port>/services/security/create_users.<format> |
| Method | GET |
| Since | 1.4 vcli (Sara) — renamed from the 1.3 vcli (Xuixo) create_user |
| Role required | http://www.meandre.org/accounting/property/action/Admin |
| Formats | json, txt, xml, html |
| Parameters | user_name (Required the user name given for the request) user_full_name (Required the full user name given for the request) password (Required the user's password) |
JSON response example
TXT response example
XML response example
11.9 remove_users
| Description | Creates a new user with the specified user name, full name and password. Does require authentication. If the operation fails, the response contains a message indicating the failure |
| URL | http://<meandre_host>:<meandre_port>/services/security/remove_users.<format> |
| Method | GET |
| Since | 1.4 vcli (Sara) — renamed from the 1.3 vcli (Xuixo) remove_user |
| Role required | http://www.meandre.org/accounting/property/action/Admin |
| Formats | json, txt, xml, html |
| Parameters | user_name (Required the user name given for the request) user_full_name (Required the full user name given for the request) password (Required the user's password) |
JSON response example
TXT response example
XML response example
11.10 update_users
| Description | Updates all the information of a given user with the provided version of the request. |
| URL | http://<meandre_host>:<meandre_port>/services/security/update_users.<format> |
| Method | GET |
| Since | 1.4 vcli (Sara) |
| Role required | http://www.meandre.org/accounting/property/action/Admin |
| Formats | json, txt, xml, html |
| Parameters | user_name (Required the user name given for the request) user_full_name (Required the full user name given for the request) password (Required the user's password) |
JSON response example
TXT response example
XML response example
11.11 revoke_all_roles
| Description | Removes the Meandre roles for the specified user. Does require authentication. |
| URL | http://<meandre_host>:<meandre_port>/services/security/revoke_all_roles.<format> |
| Method | GET |
| Since | 1.3 vcli (Xuixo) |
| Role required | http://www.meandre.org/accounting/property/action/Admin |
| Formats | json, txt, xml, html |
| Parameters | user_name (Required the user name given for the request) |
JSON response example
TXT response example
XML response example
12. Running flow admin requests
Allow the user to query running flows in Meandre. These requests are made via the WebUI, not the Meandre core engine.
12.1 abort
| Description | Requires the running flow to abort its execution. This is not an instantaneous abort. The abort request is passed to the component, which will abort on the next firing event. |
| URL | http://<meandre_host>:<webui_port>/admin/abort.<format> |
| Method | GET |
| Since | 1.3 vcli (Xuixo) |
| Role required | none |
| Formats | txt |
| Parameters | none |
TXT response example
12.2 statistics
| Description | Returns the current statistics of the running flow. |
| URL | http://<meandre_host>:<webui_port>/admin/statistics.<format> |
| Method | GET |
| Since | 1.3 vcli (Xuixo) |
| Role required | none |
| Formats | json, txt, xml |
| Parameters | none |
Labels:
None