Skip to content

Clematis RESTFul API

Ali Mesbah edited this page Feb 28, 2014 · 2 revisions

**# RESTFUL API **

Below is a brief document describing the various api calls that could be made. Please note that {fileName} refers to the name of the story that the user wishes to use.

1-Retrieve the number of episodes in a story.

http://localhost:8080/rest/clematis-api/{fileName}/episodes/howmany

2-Retrieve All the episodes of a story.

http://localhost:8080/rest/clematis-api/{fileName}/episodes/

3-Display All the episodes in a more readable format.

http://localhost:8080/rest/clematis-api/{fileName}/episodes/pretty

4-Retrieve a certain Episode by providing its id.

http://localhost:8080/rest/clematis-api/{fileName}/episodes/{id}

5-Retrieve the Dom of a certain episode by providing its id.

http://localhost:8080/rest/clematis-api/{fileName}/episodes/{id}/DOM

6-Retrieve the trace of a certain episode by providing its id.

http://localhost:8080/rest/clematis-api/{fileName}/episodes/{id}/trace

7-Retrieve the source of a certain episode by providing its id.

http://localhost:8080/rest/clematis-api/{fileName}/episodes/{id}/source

8-Retrieve a list of causal links.

http://localhost:8080/rest/clematis-api/{fileName}/story/causalLinks

Clone this wiki locally