Package org.imixs.workflow.jaxrs

Class AdminPRestService

java.lang.Object
org.imixs.workflow.jaxrs.AdminPRestService
@Path("/adminp") @Produces({"text/html","application/xml","application/json","text/xml"}) public class AdminPRestService extends Object
The AdminPRestService provides methods to access the AdminPService EJB
Author:
rsoika

  • Constructor Details

    • AdminPRestService

      public AdminPRestService()

  • Method Details

    • getHelpHTML

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

    • getAllJobs

      @GET @Path("/jobs") public XMLDataCollection getAllJobs()
      Returns all existing jobs
      Parameters:
      query -
      pageSize -
      pageIndex -
      items -
      Returns:

    • putJob

      @POST @Path("/jobs/") @Produces("application/xml") @Consumes({"application/xml","text/xml"}) public jakarta.ws.rs.core.Response putJob(XMLDocument xmlworkitem)
      This method saves a entity provided in xml format Note: the method merges the content of the given entity into an existing one because the EntityService method save() did not merge an entity. But the rest service typically consumes only a subset of attributes. So this is the reason why we merge the entity here. In different to the behavior of the EntityService the WorkflowService method process() did this merge automatically.
      Parameters:
      xmlworkitem - - entity to be saved
      Returns:

    • restartJob

      @GET @Path("/jobs/restart/{id}") public jakarta.ws.rs.core.Response restartJob(@PathParam("id") String id)
      Restarts a Job by ID
      Parameters:
      id -
      Returns:

    • deleteJob

      @DELETE @Path("/jobs/{uniqueid}") public jakarta.ws.rs.core.Response deleteJob(@PathParam("uniqueid") String uniqueid)
      This method deletes an entity