Package org.imixs.workflow.jaxrs

Class ModelRestService

java.lang.Object
org.imixs.workflow.jaxrs.ModelRestService
@Path("/model") @Produces({"text/html","application/xhtml+xml","application/xml","application/json","text/xml"}) public class ModelRestService extends Object
The WorkflowService Handler supports methods to process different kind of request URIs
Author:
rsoika

  • Constructor Details

    • ModelRestService

      public ModelRestService()

  • Method Details

    • getModelOverview

      @GET @Produces("text/html") public jakarta.ws.rs.core.StreamingOutput getModelOverview()

    • getModelXML

      @GET @Produces({"application/xml","text/xml"}) public String getModelXML()

    • findAllTasks

      @GET @Path("/{version}/tasks/") public jakarta.ws.rs.core.Response findAllTasks(@PathParam("version") String version, @QueryParam("items") String items, @QueryParam("format") String format)

    • getModelFile

      @GET @Path("/{version}/bpmn") public jakarta.ws.rs.core.Response getModelFile(@PathParam("version") String version, @Context jakarta.ws.rs.core.UriInfo uriInfo)
      Returns the XML representation of a BPMN model
      Parameters:
      version -
      uriInfo -
      Returns:

    • getDefiniton

      @GET @Path("/{version}/definition") public jakarta.ws.rs.core.Response getDefiniton(@PathParam("version") String version, @QueryParam("items") String items, @QueryParam("format") String format)
      Returns the model definition containing general model information (e.g. $ModelVersion).

    • getTask

      @GET @Path("/{version}/tasks/{taskid}") public jakarta.ws.rs.core.Response getTask(@PathParam("version") String version, @PathParam("taskid") int taskID, @QueryParam("items") String items, @QueryParam("format") String format)

    • findAllEventsByTask

      @GET @Path("/{version}/tasks/{taskid}/events") public jakarta.ws.rs.core.Response findAllEventsByTask(@PathParam("version") String version, @PathParam("taskid") int taskID, @QueryParam("items") String items, @QueryParam("format") String format)

    • getGroups

      @GET @Path("/{version}/groups") public Set<String> getGroups(@PathParam("version") String version, @QueryParam("items") String items)
      Returns a list of all Workflow Groups of the given model
      Parameters:
      version -
      Returns:

    • findTasksByGroup

      @GET @Path("/{version}/groups/{group}") public jakarta.ws.rs.core.Response findTasksByGroup(@PathParam("version") String version, @PathParam("group") String group, @QueryParam("items") String items, @QueryParam("format") String format)
      Returns a list of all Tasks of a specific workflow group.
      Parameters:
      version -
      Returns:

    • deleteModel

      @DELETE @Path("/{version}") public void deleteModel(@PathParam("version") String version)

    • putBPMNModel

      @PUT @Path("/bpmn") @Consumes({"application/xml","application/octet-stream","text/plain"}) public jakarta.ws.rs.core.Response putBPMNModel(org.openbpmn.bpmn.BPMNModel bpmnmodel)
      This method consumes a Imixs BPMN model file and updates the corresponding model information.
      Parameters:
      model -
      Returns:

    • putBPMNModel

      @PUT @Path("/bpmn/{filename}") @Consumes({"application/xml","application/octet-stream","text/plain"}) public jakarta.ws.rs.core.Response putBPMNModel(@PathParam("filename") String filename, org.openbpmn.bpmn.BPMNModel bpmnmodel)
      This method consumes a Imixs BPMN model file and updates the corresponding model information.

      The filename param is used to store the file in the corresponding bpmn document.

      Parameters:
      model -
      Returns:

    • postBPMNModel

      @POST @Path("/bpmn") @Consumes({"application/xml","application/octet-stream","text/plain"}) public jakarta.ws.rs.core.Response postBPMNModel(org.openbpmn.bpmn.BPMNModel bpmnmodel)

    • postBPMNModel

      @POST @Path("/bpmn/{filename}") @Consumes({"application/xml","application/octet-stream","text/plain"}) public jakarta.ws.rs.core.Response postBPMNModel(@PathParam("filename") String filename, org.openbpmn.bpmn.BPMNModel bpmnmodel)

    • putModelByVersion

      @PUT @Path("/{version}") @Consumes({"application/xml","text/xml"}) public void putModelByVersion(@PathParam("version") String _modelVersion, XMLDataCollection ecol)
      This method updates a Model provided in a EntityCollection object for a provided model version. The Method expects a subresource with a ModelVersion. Next the method updates each Entity object with the property $ModelVersion. An old version will be automatically removed before update.
      Parameters:
      version - - $modelversion
      ecol - - model data

    • postModelByVersion

      @POST @Path("/{version}") @Consumes({"application/xml","text/xml"}) public void postModelByVersion(@PathParam("version") String sModelVersion, XMLDataCollection ecol)

    • putModel

      @PUT @Consumes({"application/xml","text/xml"}) public void putModel(XMLDataCollection ecol)
      This method updates a Model provided in a EntityCollection object. The method takes the first entity to get the provided $modelVersion. An old version will be automatically removed before update.
      Parameters:
      ecol -

    • postModel

      @POST @Consumes({"application/xml","text/xml"}) public void postModel(XMLDataCollection ecol)