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

Was this page helpful?

Still looking for help? You can also search the Losant Forums or submit your question there.