@Path(value="/workflow")
@Produces(value={"text/html","application/xml","application/json","text/xml"})
public class WorkflowRestService
extends Object
| Constructor and Description |
|---|
WorkflowRestService() |
| Modifier and Type | Method and Description |
|---|---|
org.imixs.workflow.xml.XMLDataCollection |
getEvents(String uniqueid)
Returns a collection of events of a workitem, visible to the current user
|
javax.ws.rs.core.StreamingOutput |
getHelpHTML() |
org.imixs.workflow.xml.XMLDataCollection |
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
|
org.imixs.workflow.xml.XMLDataCollection |
getTaskListByCreator(String creator,
String type,
int pageIndex,
int pageSize,
String sortBy,
Boolean sortReverse,
String items) |
org.imixs.workflow.xml.XMLDataCollection |
getTaskListByGroup(String processgroup,
String type,
int pageIndex,
int pageSize,
String sortBy,
Boolean sortReverse,
String items) |
org.imixs.workflow.xml.XMLDataCollection |
getTaskListByOwner(String owner,
String type,
int pageIndex,
int pageSize,
String sortBy,
Boolean sortReverse,
String items) |
org.imixs.workflow.xml.XMLDataCollection |
getTaskListByProcessID(int processid,
String type,
int pageIndex,
int pageSize,
String sortBy,
Boolean sortReverse,
String items) |
org.imixs.workflow.xml.XMLDataCollection |
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.
|
org.imixs.workflow.xml.XMLDataCollection |
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 |
postFormWorkitemByUnqiueID(String uid,
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(org.imixs.workflow.xml.XMLDataCollection worklist)
This method post a collection of ItemCollection objects to be processed by
the WorkflowManager.
|
javax.ws.rs.core.Response |
postXMLWorkitem(org.imixs.workflow.xml.XMLDocument xmlworkitem)
This method post a ItemCollection object to be processed by the
WorkflowManager.
|
javax.ws.rs.core.Response |
postXMLWorkitemByUniqueID(String uniqueid,
org.imixs.workflow.xml.XMLDocument 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(org.imixs.workflow.xml.XMLDataCollection worklist) |
javax.ws.rs.core.Response |
putXMLWorkitem(org.imixs.workflow.xml.XMLDocument workitem)
Delegater
|
javax.ws.rs.core.Response |
putXMLWorkitemByUniqueID(String uniqueid,
org.imixs.workflow.xml.XMLDocument xmlworkitem)
Delegater for PUT postXMLWorkitemByUniqueID
|
@GET @Produces(value="text/html") public javax.ws.rs.core.StreamingOutput getHelpHTML()
@GET
@Path(value="/workitem/{uniqueid}")
public javax.ws.rs.core.Response getWorkItem(@PathParam(value="uniqueid")
String uniqueid,
@QueryParam(value="items")
String items)
uniqueid - @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)
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.
uniqueid - @GET
@Path(value="/workitem/events/{uniqueid}")
public org.imixs.workflow.xml.XMLDataCollection getEvents(@PathParam(value="uniqueid")
String uniqueid)
uniqueid - of workitem@GET
@Path(value="/worklist")
public org.imixs.workflow.xml.XMLDataCollection 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)
start - count - type - sortorder - @GET
@Path(value="/tasklist/owner/{owner}")
public org.imixs.workflow.xml.XMLDataCollection 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)
@GET
@Path(value="/tasklist/author/{user}")
public org.imixs.workflow.xml.XMLDataCollection 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)
start - count - type - sortorder - @GET
@Path(value="/tasklist/creator/{creator}")
public org.imixs.workflow.xml.XMLDataCollection 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)
@GET
@Path(value="/tasklist/processid/{processid}")
public org.imixs.workflow.xml.XMLDataCollection 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)
@GET
@Path(value="/tasklist/group/{processgroup}")
public org.imixs.workflow.xml.XMLDataCollection 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)
@GET
@Path(value="/tasklist/ref/{uniqueid}")
public org.imixs.workflow.xml.XMLDataCollection 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)
@POST @Path(value="/workitem") @Consumes(value="application/x-www-form-urlencoded") public javax.ws.rs.core.Response postFormWorkitem(InputStream requestBodyStream)
requestBodyStream - - form contentaction - - return URI@POST
@Path(value="/workitem/{uniqueid : ([0-9a-f]{8}-.*|[0-9a-f]{11}-.*)}")
@Consumes(value="application/x-www-form-urlencoded")
public javax.ws.rs.core.Response postFormWorkitemByUnqiueID(@PathParam(value="uniqueid")
String uid,
InputStream requestBodyStream)
requestBodyStream - - form contentaction - - return URI@PUT @Path(value="/workitem") @Consumes(value="application/x-www-form-urlencoded") public javax.ws.rs.core.Response putFormWorkitem(InputStream requestBodyStream)
requestBodyStream - putWorkitemDefault@POST
@Path(value="/workitem")
@Consumes(value={"application/xml","text/xml"})
public javax.ws.rs.core.Response postXMLWorkitem(org.imixs.workflow.xml.XMLDocument xmlworkitem)
workitem - - new workItem data@PUT
@Path(value="/workitem")
@Consumes(value={"application/xml","text/xml"})
public javax.ws.rs.core.Response putXMLWorkitem(org.imixs.workflow.xml.XMLDocument workitem)
workitem - @POST
@Path(value="/workitem/{uniqueid : ([0-9a-f]{8}-.*|[0-9a-f]{11}-.*)}")
@Consumes(value={"application/xml","text/xml"})
public javax.ws.rs.core.Response postXMLWorkitemByUniqueID(@PathParam(value="uniqueid")
String uniqueid,
org.imixs.workflow.xml.XMLDocument xmlworkitem)
@PUT
@Path(value="/workitem/{uniqueid : ([0-9a-f]{8}-.*|[0-9a-f]{11}-.*)}")
@Consumes(value={"application/xml","text/xml"})
public javax.ws.rs.core.Response putXMLWorkitemByUniqueID(@PathParam(value="uniqueid")
String uniqueid,
org.imixs.workflow.xml.XMLDocument xmlworkitem)
workitem - @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)
... value":{"@type":"xs:int","$":"10"}
requestBodyStream - - form contentException@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)
workitem - @POST
@Path(value="/workitem/{uniqueid : ([0-9a-f]{8}-.*|[0-9a-f]{11}-.*)}")
@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)
@PUT
@Path(value="/workitem/{uniqueid : ([0-9a-f]{8}-.*|[0-9a-f]{11}-.*)}")
@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)
workitem - @POST
@Path(value="/workitems")
@Consumes(value={"application/xml","text/xml"})
public javax.ws.rs.core.Response postWorkitems_XML(org.imixs.workflow.xml.XMLDataCollection worklist)
worklist - - workitem list data@PUT
@Path(value="/workitems")
@Consumes(value={"application/xml","text/xml"})
public javax.ws.rs.core.Response putWorkitems_XML(org.imixs.workflow.xml.XMLDataCollection worklist)
public static org.imixs.workflow.ItemCollection parseWorkitem(InputStream requestBodyStream)
------------------------------1a26f3661ff7
Content-Disposition: form-data; name="query"
Connection: keep-alive
Content-Type: multipart/form-data; boundary=---------------------------195571638125373
Content-Length: 5680
-----------------------------195571638125373
requestBodyStream - @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 @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)
requestBodyStream - error - encoding - Copyright © 2006–2019 Imixs Software Solutions GmbH. All rights reserved.