-
Notifications
You must be signed in to change notification settings - Fork 0
REST API Reference
Rudolph Pienaar edited this page Oct 13, 2015
·
12 revisions
(Updated 13-Oct-2015)
This page details the REST API reference to ChRIS.
GET /v1/Feeds
This returns a list of Feeds, defaulting to Feeds-by-name
To explicitly return a list of Feeds-by-name:
GET /v1/Feeds/NAME_*
To explicitly return of list of Feeds-by-ID:
GET /v1/Feeds/ID_*
To load a specific Feed, i.e. a Feed with name Feed-1,
GET /v1/Feeds/NAME_Feed-1
```
#### Get a the plugin tree at the Feed level
(not yet implemented as of 13-Oct-2015).
GET /v1/Feeds/plugin
#### Get a the <tt>note</tt>, <tt>comment</tt>, and <tt>title</tt> elements of a Feed with name <tt>Feed-1</tt>
GET /v1/Feeds/NAME_Feed-1/note GET /v1/Feeds/NAME_Feed-1/title GET /v1/Feeds/NAME_Feed-1/comment
#### Get the <tt>data</tt> component of Feed with name <tt>Feed-1</tt>
GET /v1/Feeds/NAME_Feed-1/data
#### Get the <tt>data/dataView</tt> component of Feed with name <tt>Feed-1</tt>
GET /v1/Feeds/NAME_Feed-1/data/dataView
#### Get the plugin tree associated with the data of Feed with name <tt>Feed-1</tt>
GET /v1/Feeds/NAME_Feed-1/data/plugin
### PUT verbs (not yet implemented as of 13-Oct-2015)
#### Create a new Feed
PUT /v1/Feeds/new
#### Create a new DataView in a given plugin
PUT /v1/Feeds/1234/DataView/new