Package org.openremote.model.console

Interface ConsoleResource

@Path("console")
public interface ConsoleResource

Method Summary

Modifier and Type	Method	Description
ConsoleRegistration	register(RequestParams requestParams, @NotNull @Valid ConsoleRegistration consoleRegistration)	Creates or updates the registration for the specified console; if the ConsoleRegistration.getId() contains an ID then it is an update operation otherwise it is a create operation, in both cases the saved ConsoleRegistration is returned which should be used for future calls to this endpoint.

Method Details

register

@POST
@Path("register")
@Consumes("application/json")
@Produces("application/json")
ConsoleRegistration register(@BeanParam
 RequestParams requestParams,
 @NotNull @Valid
 @NotNull @Valid ConsoleRegistration consoleRegistration)

Creates or updates the registration for the specified console; if the ConsoleRegistration.getId() contains an ID then it is an update operation otherwise it is a create operation, in both cases the saved ConsoleRegistration is returned which should be used for future calls to this endpoint.

Behind the scenes the console registration is converted into an asset and the ConsoleRegistration data is stored in the appropriate ConsoleAsset Attributes.

This is a public endpoint and allows the registration of consoles anonymously; if there is an authenticated user registering the console then the console asset will be linked to that user. If multiple users login on the same console then it will be associated with each user (i.e. a 1-many relationship).