WorkflowRestServiceV3 (RESTful API 4.5.1 API)

java.lang.Object
- org.imixs.workflow.jaxrs.v3.WorkflowRestServiceV3

Deprecated.

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

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

Author:: rsoika

Constructor Summary

Constructors
Constructor and Description

WorkflowRestServiceV3()
Deprecated.

Constructors
Constructor and Description
`WorkflowRestServiceV3()` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`EntityCollection`	`getEvents(String uniqueid)` Deprecated. Returns a collection of events of a workitem, visible to the current user
`javax.ws.rs.core.StreamingOutput`	`getHelpHTML()` Deprecated.
`EntityCollection`	`getTaskListByAuthor(String user, int start, int count, String type, int sortorder, String items)` Deprecated. Returns a collection of workitems representing the worklist by the current user
`EntityCollection`	`getTaskListByCreator(String creator, int start, int count, String type, int sortorder, String items)` Deprecated.
`EntityCollection`	`getTaskListByGroup(String processgroup, int start, int count, String type, int sortorder, String items)` Deprecated.
`EntityCollection`	`getTaskListByOwner(String owner, int start, int count, String type, int sortorder, String items)` Deprecated.
`EntityCollection`	`getTaskListByProcessID(int processid, int start, int count, String type, int sortorder, String items)` Deprecated.
`EntityCollection`	`getTaskListByRef(String uniqueid, int start, int count, String type, int sortorder, String items)` Deprecated.
`XMLItemCollection`	`getWorkItem(String uniqueid, String items)` Deprecated. returns a singel workitem defined by $uniqueid
`javax.ws.rs.core.Response`	`getWorkItemFile(String uniqueid, String file, javax.ws.rs.core.UriInfo uriInfo)` Deprecated. Returns a file attachment located in the property $file of the specified workitem The file name will be encoded.
`EntityCollection`	`getWorkList(int start, int count, String type, int sortorder, String items)` Deprecated. Returns a collection of workitems representing the worklist by the current user
`static org.imixs.workflow.ItemCollection`	`parseWorkitem(InputStream requestBodyStream)` Deprecated. This method expects a form post.
`javax.ws.rs.core.Response`	`postWorkitem(InputStream requestBodyStream)` Deprecated. This method expects a form post.
`javax.ws.rs.core.Response`	`postWorkitemByUniqueIDJSON(String uniqueid, InputStream requestBodyStream, String error, String encoding)` Deprecated.
`javax.ws.rs.core.Response`	`postWorkitemByUniqueIDXML(String uniqueid, XMLItemCollection xmlworkitem)` Deprecated.
`javax.ws.rs.core.Response`	`postWorkitemJSON(InputStream requestBodyStream, String error, String encoding)` Deprecated. This method expects a form post and processes the WorkItem by the WorkflowService EJB.
`javax.ws.rs.core.Response`	`postWorkitemsXML(EntityCollection worklist)` Deprecated.
`javax.ws.rs.core.Response`	`postWorkitemXML(XMLItemCollection xmlworkitem)` Deprecated. This method post a ItemCollection object to be processed by the WorkflowManager.
`javax.ws.rs.core.Response`	`putWorkitem(InputStream requestBodyStream)` Deprecated. This method expects a form post and processes the WorkItem by the WorkflowService EJB.
`javax.ws.rs.core.Response`	`putWorkitemsXML(EntityCollection worklist)` Deprecated. This method post a collection of ItemCollection objects to be processed by the WorkflowManager.
`javax.ws.rs.core.Response`	`putWorkitemXML(XMLItemCollection workitem)` Deprecated.

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

Constructor Detail
- WorkflowRestServiceV3
```
public WorkflowRestServiceV3()
```
  Deprecated.

Method Detail

getHelpHTML

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

Deprecated.

getWorkItem

@GET
 @Path(value="/workitem/{uniqueid}")
public XMLItemCollection getWorkItem(@PathParam(value="uniqueid")
                                                                               String uniqueid,
                                                                               @QueryParam(value="items")
                                                                               String items)

Deprecated.

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)

Deprecated.

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 EntityCollection getEvents(@PathParam(value="uniqueid")
                                                                                   String uniqueid)

Deprecated.

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 EntityCollection getWorkList(@DefaultValue(value="0") @QueryParam(value="start")
                                                                   int start,
                                                                   @DefaultValue(value="10") @QueryParam(value="count")
                                                                   int count,
                                                                   @QueryParam(value="type")
                                                                   String type,
                                                                   @DefaultValue(value="0") @QueryParam(value="sortorder")
                                                                   int sortorder,
                                                                   @QueryParam(value="items")
                                                                   String items)

Deprecated.

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 EntityCollection getTaskListByOwner(@PathParam(value="owner")
                                                                                        String owner,
                                                                                        @DefaultValue(value="0") @QueryParam(value="start")
                                                                                        int start,
                                                                                        @DefaultValue(value="10") @QueryParam(value="count")
                                                                                        int count,
                                                                                        @QueryParam(value="type")
                                                                                        String type,
                                                                                        @DefaultValue(value="0") @QueryParam(value="sortorder")
                                                                                        int sortorder,
                                                                                        @QueryParam(value="items")
                                                                                        String items)

Deprecated.

getTaskListByAuthor

@GET
 @Path(value="/tasklist/author/{user}")
public EntityCollection getTaskListByAuthor(@PathParam(value="user")
                                                                                         String user,
                                                                                         @DefaultValue(value="0") @QueryParam(value="start")
                                                                                         int start,
                                                                                         @DefaultValue(value="10") @QueryParam(value="count")
                                                                                         int count,
                                                                                         @QueryParam(value="type")
                                                                                         String type,
                                                                                         @DefaultValue(value="0") @QueryParam(value="sortorder")
                                                                                         int sortorder,
                                                                                         @QueryParam(value="items")
                                                                                         String items)

Deprecated.

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 EntityCollection getTaskListByCreator(@PathParam(value="creator")
                                                                                              String creator,
                                                                                              @DefaultValue(value="0") @QueryParam(value="start")
                                                                                              int start,
                                                                                              @DefaultValue(value="10") @QueryParam(value="count")
                                                                                              int count,
                                                                                              @QueryParam(value="type")
                                                                                              String type,
                                                                                              @DefaultValue(value="0") @QueryParam(value="sortorder")
                                                                                              int sortorder,
                                                                                              @QueryParam(value="items")
                                                                                              String items)

Deprecated.

getTaskListByProcessID

@GET
 @Path(value="/tasklist/processid/{processid}")
public EntityCollection getTaskListByProcessID(@PathParam(value="processid")
                                                                                                    int processid,
                                                                                                    @DefaultValue(value="0") @QueryParam(value="start")
                                                                                                    int start,
                                                                                                    @DefaultValue(value="10") @QueryParam(value="count")
                                                                                                    int count,
                                                                                                    @QueryParam(value="type")
                                                                                                    String type,
                                                                                                    @DefaultValue(value="0") @QueryParam(value="sortorder")
                                                                                                    int sortorder,
                                                                                                    @QueryParam(value="items")
                                                                                                    String items)

Deprecated.

getTaskListByGroup

@GET
 @Path(value="/tasklist/group/{processgroup}")
public EntityCollection getTaskListByGroup(@PathParam(value="processgroup")
                                                                                               String processgroup,
                                                                                               @DefaultValue(value="0") @QueryParam(value="start")
                                                                                               int start,
                                                                                               @DefaultValue(value="10") @QueryParam(value="count")
                                                                                               int count,
                                                                                               @QueryParam(value="type")
                                                                                               String type,
                                                                                               @DefaultValue(value="0") @QueryParam(value="sortorder")
                                                                                               int sortorder,
                                                                                               @QueryParam(value="items")
                                                                                               String items)

Deprecated.

getTaskListByRef

@GET
 @Path(value="/tasklist/ref/{uniqueid}")
public EntityCollection getTaskListByRef(@PathParam(value="uniqueid")
                                                                                       String uniqueid,
                                                                                       @DefaultValue(value="0") @QueryParam(value="start")
                                                                                       int start,
                                                                                       @DefaultValue(value="10") @QueryParam(value="count")
                                                                                       int count,
                                                                                       @QueryParam(value="type")
                                                                                       String type,
                                                                                       @DefaultValue(value="0") @QueryParam(value="sortorder")
                                                                                       int sortorder,
                                                                                       @QueryParam(value="items")
                                                                                       String items)

Deprecated.

putWorkitem
```
@POST
 @Path(value="/workitem")
 @Consumes(value="application/x-www-form-urlencoded")
 @Produces(value="application/xml")
public javax.ws.rs.core.Response putWorkitem(InputStream requestBodyStream)
```
Deprecated.

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:

postWorkitem

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

Deprecated.

This method expects a form post.

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

postWorkitemXML
```
@POST
 @Path(value="/workitem")
 @Produces(value="application/xml")
 @Consumes(value={"application/xml","text/xml"})
public javax.ws.rs.core.Response postWorkitemXML(XMLItemCollection xmlworkitem)
```
Deprecated.

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

postWorkitemByUniqueIDXML

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

Deprecated.

putWorkitemXML

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

Deprecated.

postWorkitemJSON

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

Deprecated.

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

postWorkitemByUniqueIDJSON

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

Deprecated.

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

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

Parameters:

worklist - - workitem list data

postWorkitemsXML

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

Deprecated.

parseWorkitem
```
public static org.imixs.workflow.ItemCollection parseWorkitem(InputStream requestBodyStream)
```
Deprecated.

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

Class WorkflowRestServiceV3

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WorkflowRestServiceV3

Method Detail

getHelpHTML

getWorkItem

getWorkItemFile

getEvents

getWorkList

getTaskListByOwner

getTaskListByAuthor

getTaskListByCreator

getTaskListByProcessID

getTaskListByGroup

getTaskListByRef

putWorkitem

postWorkitem

postWorkitemXML

postWorkitemByUniqueIDXML

putWorkitemXML

postWorkitemJSON

postWorkitemByUniqueIDJSON

putWorkitemsXML

postWorkitemsXML

parseWorkitem