Device
The Device resource represents the hardware used to record data.
Device Identifier
A device is identified by the combination of manufacturer and model (lower case), separated by _.
Resource URIs
Item URI: /v7.1/device/{pk}/
Collection URI: /v7.1/device/
Item
Item Methods
GETRetrieve a Device by id.PUTUpdate a Device by id.
Item query parameters
None
Item properties
| Name | Description | Type | Units | HTTP Support |
|---|---|---|---|---|
name |
Name of the device, max length 100 characters | String | GET: required, PUT: optional, POST: optional | |
description |
Description of the device, max length 255 characters | String | GET: required, PUT: optional, POST: optional | |
manufacturer |
Short name of manufacturer | String | GET: required, PUT: immutable, POST: required | |
model |
Model of the device | String | GET: required, PUT: immutable, POST: required |
Example values
model- Allowed characters: Value must begin with uppercase and lowercase letters (will be converted to lower case), and may end with upper and lower case letters or decimal digits, hyphen, and period (as a regular expression:^[a-zA-Z0-9][a-zA-Z0-9~\.\-]*$).- Valid models:
"sm-g900t","smg900t","SM-g900t"(auto-converted to"sm-g900t") - Invalid models:
"sm g900t","sm_g900t" manufacturer- Allowed characters: uppercase and lowercase letters (will be converted to lower case) (as a regular expression:/^[a-zA-Z]*$/).- Valid manufacturers:
"samsung","outside" - Invalid manufacturers:
"outside inc","outside_inc"
Item links
selfA link to this resource.
Collection
Collection methods
GETGet a list of Devices.POSTCreate a Device.
Collection query parameters
| Name | Description | Type | Required |
|---|---|---|---|
manufacturer |
description of param name | String | Yes |
Collection properties
| Name | Description | Type | Units | HTTP Support |
|---|---|---|---|---|
total_count |
count of objects returned | Number | GET: required |
Collection links
selfA link to this resource.
Embedded collections
devicesA collection of Devices with properties as described under Item properties and links as described under Item links.
Usage
GET Device entity
Request GET: /v7.1/device/samsung_sm-g900t/
Response
{
"model": "sm-g900t",
"manufacturer": "samsung",
"name": "Samsung SM G900T Activity Tracker",
"description": "Tracks activity data",
"_links": {
"self": [{
"href": "/v7.1/device/samsung_sm-g900t/"
}]
}
}
GET Device collection
Request GET: /v7.1/device/?manufacturer=samsung
Response
{
"_embedded": {
"devices": [
{
"model": "sm-g900t",
"manufacturer": "samsung",
"name": "Samsung SM G900T Activity Tracker",
"description": "Tracks activity data",
"_links": {
"self": [{
"href": "/v7.1/device/samsung_sm-g900t/"
}]
}
},
{
"model": "gear-fit",
"manufacturer": "samsung",
"name": "Samsung Gear Fit",
"description": "Samsung Gear Fit Activity Tracker",
"_links": {
"self": [{
"href": "/v7.1/device/samsung_gear-fit/",
"id": "samsung_gear-fit"
}]
}
}
]
},
"_links": {
"self": [{
"href": "/v7.1/device/?manufacturer=samsung"
}]
},
"total_count": 2
}
POST Device entity
Request POST: /v7.1/device/
{
"model": "sm-g900t",
"manufacturer": "samsung",
"name": "Samsung SM G900T Activity Tracker",
"description": "Tracks activity data"
}
Response
{
"model": "sm-g900t",
"manufacturer": "samsung",
"name": "Samsung SM G900T Activity Tracker",
"description": "Tracks activity data",
"_links": {
"self": [{
"href": "/v7.1/device/samsung_sm-g900t/"
}]
}
}
PUT Device entity
Request PUT: /v7.1/device/samsung_sm-g900t/
{
"name": "Samsung SM G900T Activity Tracker",
"description": "New Description"
}
Response
{
"model": "sm-g900t",
"manufacturer": "samsung",
"name": "Samsung SM G900T Activity Tracker",
"description": "New Description",
"_links": {
"self": [{
"href": "/v7.1/device/samsung_sm-g900t/"
}]
}
}