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.

name path methods description
AuthApiController
  • /auth/qr
  • /auth/tokens
  • /auth/service/login
  • /auth/service/logout
  • /auth/service/ua
  • /auth/tokens/{tokenId}
  • /auth/service/password/strength/{password}
  • GET POST
  • GET
  • POST
  • GET
  • GET
  • DELETE
  • GET
Controller for authorizations.
ClusterApiController
  • /cluster/host
  • GET
Controller for cluster actions.
DeviceBuilderController
  • /builder/create/{serverPackageId}
  • /builder/discovery/devices/{discoveredId}
  • /builder/packages/{package}/devices/{device}
  • POST
  • GET
  • GET
Controller for the device builder.
HardwareApiController
  • /hardware
  • /hardware/interface/{interface}
  • /hardware/type/{transport}
  • /hardware/interface/{interface}/{key}
  • /hardware/peripheral/{volatilePeripheralId}/drivers
  • /hardware/peripheral/{volatilePeripheralId}/stats
  • /hardware/peripheral/{volatilePeripheralId}/stop
  • /hardware/peripheral/{volatilePeripheralId}/settings/{driverDefinitionId}
  • /hardware/peripheral/{volatilePeripheralId}/start/{driverDefinitionId}
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • PUT
Controller for controlling and maintaining the configurations, adding and removing of peripherals to the system.
InstallerApiController
  • /installation/repositories
  • /installation/repositories/{id}
  • GET PUT
  • DELETE
Controller for all installation related REST actions.
ItemApiController
  • /items
  • /items/all
  • /items/discovered
  • /items/region
  • /items/all/region
  • /items/definitions/{itemType}
  • /items/discovered/{discoveredItemId}
  • /items/item/{itemDefinitionId}
  • /items/item/{itemId}
  • /items/discovered/{discoveredItemId}/{itemDefinitionId}
  • /items/item/{itemId}/definition
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • DELETE GET PATCH PUT
  • POST
  • GET
Controller for items available for the end user to interact with.
ModulesApiController
  • /modules
  • /modules/active
  • /modules/capabilities
  • /modules/discovery/options
  • /modules/module/start
  • /modules/type/{type}
  • /modules/module/{activeContainerId}/info
  • /modules/module/{activeContainerId}/stop
  • /modules/type/{type}/{transport}
  • /modules/module/{activeContainerId}/discovery/start
  • /modules/module/{activeContainerId}/discovery/stop
  • GET
  • GET
  • GET
  • GET
  • POST
  • GET
  • GET
  • GET
  • GET
  • PUT
  • GET
Controller for controlling and maintaining the configurations, adding and removing of modules on the system.
PersonApiController
  • /person
  • /person/{id}
  • GET PATCH POST
  • DELETE GET
Controller for the person API.
PremisesController
  • /premises
  • /premises/{premisesId}
  • /premises/{premisesId}/properties
  • /premises/{premisesId}/sections
  • /premises/{premisesId}/properties/{propertyId}
  • /premises/{premisesId}/sections/{sectionId}
  • /premises/{premisesId}/properties/{propertyId}/levels
  • /premises/{premisesId}/properties/{propertyId}/levels/{propertyLevelId}
  • /premises/{premisesId}/properties/{propertyId}/levels/{propertyLevelId}/sections
  • /premises/{premisesId}/properties/{propertyId}/levels/{propertyLevelId}/sections/{sectionId}
  • GET PATCH POST
  • DELETE GET
  • GET PATCH POST
  • GET PATCH POST
  • DELETE GET
  • DELETE GET
  • GET PATCH POST
  • DELETE GET POST
  • GET PATCH
  • DELETE GET
The controller for premises and properties.
SystemApiController
  • /system/discovery
  • /system/locale
  • /system/locales
  • /system/network
  • /system/export/database
  • POST
  • GET PUT
  • GET
  • GET
  • GET
Controller for system API's.
UserApiController
  • /users
  • /users/me
  • /users/me/password
  • /users/user/{id}
  • GET POST
  • GET
  • PATCH
  • DELETE GET PUT
API Controller for the UserLogin object.