Device Recipes Actions

https://api.losant.com/applications/APPLICATION_ID/device-recipes

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

Get

Returns the device recipes for an application

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/device-recipes

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.Organization, all.Organization.read, all.User, all.User.read, deviceRecipes.*, or deviceRecipes.get.

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
sortField	N	Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated	name	sortField=name
sortDirection	N	Direction to sort the results by. Accepted values are: asc, desc	asc	sortDirection=asc
page	N	Which page of results to return	0	page=0
perPage	N	How many items to return per page	100	perPage=10
filterField	N	Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name		filterField=name
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		filter=my * recipe
tagsAsObject	N	Return tags as an object map instead of an array		tagsAsObject=false
attributesAsObject	N	Return attributes as an object map instead of an array		attributesAsObject=true

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/device-recipes

Successful Responses

Code	Type	Description
200	Device Recipes	Collection of device recipes

Error Responses

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

Post

Create a new device recipe for an application

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/device-recipes

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, deviceRecipes.*, or deviceRecipes.post.

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
tagsAsObject	N	Return tags as an object map instead of an array		tagsAsObject=false
attributesAsObject	N	Return attributes as an object map instead of an array		attributesAsObject=true

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

{
  "name": "My New Device Recipe",
  "deviceName": "Future device name",
  "description": "Description of my new device recipe",
  "deviceDescription": "Future device description",
  "tags": [
    {
      "key": "TagKey",
      "value": "TagValue"
    }
  ],
  "attributes": [
    {
      "name": "voltage",
      "dataType": "number"
    }
  ],
  "deviceClass": "standalone"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"name":"My New Device Recipe","deviceName":"Future device name","description":"Description of my new device recipe","deviceDescription":"Future device description","tags":[{"key":"TagKey","value":"TagValue"}],"attributes":[{"name":"voltage","dataType":"number"}],"deviceClass":"standalone"}' \
    https://api.losant.com/applications/APPLICATION_ID/device-recipes

Successful Responses

Code	Type	Description
201	Device Recipe	Successfully created device recipe

Error Responses

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

Schemas

Device Recipe

Schema for a single Device Recipe

Device Recipe Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 16 keys
▶
id:{} 2 keys
▶
deviceRecipeId:{} 2 keys
▶
applicationId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
name:{} 3 keys
▶
deviceName:{} 3 keys
▶
description:{} 2 keys
▶
deviceDescription:{} 2 keys
▶
tags:{} 3 keys
▶
attributes:{} 3 keys
▶
deviceClass:{} 2 keys
▶
gatewayId:{} 2 keys
▶
parentId:{} 1 key
▶
systemInterval:{} 3 keys
▶
keepDuplicates:{} 1 key

Device Recipe Example

▶
root:{} 12 keys
id:"575ecec57ae143cd83dc4a9f"
deviceRecipeId:"575ecec57ae143cd83dc4a9f"
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
name:"Actual recipe name"
deviceName:"Future device name"
description:"My recipe description"
deviceDescription:"Future device description"
▶
tags:[] 1 item
▶
attributes:[] 1 item
deviceClass:"standalone"

Device Recipe Post

Schema for the body of a Device Recipe creation request

Device Recipe Post Schema

▶
root:{} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 11 keys
▶
name:{} 3 keys
▶
deviceName:{} 3 keys
▶
description:{} 2 keys
▶
deviceDescription:{} 2 keys
▶
tags:{} 3 keys
▶
attributes:{} 3 keys
▶
deviceClass:{} 2 keys
▶
gatewayId:{} 2 keys
▶
parentId:{} 1 key
▶
systemInterval:{} 3 keys
▶
keepDuplicates:{} 1 key
additionalProperties:false
▶
required:[] 1 item

Device Recipe Post Example

▶
root:{} 7 keys
name:"My New Device Recipe"
deviceName:"Future device name"
description:"Description of my new device recipe"
deviceDescription:"Future device description"
▶
tags:[] 1 item
▶
attributes:[] 1 item
deviceClass:"standalone"

Device Recipes

Schema for a collection of Device Recipes

Device Recipes Schema

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

Device Recipes Example

▶
root:{} 8 keys
▶
items:[] 1 item
count:1
totalCount:4
perPage:1
page:0
sortField:"name"
sortDirection:"asc"
applicationId:"575ec8687ae143cd83dc4a97"

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"