Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

name path methods description
AuthApiController
  • /auth
  • /auth/form
  • /auth/password
  • /auth/qr
  • POST
  • POST
  • PATCH
  • GET POST
Controller for authorizations.
ClusterApiController
  • /cluster/host
  • GET
Controller for cluster actions.
HardwareApiController
  • /hardware
  • /hardware/{interface}
  • /hardware/{interface}/{key}
  • /hardware/{interface}/{key}/drivers
  • /hardware/{interface}/{key}/settings
  • GET
  • GET
  • GET
  • GET
  • GET
Controller for controlling and maintaining the configurations, adding and removing of peripherals to the system.
PersonApiController
  • /person
  • /person/{id}
  • GET PATCH POST
  • DELETE GET PATCH
Controller for the person API.
SystemApiController
  • /system/discovery
  • /system/locale
  • /system/locales
  • /system/network
  • POST
  • GET PUT
  • GET
  • GET
Controller for system API's.
UserApiController
  • /user
  • /user/{id}
  • GET POST PUT
  • DELETE GET
API Controller for the UserLogin object.

Data Types

JSON

type description
AbstractUser
BooleanInput
CheckboxEnumInput
CheckboxInput
CustomSerialDevices Base device for serial interfaces which has been custom created by the user.
DiscoveryBroadcastMessage The message used for broadcasting.
DisplayInput
DoubleInput
GeoLocation The current GEO Location.
HardwareComponent An interface to ensure compatibility with hardware methods.
HardwareDriver
HostInformation Class providing host information.
InetAddress
InputField
InputFieldType
InputForm
IntegerInput
Interface The hardware interface of the component.
IpAddressInput
LoginObject A simple login object which can be used to authenticate a user.
MobileDevice A mobile device bound to an user.
NetInterface A network interface.
PassChangeObject Object used for password changes.
PasswordInput
Peripheral A to PiDome attached device.
PeripheralDriverCandidate A driver candidate for an attached peripheral.
Person Identifying a person.
PlatformInfo Identifying the platform running on.
PresentationSection
QrData The object holding the QR data. Object is required for completing the authorization process.
Role The user roles.
SelectEnumInput
SelectInput
SerialDevices Root class for serial based devices.
ServerVersion The server version.
ServicesConfig Class containing the configuration of the available services suitable for consuming.
StringMultiLineInput
StringSingleLineInput
SubSystem The sub system used to communicate with the peripheral.
SystemLocale A single system locale object.
USBDevices Covering class for all USB actions.
UrlInput
UserLogin User model. (Database annotations)