DeviceProfile
Realm Operations
The device profile service is responsible for exposing functions to change the collection of User devices. The supported methods are update, delete, query
Resource path:
/users/{user}/devices/profile
Resource version: 1.0
delete
Delete user device
Usage
am> delete DeviceProfile --realm Realm --id id --user user
Parameters
- --id
-
The unique identifier for the resource.
- --user
-
The device profile service is responsible for exposing functions to change the collection of User devices. The supported methods are update, delete, query
query
Query the user devices
Usage
am> query DeviceProfile --realm Realm --filter filter --user user
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all. Fields that can be queried: [*]
- --user
-
The device profile service is responsible for exposing functions to change the collection of User devices. The supported methods are update, delete, query
update
Update an existing user device alias
Usage
am> update DeviceProfile --realm Realm --id id --body body --user user
Parameters
- --id
-
The unique identifier for the resource.
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "$schema" : "http://json-schema.org/draft-04/schema#", "description" : "User devices schema that is used for device profile", "type" : "object", "title" : "User devices schema", "properties" : { "identifier" : { "type" : "string", "title" : "Identifier", "description" : "The unique identifier of the device" }, "alias" : { "type" : "string", "title" : "Device alias name", "description" : "The alias name of user device" }, "lastSelectedDate" : { "type" : "string", "title" : "Last selected date", "description" : "Date when the device was selected last time" }, "metadata" : { "type" : "object", "title" : "Device Metadata", "description" : "The JSON representation of device metadata" }, "location" : { "type" : "object", "title" : "Device Location", "description" : "The current device location", "properties" : { "longitude" : { "type" : "number", "title" : "Location latitude", "description" : "The location latitude" }, "latitude" : { "type" : "number", "title" : "Location longitude", "description" : "The location longitude" } } } } }
- --user
-
The device profile service is responsible for exposing functions to change the collection of User devices. The supported methods are update, delete, query