Package com.logicaldoc.webservice.rest

Interface SystemService

All Known Implementing Classes:

RestSystemService, RestSystemSwagger

@Consumes("application/json")
@Produces("application/json")
public interface SystemService

System Web Service definition interface for REST. Alessandro Gasparini - LogicalDOC

Since:

8.4.2

Method Summary

Modifier and Type	Method	Description
WSSystemInfo	getInfo()	Retrieves the Installation informations
String[]	getLanguages()	Retrieves the languages enabled in the server.
WSParameter[]	getStatistics()	Retrieves the system statistics

Method Details

getInfo

@GET
@Path("/getInfo")
WSSystemInfo getInfo()
              throws WebserviceException

Retrieves the Installation informations

Returns:

The value object containing the installation informations

Throws:

WebserviceException - Error in the webservice

getStatistics

@GET
@Path("/getStatistics")
WSParameter[] getStatistics()
                     throws AuthenticationException,
WebserviceException,
PersistenceException

Retrieves the system statistics

Returns:

The value object containing the statistics values

Throws:

PersistenceException - Error in the database

WebserviceException - Error in the webservice

AuthenticationException - Invalid session

getLanguages

@GET
@Path("/getLanguages")
String[] getLanguages()

Retrieves the languages enabled in the server.

Returns:

Array of active languages (en, it, es ....)