Devices
This page provides a description of the available API routes for managing devices.
Last updated
Was this helpful?
This page provides a description of the available API routes for managing devices.
Last updated
Was this helpful?
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 class.
GET
http://{server-address}/devices
Returns all devices that matches query parameters. Result is of type .
name
string
Supports NData syntax.
$skip
int
Pagination property. Describing number of records to skip from beginning of result collection.
$take
int
Pagination property. Maximum count of items to be returned.
$sort
string[]
Comma separated list of property names. Please see NData syntax.
$count
bool
If set to true
, response will not contain items
collection. Use to get resource count, not the resources themselves.
isActive
bool
Supports NData syntax.
envName
string
Supports NData syntax.
Authorization*
string
Authorization header with authorization token.
GET
http://{server-address}/devices/{name}
name*
string
Unique device name.
Authorization*
string
Authorization header with authorization token.
POST
http://{server-address}/devices
Required rights
Authorization*
string
Authorization header with authorization token.
(body)*
Device
Model to create.
PUT
http://{server-address}/devices/{name}
Required rights
name*
string
Unique device name.
Authorization*
string
Authorization header with authorization token.
(body)*
Device
Model to create or update.
DELETE
http://{server-address}/devices/{name}
Required rights
name*
string
Unique device name.
Authorization*
string
Authorization header with authorization token.
Result is of type .
Creates new device. Result is of type .
Authorized user must have DeviceCreate
assigned.
Creates new or updates existing device. Result is of type .
Authorized user must have assigned DeviceCreate
or DeviceUpdate
.
Authorized user must have DeviceDelete
assigned.