Device Attribute Actions

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

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

Delete

Removes an attribute from a device

Method And Url

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

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.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, deviceAttribute.*, or deviceAttribute.delete.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
DEVICE_ID	ID associated with the device	575ecf887ae143cd83dc4aa2
NAME	Name of the attribute	voltage

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 DELETE \
    https://api.losant.com/applications/APPLICATION_ID/devices/DEVICE_ID/attributes/NAME

Successful Responses

Code	Type	Description
200	Success	If device attribute was successfully deleted

Error Responses

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

Get

Retrieves information on a device attribute

Method And Url

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

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.bounded, all.Application.read, all.Device, all.Device.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, deviceAttribute.*, or deviceAttribute.get.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
DEVICE_ID	ID associated with the device	575ecf887ae143cd83dc4aa2
NAME	Name of the attribute	voltage

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/NAME

Successful Responses

Code	Type	Description
200	Device Attribute	Device attribute information

Error Responses

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

Patch

Updates an attribute on a device

Method And Url

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

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.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, deviceAttribute.*, or deviceAttribute.patch.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
DEVICE_ID	ID associated with the device	575ecf887ae143cd83dc4aa2
NAME	Name of the attribute	voltage

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 Patch schema. For example, the following would be a valid body for this request:

{
  "description": "my new attribute description"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"description":"my new attribute description"}' \
    https://api.losant.com/applications/APPLICATION_ID/devices/DEVICE_ID/attributes/NAME

Successful Responses

Code	Type	Description
200	Device Attribute	Updated device attribute information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if device attribute 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 Patch

Schema for the body of a Device Attribute modification request

Device Attribute Patch Schema

▶
(root){} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 5 keys
▶
name:{} 2 keys
▶
contentType:{} 2 keys
▶
description:{} 2 keys
▶
attributeTags:{} 3 keys
▶
system:{} 3 keys
additionalProperties:false

Device Attribute Patch Example

▶
(root){} 1 key
description:"my new attribute description"

Error

Schema for errors returned by the API

Error Schema

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

Error Example

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

Success

Schema for reporting a successful operation

Success Schema

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

Success Example

▶
(root){} 1 key
success:true