Kisha - REST interface
----------------------

(interface working draft)


* service (atom)

GET     /service
    gets the AtomPub service document


* processes

GET     /processes
    lists processe instances currently active in the engine

GET     /processes?wfname=x[&wfrevision=y]
    lists process instances of a certain process definition

GET     /processes?prefix=x
    lists processes whose instance id starts with the given prefix
    (combinable with wfname and wfrevision)

POST    /processes
    launches a new process instance

GET     /processes/{wfid}
    gets info about a process instance

(PUT     /processes/{wfid}
    pauses/resumes a process)

DELETE  /processes/{wfid}
    cancels a process instance


* processes and workitems

GET    /processes/{wfid}/workitems
    lists the workitems belonging to a process instance


* workitems

GET    /workitems
    lists all the workitems currently in a store participant

GET    /workitems?q={query}
    lists all the workitems that match a full text query

PUT    /workitems/{id}
    proceeds a particular workitem (will vanish from that place/URI)
PUT    /workitems/{id}?do_not_proceed=true
    simply puts a workitem (will not make it resume in its process)

POST   /workitems
    posts a launchitem or a workitem to the engine


* processes and/or errors

GET    /processes/{wfid}/errors
    lists the errors for a process (if any)

GET    /errors/{id}
    returns a particular error

GET    /errors
    lists all the errors in the engine
    (wfid_prefix ?)

(PUT     /processes/{wfid}/errors/{id}
     replays at an error
PUT    /errors/{id}
     replays at an error
...shouldn't it be a delete ?)


* participants / workitems

GET     /participants/{pid}/workitems
    lists the workitems for a participant (if this is a store-like
    participant)


* engine

GET     /engine
    - gets generic info about the engine...