RE: Some initial thoughts - REST catalog interfaces

From: Stavros.Isaiadis@uk.fujitsu.com [mailto:Stavros.Isaiadis@uk.fujitsu.com]
Sent: Friday, June 04, 2010 10:15 AM
To: Vaught, Jeffrey A
Subject: Some initial thoughts

Hi Jeff,

This is not much, but possibly enough to get something going in the right direction. So, here is how an HTTP interface could look like on the relevant resource model:

The POST and PUT operations on the catalogue contents are conditional upon user/entity being a CatalogueSource (or CatalogueEditor??)

/catalogue/protocols/: GET: return list of existing Protocol; POST: create/append a new Protocol; PUT: add existing Protocol

/catalogue/protocols/{type}: GET: return specific Protocol; PUT: update; DELETE remove

/catalogue/protocols/?{symptom, subject,...}={value}: GET: query protocols (e.g. find those that contains specific symptoms types or subjects)

/catalogue/syndrome/: GET: return list of existing Syndromes; POST: create/append a new Syndrome; PUT: add existing Syndrome

/catalogue/syndrome/{type}: GET: return specific Protocol; PUT: update; DELETE remove

/catalogue/syndrome/?{symptom, subject,...}={value}: GET: query syndromes (e.g. find those that contains specific symptoms types or subjects)

/catalogue/symptoms/: GET: return list of existing Symptoms type; POST: create/append a new Symptom type; PUT: add existing Symptom Type

/catalogue/symptoms/{type}: GET: return specific Symptom Type; PUT: update; DELETE remove

/symptoms/: GET: return Symptom store contents; PUT put existing symptoms (as received from somewhere?); [POST create new Symptoms, does that make sense? Aren't all Symptoms coming from somewhere already?]

/symptoms/{id}: GET: return specific Symptom; DELETE remove (???) [PUT is not available as this is not editable]

/symptoms/?{time,content,type,subject,reporter}={value}: GET: query symptom store

/subjects/: GET return list of subjects (keeping them separately}; PUT; POST [does POST make sense?]

/subjects/{id}: GET return specific subject (which is what???); PUT; DELETE;

/reporters/ [as above]

SymptomSources are only allowed to PUT symptoms in the SymptomStore.

Some questions are: how do we build the query interface (if the above is not enough). What would the subject be and what is the role of the one that defines these? Perhaps we should consider what Alvin suggested, an “Information Store” that will contain application relevant information.

Also, the above are very straightforward to map to our WSRF implementation, so coming up with a testbed should not be very difficult or take much of our time.

Cheers,

Stavros

______________________________________________________________________

 Fujitsu Laboratories of Europe Limited

 Hayes Park Central, Hayes End Road, Hayes, Middlesex, UB4 8FE

 Registered No. 4153469

 This e-mail and any attachments are for the sole use of addressee(s) and

 may contain information which is privileged and confidential. Unauthorised

 use or copying for disclosure is strictly prohibited. The fact that this

 e-mail has been scanned by Trendmicro Interscan does not guarantee that

 it has not been intercepted or amended nor that it is virus-free.

saf message