๐ฅ๏ธDevices
This page provides a description of the available API routes for managing devices.
In the PORTOS ecosystem, each cash register, mobile cashier, BackOffice, or any other software application is represented by a device that stores its settings and preferences.
Device is represented by Device
class.
API methods
Get devices
GET
http://{server-address}/devices
Returns all devices that matches query parameters. Result is of type QueryResult<Device>
.
Query Parameters
Headers
Get device by name
GET
http://{server-address}/devices/{name}
Result is of type Device.
Path Parameters
Headers
Create device
POST
http://{server-address}/devices
Creates new device. Result is of type Device.
Required rights
Authorized user must have DeviceCreate
right assigned.
Headers
Request Body
Create or update device
PUT
http://{server-address}/devices/{name}
Creates new or updates existing device. Result is of type Device.
Required rights
Authorized user must have assigned DeviceCreate
or DeviceUpdate
right.
Path Parameters
Headers
Request Body
Delete device by name
DELETE
http://{server-address}/devices/{name}
Required rights
Authorized user must have DeviceDelete
right assigned.
Path Parameters
Headers
Last updated