Device Attributes Actions

https://api.losant.com/applications/APPLICATION_ID/devices/DEVICE_ID/attributes

Below are the various requests that can be performed against the Device Attributes resource, as well as the expected parameters and the potential responses.

Get

Returns the attributes for a device

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/devices/DEVICE_ID/attributes

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Device, all.Device.read, all.Organization, all.Organization.read, all.User, all.User.read, deviceAttributes.*, or deviceAttributes.get.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
DEVICE_ID	ID associated with the device	575ecf887ae143cd83dc4aa2

Request Query Parameters

Name	Required	Description	Default	Example
sortField	N	Field to sort the results by. Accepted values are: name, dataType	name	sortField=status
sortDirection	N	Direction to sort the results by. Accepted values are: asc, desc	asc	sortDirection=asc
filterField	N	Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name, dataType		filterField=status
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		filter=number

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X GET \
    https://api.losant.com/applications/APPLICATION_ID/devices/DEVICE_ID/attributes

Successful Responses

Code	Type	Description
200	Device Attributes	Collection of device attributes

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if device was not found

Post

Adds a new attribute to a device

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/devices/DEVICE_ID/attributes

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, deviceAttributes.*, or deviceAttributes.post.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
DEVICE_ID	ID associated with the device	575ecf887ae143cd83dc4aa2

Request Headers

Name	Required	Description	Default
Authorization	Y	The token for authenticating the request, prepended with Bearer

Request Body

The body of the request should be serialized JSON that validates against the Device Attribute Post schema. For example, the following would be a valid body for this request:

{
  "name": "voltage",
  "dataType": "number"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"name":"voltage","dataType":"number"}' \
    https://api.losant.com/applications/APPLICATION_ID/devices/DEVICE_ID/attributes

Successful Responses

Code	Type	Description
201	Device Attribute	Successfully created device attribute

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if device was not found

Schemas

Device Attribute

Schema for a single Device Attribute

Device Attribute Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 8 keys
▶
name:{} 2 keys
▶
dataType:{} 2 keys
▶
contentType:{} 2 keys
▶
description:{} 2 keys
▶
attributeTags:{} 3 keys
▶
system:{} 3 keys
▶
applicationId:{} 2 keys
▶
deviceId:{} 2 keys

Device Attribute Example

▶
root:{} 4 keys
deviceId:"575ecf887ae143cd83dc4aa2"
applicationId:"575ec8687ae143cd83dc4a97"
name:"voltage"
dataType:"number"

Device Attribute Post

Schema for the body of a Device Attribute creation request

Device Attribute Post Schema

▶
root:{} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 6 keys
▶
name:{} 2 keys
▶
dataType:{} 2 keys
▶
contentType:{} 2 keys
▶
description:{} 2 keys
▶
attributeTags:{} 3 keys
▶
system:{} 3 keys
▶
required:[] 2 items
additionalProperties:false

Device Attribute Post Example

▶
root:{} 2 keys
name:"voltage"
dataType:"number"

Device Attributes

Schema for a collection of Device Attributes

Device Attributes Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 9 keys
▶
items:{} 2 keys
▶
count:{} 1 key
▶
totalCount:{} 1 key
▶
filter:{} 1 key
▶
filterField:{} 1 key
▶
sortField:{} 1 key
▶
sortDirection:{} 2 keys
▶
applicationId:{} 2 keys
▶
deviceId:{} 2 keys

Device Attributes Example

▶
root:{} 7 keys
▶
items:[] 1 item
count:1
totalCount:1
sortField:"name"
sortDirection:"asc"
applicationId:"575ec8687ae143cd83dc4a97"
deviceId:"575ecf887ae143cd83dc4aa2"

Error

Schema for errors returned by the API

Error Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys
▶
type:{} 1 key
▶
message:{} 1 key

Error Example

▶
root:{} 2 keys
type:"NotFound"
message:"Application was not found"