WorkflowRestServiceV40 (RESTful API 4.5.1 API)

java.lang.Object
- org.imixs.workflow.jaxrs.v40.WorkflowRestServiceV40

@Path(value="/v40/workflow")
 @Produces(value={"text/html","application/xml","application/json","text/xml"})
public class WorkflowRestServiceV40
extends Object

The WorkflowService Handler supports methods to process different kind of request URIs

Author:: rsoika

Constructor Summary

Constructors
Constructor and Description

WorkflowRestServiceV40()

Constructors
Constructor and Description
`WorkflowRestServiceV40()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`DocumentCollection`	`getEvents(String uniqueid)` Returns a collection of events of a workitem, visible to the current user
`javax.ws.rs.core.StreamingOutput`	`getHelpHTML()`
`DocumentCollection`	`getTaskListByAuthor(String user, String type, int pageIndex, int pageSize, String sortBy, Boolean sortReverse, String items)` Returns a collection of workitems representing the worklist by the current user
`DocumentCollection`	`getTaskListByCreator(String creator, String type, int pageIndex, int pageSize, String sortBy, Boolean sortReverse, String items)`
`DocumentCollection`	`getTaskListByGroup(String processgroup, String type, int pageIndex, int pageSize, String sortBy, Boolean sortReverse, String items)`
`DocumentCollection`	`getTaskListByOwner(String owner, String type, int pageIndex, int pageSize, String sortBy, Boolean sortReverse, String items)`
`DocumentCollection`	`getTaskListByProcessID(int processid, String type, int pageIndex, int pageSize, String sortBy, Boolean sortReverse, String items)`
`DocumentCollection`	`getTaskListByRef(String uniqueid, String type, int pageIndex, int pageSize, String sortBy, Boolean sortReverse, String items)`
`javax.ws.rs.core.Response`	`getWorkItem(String uniqueid, String items)` returns a singel workitem defined by $uniqueid
`javax.ws.rs.core.Response`	`getWorkItemFile(String uniqueid, String file, javax.ws.rs.core.UriInfo uriInfo)` Returns a file attachment located in the property $file of the specified workitem The file name will be encoded.
`DocumentCollection`	`getWorkList(String type, int pageIndex, int pageSize, String sortBy, Boolean sortReverse, String items)` Returns a collection of workitems representing the worklist by the current user
`static org.imixs.workflow.ItemCollection`	`parseWorkitem(InputStream requestBodyStream)` This method expects a form post.
`javax.ws.rs.core.Response`	`postFormWorkitem(InputStream requestBodyStream)` This method expects a form post and processes the WorkItem by the WorkflowService EJB.
`javax.ws.rs.core.Response`	`postJSONWorkitem(InputStream requestBodyStream, String error, String encoding)` This method expects a form post and processes the WorkItem by the WorkflowService EJB.
`javax.ws.rs.core.Response`	`postJSONWorkitemByUniqueID(String uniqueid, InputStream requestBodyStream, String error, String encoding)`
`javax.ws.rs.core.Response`	`postWorkitemByUniqueIDJSONDeprecated(String uniqueid, InputStream requestBodyStream, String error, String encoding)` Deprecated.
`javax.ws.rs.core.Response`	`postWorkitemJSONDeprecated(InputStream requestBodyStream, String error, String encoding)` Deprecated.
`javax.ws.rs.core.Response`	`postWorkitems_XML(DocumentCollection worklist)` This method post a collection of ItemCollection objects to be processed by the WorkflowManager.
`javax.ws.rs.core.Response`	`postXMLWorkitem(XMLItemCollection xmlworkitem)` This method post a ItemCollection object to be processed by the WorkflowManager.
`javax.ws.rs.core.Response`	`postXMLWorkitemByUniqueID(String uniqueid, XMLItemCollection xmlworkitem)`
`javax.ws.rs.core.Response`	`putFormWorkitem(InputStream requestBodyStream)` This method expects a form post.
`javax.ws.rs.core.Response`	`putJSONWorkitem(InputStream requestBodyStream, String error, String encoding)` Delegater for PUT postXMLWorkitemByUniqueID
`javax.ws.rs.core.Response`	`putJSONWorkitemByUniqueID(String uniqueid, InputStream requestBodyStream, String error, String encoding)` Delegater for PUT postJSONWorkitemByUniqueID
`javax.ws.rs.core.Response`	`putWorkitems_XML(DocumentCollection worklist)`
`javax.ws.rs.core.Response`	`putXMLWorkitem(XMLItemCollection workitem)` Delegater
`javax.ws.rs.core.Response`	`putXMLWorkitemByUniqueID(String uniqueid, XMLItemCollection xmlworkitem)` Delegater for PUT postXMLWorkitemByUniqueID

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- WorkflowRestServiceV40
```
public WorkflowRestServiceV40()
```

Method Detail

getHelpHTML

@GET
 @Produces(value="text/html")
public javax.ws.rs.core.StreamingOutput getHelpHTML()

getWorkItem

@GET
 @Path(value="/workitem/{uniqueid}")
public javax.ws.rs.core.Response getWorkItem(@PathParam(value="uniqueid")
                                                                                       String uniqueid,
                                                                                       @QueryParam(value="items")
                                                                                       String items)

returns a singel workitem defined by $uniqueid

Parameters:: uniqueid -
Returns:

getWorkItemFile

@GET
 @Path(value="/workitem/{uniqueid}/file/{file}")
public javax.ws.rs.core.Response getWorkItemFile(@PathParam(value="uniqueid")
                                                                                                       String uniqueid,
                                                                                                       @PathParam(value="file") @Encoded
                                                                                                       String file,
                                                                                                       @Context
                                                                                                       javax.ws.rs.core.UriInfo uriInfo)

Returns a file attachment located in the property $file of the specified workitem The file name will be encoded. With a URLDecode the filename is decoded in different formats and searched in the file list. This is not a nice solution.

Parameters:: uniqueid -
Returns:

getEvents

@GET
 @Path(value="/workitem/events/{uniqueid}")
public DocumentCollection getEvents(@PathParam(value="uniqueid")
                                                                                     String uniqueid)

Returns a collection of events of a workitem, visible to the current user

Parameters:: uniqueid - of workitem
Returns:: list of event entities

getWorkList

@GET
 @Path(value="/worklist")
public DocumentCollection getWorkList(@QueryParam(value="type")
                                                                     String type,
                                                                     @DefaultValue(value="0") @QueryParam(value="pageIndex")
                                                                     int pageIndex,
                                                                     @DefaultValue(value="10") @QueryParam(value="pageSize")
                                                                     int pageSize,
                                                                     @DefaultValue(value="") @QueryParam(value="sortBy")
                                                                     String sortBy,
                                                                     @DefaultValue(value="false") @QueryParam(value="sortReverse")
                                                                     Boolean sortReverse,
                                                                     @QueryParam(value="items")
                                                                     String items)

Returns a collection of workitems representing the worklist by the current user

Parameters:: start -; count -; type -; sortorder -

getTaskListByOwner

@GET
 @Path(value="/tasklist/owner/{owner}")
public DocumentCollection getTaskListByOwner(@PathParam(value="owner")
                                                                                          String owner,
                                                                                          @QueryParam(value="type")
                                                                                          String type,
                                                                                          @DefaultValue(value="0") @QueryParam(value="pageIndex")
                                                                                          int pageIndex,
                                                                                          @DefaultValue(value="10") @QueryParam(value="pageSize")
                                                                                          int pageSize,
                                                                                          @DefaultValue(value="") @QueryParam(value="sortBy")
                                                                                          String sortBy,
                                                                                          @DefaultValue(value="false") @QueryParam(value="sortReverse")
                                                                                          Boolean sortReverse,
                                                                                          @QueryParam(value="items")
                                                                                          String items)

getTaskListByAuthor

@GET
 @Path(value="/tasklist/author/{user}")
public DocumentCollection getTaskListByAuthor(@PathParam(value="user")
                                                                                           String user,
                                                                                           @QueryParam(value="type")
                                                                                           String type,
                                                                                           @DefaultValue(value="0") @QueryParam(value="pageIndex")
                                                                                           int pageIndex,
                                                                                           @DefaultValue(value="10") @QueryParam(value="pageSize")
                                                                                           int pageSize,
                                                                                           @DefaultValue(value="") @QueryParam(value="sortBy")
                                                                                           String sortBy,
                                                                                           @DefaultValue(value="false") @QueryParam(value="sortReverse")
                                                                                           Boolean sortReverse,
                                                                                           @QueryParam(value="items")
                                                                                           String items)

Returns a collection of workitems representing the worklist by the current user

Parameters:: start -; count -; type -; sortorder -

getTaskListByCreator

@GET
 @Path(value="/tasklist/creator/{creator}")
public DocumentCollection getTaskListByCreator(@PathParam(value="creator")
                                                                                                String creator,
                                                                                                @QueryParam(value="type")
                                                                                                String type,
                                                                                                @DefaultValue(value="0") @QueryParam(value="pageIndex")
                                                                                                int pageIndex,
                                                                                                @DefaultValue(value="10") @QueryParam(value="pageSize")
                                                                                                int pageSize,
                                                                                                @DefaultValue(value="") @QueryParam(value="sortBy")
                                                                                                String sortBy,
                                                                                                @DefaultValue(value="false") @QueryParam(value="sortReverse")
                                                                                                Boolean sortReverse,
                                                                                                @QueryParam(value="items")
                                                                                                String items)

getTaskListByProcessID

@GET
 @Path(value="/tasklist/processid/{processid}")
public DocumentCollection getTaskListByProcessID(@PathParam(value="processid")
                                                                                                      int processid,
                                                                                                      @QueryParam(value="type")
                                                                                                      String type,
                                                                                                      @DefaultValue(value="0") @QueryParam(value="pageIndex")
                                                                                                      int pageIndex,
                                                                                                      @DefaultValue(value="10") @QueryParam(value="pageSize")
                                                                                                      int pageSize,
                                                                                                      @DefaultValue(value="") @QueryParam(value="sortBy")
                                                                                                      String sortBy,
                                                                                                      @DefaultValue(value="false") @QueryParam(value="sortReverse")
                                                                                                      Boolean sortReverse,
                                                                                                      @QueryParam(value="items")
                                                                                                      String items)

getTaskListByGroup

@GET
 @Path(value="/tasklist/group/{processgroup}")
public DocumentCollection getTaskListByGroup(@PathParam(value="processgroup")
                                                                                                 String processgroup,
                                                                                                 @QueryParam(value="type")
                                                                                                 String type,
                                                                                                 @DefaultValue(value="0") @QueryParam(value="pageIndex")
                                                                                                 int pageIndex,
                                                                                                 @DefaultValue(value="10") @QueryParam(value="pageSize")
                                                                                                 int pageSize,
                                                                                                 @DefaultValue(value="") @QueryParam(value="sortBy")
                                                                                                 String sortBy,
                                                                                                 @DefaultValue(value="false") @QueryParam(value="sortReverse")
                                                                                                 Boolean sortReverse,
                                                                                                 @QueryParam(value="items")
                                                                                                 String items)

getTaskListByRef

@GET
 @Path(value="/tasklist/ref/{uniqueid}")
public DocumentCollection getTaskListByRef(@PathParam(value="uniqueid")
                                                                                         String uniqueid,
                                                                                         @QueryParam(value="type")
                                                                                         String type,
                                                                                         @DefaultValue(value="0") @QueryParam(value="pageIndex")
                                                                                         int pageIndex,
                                                                                         @DefaultValue(value="10") @QueryParam(value="pageSize")
                                                                                         int pageSize,
                                                                                         @DefaultValue(value="") @QueryParam(value="sortBy")
                                                                                         String sortBy,
                                                                                         @DefaultValue(value="false") @QueryParam(value="sortReverse")
                                                                                         Boolean sortReverse,
                                                                                         @QueryParam(value="items")
                                                                                         String items)

postFormWorkitem
```
@POST
 @Path(value="/workitem")
 @Consumes(value="application/x-www-form-urlencoded")
public javax.ws.rs.core.Response postFormWorkitem(InputStream requestBodyStream)
```
This method expects a form post and processes the WorkItem by the WorkflowService EJB. After the workItem was processed the method redirect the request to the provided action URI. The action URI can also be computed by the Imixs Workflow ResutlPlugin

Parameters:

requestBodyStream - - form content

action - - return URI

Returns:

putFormWorkitem

@PUT
 @Path(value="/workitem")
 @Consumes(value="application/x-www-form-urlencoded")
public javax.ws.rs.core.Response putFormWorkitem(InputStream requestBodyStream)

This method expects a form post.

Parameters:: requestBodyStream -
Returns:
See Also:: putWorkitemDefault

postXMLWorkitem
```
@POST
 @Path(value="/workitem")
 @Consumes(value={"application/xml","text/xml"})
public javax.ws.rs.core.Response postXMLWorkitem(XMLItemCollection xmlworkitem)
```
This method post a ItemCollection object to be processed by the WorkflowManager. The method test for the properties $processid and $activityid NOTE!! - this method did not update an existing instance of a workItem. The behavior is different to the method putWorkitem(). It need to be discussed if the behavior is wrong or not.

Parameters:

workitem - - new workItem data

putXMLWorkitem

@PUT
 @Path(value="/workitem")
 @Consumes(value={"application/xml","text/xml"})
public javax.ws.rs.core.Response putXMLWorkitem(XMLItemCollection workitem)

Delegater

Parameters:: workitem -
Returns:

postXMLWorkitemByUniqueID

@POST
 @Path(value="/workitem/{uniqueid}")
 @Consumes(value={"application/xml","text/xml"})
public javax.ws.rs.core.Response postXMLWorkitemByUniqueID(@PathParam(value="uniqueid")
                                                                                                                                                       String uniqueid,
                                                                                                                                                       XMLItemCollection xmlworkitem)

putXMLWorkitemByUniqueID

@PUT
 @Path(value="/workitem/{uniqueid}")
 @Consumes(value={"application/xml","text/xml"})
public javax.ws.rs.core.Response putXMLWorkitemByUniqueID(@PathParam(value="uniqueid")
                                                                                                                                                     String uniqueid,
                                                                                                                                                     XMLItemCollection xmlworkitem)

Delegater for PUT postXMLWorkitemByUniqueID

Parameters:: workitem -
Returns:

postJSONWorkitem

@POST
 @Path(value="/workitem")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response postJSONWorkitem(InputStream requestBodyStream,
                                                                                                                       @QueryParam(value="error")
                                                                                                                       String error,
                                                                                                                       @QueryParam(value="encoding")
                                                                                                                       String encoding)

This method expects a form post and processes the WorkItem by the WorkflowService EJB. The Method returns a JSON object with the new data. If a processException Occurs the method returns a JSON object with the error code The JSON result is computed by the service because JSON is not standardized and differs between different jax-rs implementations. For that reason it can not be directly re-converted XMLItemCollection generated by this method Output format:


 ... value":{"@type":"xs:int","$":"10"}

Parameters:: requestBodyStream - - form content
Returns:: JSON object
Throws:: Exception

putJSONWorkitem

@PUT
 @Path(value="/workitem")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response putJSONWorkitem(InputStream requestBodyStream,
                                                                                                                     @QueryParam(value="error")
                                                                                                                     String error,
                                                                                                                     @QueryParam(value="encoding")
                                                                                                                     String encoding)

Delegater for PUT postXMLWorkitemByUniqueID

Parameters:: workitem -
Returns:

postJSONWorkitemByUniqueID

@POST
 @Path(value="/workitem/{uniqueid}")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response postJSONWorkitemByUniqueID(@PathParam(value="uniqueid")
                                                                                                                                            String uniqueid,
                                                                                                                                            InputStream requestBodyStream,
                                                                                                                                            @QueryParam(value="error")
                                                                                                                                            String error,
                                                                                                                                            @QueryParam(value="encoding")
                                                                                                                                            String encoding)

putJSONWorkitemByUniqueID

@PUT
 @Path(value="/workitem/{uniqueid}")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response putJSONWorkitemByUniqueID(@PathParam(value="uniqueid")
                                                                                                                                          String uniqueid,
                                                                                                                                          InputStream requestBodyStream,
                                                                                                                                          @QueryParam(value="error")
                                                                                                                                          String error,
                                                                                                                                          @QueryParam(value="encoding")
                                                                                                                                          String encoding)

Delegater for PUT postJSONWorkitemByUniqueID

Parameters:: workitem -
Returns:

postWorkitems_XML

@POST
 @Path(value="/workitems")
 @Consumes(value={"application/xml","text/xml"})
public javax.ws.rs.core.Response postWorkitems_XML(DocumentCollection worklist)

This method post a collection of ItemCollection objects to be processed by the WorkflowManager.

Parameters:: worklist - - workitem list data

putWorkitems_XML

@PUT
 @Path(value="/workitems")
 @Consumes(value={"application/xml","text/xml"})
public javax.ws.rs.core.Response putWorkitems_XML(DocumentCollection worklist)

parseWorkitem
```
public static org.imixs.workflow.ItemCollection parseWorkitem(InputStream requestBodyStream)
```
This method expects a form post. The method parses the input stream to extract the provides field/value pairs. NOTE: The method did not(!) assume that the put/post request contains a complete workItem. For this reason the method loads the existing instance of the corresponding workItem (identified by the $uniqueid) and adds the values provided by the put/post request into the existing instance. The following kind of lines which can be included in the InputStream will be skipped ------------------------------1a26f3661ff7 Content-Disposition: form-data; name="query" Connection: keep-alive Content-Type: multipart/form-data; boundary=---------------------------195571638125373 Content-Length: 5680 -----------------------------195571638125373

Parameters:

requestBodyStream -

Returns:

a workitem

postWorkitemByUniqueIDJSONDeprecated

@Deprecated
 @POST
 @Path(value="/workitem.json/{uniqueid}")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response postWorkitemByUniqueIDJSONDeprecated(@PathParam(value="uniqueid")
                                                                                                                                                                        String uniqueid,
                                                                                                                                                                        InputStream requestBodyStream,
                                                                                                                                                                        @QueryParam(value="error")
                                                                                                                                                                        String error,
                                                                                                                                                                        @QueryParam(value="encoding")
                                                                                                                                                                        String encoding)

Deprecated.

postWorkitemJSONDeprecated

@Deprecated
 @POST
 @Path(value="/workitem.json")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response postWorkitemJSONDeprecated(InputStream requestBodyStream,
                                                                                                                                                   @QueryParam(value="error")
                                                                                                                                                   String error,
                                                                                                                                                   @QueryParam(value="encoding")
                                                                                                                                                   String encoding)