Package org.openremote.model.dashboard

Interface DashboardResource

@Path("dashboard")
public interface DashboardResource

Method Summary

Modifier and Type	Method	Description
Dashboard	create(RequestParams requestParams, @Valid Dashboard dashboard)
void	delete(RequestParams requestParams, String realm, String dashboardId)
Dashboard	get(RequestParams requestParams, String realm, String dashboardId)	Queries a specific Dashboard by its ID and realm, if a user has access to it.
Dashboard[]	getAllRealmDashboards(RequestParams requestParams, String realm)	Retrieve all dashboards from a realm, where the user has access to.
Dashboard[]	query(RequestParams requestParams, @Valid DashboardQuery dashboardQuery)	Advanced query endpoint for retrieving Dashboard from the database.
Dashboard	update(RequestParams requestParams, @Valid Dashboard dashboard)

Method Details

getAllRealmDashboards

@GET
@Path("all/{realm}")
@Produces("application/json")
Dashboard[] getAllRealmDashboards(@BeanParam
 RequestParams requestParams,
 @PathParam("realm")
 String realm)

Retrieve all dashboards from a realm, where the user has access to.

Returns:

An array of Dashboard from the realm

get

@GET
@Path("{realm}/{dashboardId}")
@Produces("application/json")
Dashboard get(@BeanParam
 RequestParams requestParams,
 @PathParam("realm")
 String realm,
 @PathParam("dashboardId")
 String dashboardId)

Queries a specific Dashboard by its ID and realm, if a user has access to it.

Returns:

Dashboard

query

@POST
@Path("query")
@Consumes("application/json")
@Produces("application/json")
Dashboard[] query(@BeanParam
 RequestParams requestParams,
 @Valid
 @Valid DashboardQuery dashboardQuery)

Advanced query endpoint for retrieving Dashboard from the database. Based on the DashboardQuery given, it will specifically filter the entries that are returned. For example filtering by displayName, ID, or dashboard access.

Returns:

An array of Dashboard

create

@POST
@Consumes("application/json")
@Produces("application/json")
@RolesAllowed("write:insights")
Dashboard create(@BeanParam
 RequestParams requestParams,
 @Valid
 @Valid Dashboard dashboard)

update

@PUT
@Consumes("application/json")
@Produces("application/json")
@RolesAllowed("write:insights")
Dashboard update(@BeanParam
 RequestParams requestParams,
 @Valid
 @Valid Dashboard dashboard)

delete

@DELETE
@Path("{realm}/{dashboardId}")
@Produces("application/json")
@RolesAllowed("write:insights")
void delete(@BeanParam
 RequestParams requestParams,
 @PathParam("realm")
 String realm,
 @PathParam("dashboardId")
 String dashboardId)