@Path(value="/v40/documents") @Produces(value={"text/html","application/xml","application/json","text/xml"}) public class DocumentRestServiceV40 extends Object
Constructor and Description |
---|
DocumentRestServiceV40() |
Modifier and Type | Method and Description |
---|---|
javax.ws.rs.core.Response |
backup(String query,
String filepath)
This method creates a backup of the result set form a JQPL query.
|
XMLCount |
countTotalHitsByQuery(String query,
int maxResult)
Returns a total hits for a lucene Search Query
|
XMLCount |
countTotalPagesByQuery(String query,
int pageSize)
Returns the total pages for a lucene Search Query and a given page size.
|
javax.ws.rs.core.Response |
deleteEntity(String uniqueid)
This method deletes an entity
|
DocumentCollection |
findDocumentsByJPQL(String query,
int pageSize,
int pageIndex,
String items)
Returns a resultset for a JPQL statement
|
DocumentCollection |
findDocumentsByQuery(String query,
int pageSize,
int pageIndex,
String sortBy,
boolean sortReverse,
String items)
Returns a resultset for a lucene Search Query
|
XMLItemCollection |
getConfiguration()
Returns the IndexFieldListNoAnalyse from the lucensUpdateService
|
XMLItemCollection |
getDocument(String uniqueid,
String items)
returns a single document defined by $uniqueid
|
javax.ws.rs.core.StreamingOutput |
getHelpHTML() |
javax.ws.rs.core.StreamingOutput |
getRoot() |
javax.ws.rs.core.Response |
postEntity(XMLItemCollection xmlworkitem)
The method saves a document provided in xml format.
|
javax.ws.rs.core.Response |
putEntity(XMLItemCollection xmlworkitem)
Delegater putEntity @PUT
|
javax.ws.rs.core.Response |
restore(String filepath)
This method restores a backup from the fileSystem
|
@GET @Produces(value="application/xhtml+xml") public javax.ws.rs.core.StreamingOutput getRoot()
@GET @Produces(value="text/html") @Path(value="/help") public javax.ws.rs.core.StreamingOutput getHelpHTML()
@GET @Path(value="/{uniqueid}") public XMLItemCollection getDocument(@PathParam(value="uniqueid") String uniqueid, @QueryParam(value="items") String items)
uniqueid
- @GET @Path(value="/search/{query}") public DocumentCollection findDocumentsByQuery(@PathParam(value="query") String query, @DefaultValue(value="-1") @QueryParam(value="pageSize") int pageSize, @DefaultValue(value="0") @QueryParam(value="pageIndex") int pageIndex, @QueryParam(value="sortBy") String sortBy, @QueryParam(value="sortReverse") boolean sortReverse, @QueryParam(value="items") String items)
query
- pageSize
- pageIndex
- items
- @GET @Path(value="/jpql/{query}") public DocumentCollection findDocumentsByJPQL(@PathParam(value="query") String query, @DefaultValue(value="100") @QueryParam(value="pageSize") int pageSize, @DefaultValue(value="0") @QueryParam(value="pageIndex") int pageIndex, @QueryParam(value="items") String items)
query
- pageSize
- pageIndex
- items
- @GET @Path(value="/count/{query}") public XMLCount countTotalHitsByQuery(@PathParam(value="query") String query, @DefaultValue(value="-1") @QueryParam(value="maxResult") int maxResult)
query
- pageSize
- pageIndex
- items
- @GET @Path(value="/countpages/{query}") public XMLCount countTotalPagesByQuery(@PathParam(value="query") String query, @DefaultValue(value="-1") @QueryParam(value="pageSize") int pageSize)
query
- pageSize
- pageIndex
- items
- @POST @Produces(value="application/xml") @Consumes(value={"application/xml","text/xml"}) public javax.ws.rs.core.Response postEntity(XMLItemCollection xmlworkitem)
xmlworkitem
- - entity to be saved@PUT @Produces(value="application/xml") @Consumes(value={"application/xml","text/xml"}) public javax.ws.rs.core.Response putEntity(XMLItemCollection xmlworkitem)
requestBodyStream
- putWorkitemDefault
@DELETE @Path(value="/{uniqueid}") public javax.ws.rs.core.Response deleteEntity(@PathParam(value="uniqueid") String uniqueid)
@PUT @Path(value="/backup/{query}") public javax.ws.rs.core.Response backup(@PathParam(value="query") String query, @QueryParam(value="filepath") String filepath)
query
- start
- count
- filepath
- - path in server filesystem@GET @Path(value="/restore") public javax.ws.rs.core.Response restore(@QueryParam(value="filepath") String filepath)
filepath
- - path in server fileSystem@GET @Path(value="/configuration") @Produces(value={"application/xml","application/json"}) public XMLItemCollection getConfiguration() throws Exception
Exception
Copyright © 2006–2019 Imixs Software Solutions GmbH. All rights reserved.