AdminPRestService (Rest API 6.0.3 API)

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 Summary

Constructors
Constructor Description

AdminPRestService()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`jakarta.ws.rs.core.Response`	`deleteJob(String uniqueid)`	This method deletes an entity
`org.imixs.workflow.xml.XMLDataCollection`	`getAllJobs()`	Returns all existing jobs
`jakarta.ws.rs.core.StreamingOutput`	`getHelpHTML()`
`jakarta.ws.rs.core.Response`	`putJob(org.imixs.workflow.xml.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.

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

- Constructor Detail
  - AdminPRestService
```
public AdminPRestService()
```
- Method Detail
  - getHelpHTML
```
@GET
@Produces("text/html")
@Path("/help")
public jakarta.ws.rs.core.StreamingOutput getHelpHTML()
```
  - getAllJobs
```
@GET
@Path("/jobs")
public org.imixs.workflow.xml.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(org.imixs.workflow.xml.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:
  - deleteJob
```
@DELETE
@Path("/jobs/{uniqueid}")
public jakarta.ws.rs.core.Response deleteJob(@PathParam("uniqueid")
                                             String uniqueid)
```
    This method deletes an entity