Device

Device Management API.

When devices are initialized with the Ioto agent, they will "register" with the Builder service using their device ID (ClaimID) at https://admin.embedthis.com/api. The device registration API is part of the Builder API. See Device Registration.

Once registered, the device then remains under the management of the Builder until it is "claimed" by a user for management using the "Device Claim" API. When claimed, the device is redirected to the device cloud when it next invokes the "register" API.

Get

The Get API will fetch a device by its ID (ClaimID).

Endpoint

POST /device/get

Authorized User Role

user

Request Body

Field	Type	Required	Role	Notes
id	string	yes		Device Claim ID.
accountId	string		owner	Manager account ID. Required if using CloudAPI token.

Response

Field	Type	Notes
accessed	date	When the device was last accessed.
accountId	string	Owning manager account ID.
created	date	When the device was first claimed.
id	string	Device Claim ID.
product	string	Builder Product name.
productId	string	Builder Product ID.
test	boolean	Device is for test purposes.
version	string	Firmware version.
checked	string	Checked version.

Claim

Claim a device for management by a device cloud.

Once a device has registered itself with the builder, a user can claim the device for management.
The claim ID would typically be printed on the device label during manufacturer.

A claim request may specify the device as a test device where it will not be counted towards the subscription device count.

Endpoint

POST /device/claim

Authorized User Role

claimDevice

Request Body

Field	Type	Required	Notes
id	string	yes	Device claim ID.

Response

The claimed device.

Field	Type	Notes
accessed	date	When the device was last accessed.
accountId	string	Owning manager account ID.
created	date	When the device was first claimed.
id	string	Device Claim ID.
product	string	Builder Product name.
productId	string	Builder Product ID.
test	boolean	Device is for test purposes.
version	string	Firmware version.
checked	string	Checked version.

Find

Find matching devices filtered by matching properties.

Endpoint

POST /device/find

Authorized User Role

user

Request Body

Field	Type	Role	Notes
id	string		Device Claim ID.
accountId	string	owner	Manager account ID. Required if using CloudAPI token.
productId	string		Product registration ID from the Builder product list.

Query String Options

Field	Type	Notes
filter	string	Full text string to filter for.
next	object	Pagination token for the next page.
prev	object	Pagination token for the previous page.
limit	number	Number of items to retrieve.
index	string	Database index to use.
exists	boolean	Set to true to require the item exists, otherwise set to null to perform an upsert.

Response

Paged response.

Field	Type	Notes
data	array	An array of devices owned by the user.
next	string	Paged cursor to use for the next page of items.
prev	string	Pages cursor to use for the previous page of items.

Device

An array of Device items.

Field	Type	Notes
accessed	date	When the device was last accessed.
accountId	string	Owning manager account ID.
created	date	When the device was first claimed.
id	string	Device Claim ID.
product	string	Builder Product name.
productId	string	Builder Product ID.
test	boolean	Device is for test purposes.
version	string	Firmware version.
checked	string	Checked version.

Remove

Release a device from management by a device cloud. Releasing a device returns it to the builder to be available for claiming by another cloud.

Endpoint

POST /device/remove

Authorized User Role

user

Request Body

Field	Type	Required	Notes
id	string	yes	Device claim ID.

Response

Field	Type	Notes
accessed	date	When the device was last accessed.
accountId	string	Owning manager account ID.
created	date	When the device was first claimed.
id	string	Device Claim ID.
product	string	Builder Product name.
productId	string	Builder Product ID.
test	boolean	Device is for test purposes.
version	string	Firmware version.
checked	string	Checked version.