Details on the various actions that can be performed on the
Device Recipes resource, including the expected
parameters and the potential responses.
Returns the device recipes for an application
result = client.device_recipes.get(applicationId: my_application_id)
puts result
The client must be configured with a valid api access token to call this
action. 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.
Name |
Type |
Required |
Description |
Default |
Example |
applicationId |
string |
Y |
ID associated with the application |
|
575ec8687ae143cd83dc4a97 |
sortField |
string |
N |
Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated |
name |
name |
sortDirection |
string |
N |
Direction to sort the results by. Accepted values are: asc, desc |
asc |
asc |
page |
string |
N |
Which page of results to return |
0 |
0 |
perPage |
string |
N |
How many items to return per page |
100 |
10 |
filterField |
string |
N |
Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name |
|
name |
filter |
string |
N |
Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. |
|
my * recipe |
tagsAsObject |
string |
N |
Return tags as an object map instead of an array |
|
false |
attributesAsObject |
string |
N |
Return attributes as an object map instead of an array |
|
true |
losantdomain |
string |
N |
Domain scope of request (rarely needed) |
|
example.com |
Code |
Type |
Description |
400 |
Error |
Error if malformed request |
404 |
Error |
Error if application was not found |
Create a new device recipe for an application
result = client.device_recipes.post(
applicationId: my_application_id,
deviceRecipe: my_device_recipe)
puts result
The client must be configured with a valid api access token to call this
action. The token must include at least one of the following scopes:
all.Application, all.Organization, all.User, deviceRecipes.*, or deviceRecipes.post.
Name |
Type |
Required |
Description |
Default |
Example |
applicationId |
string |
Y |
ID associated with the application |
|
575ec8687ae143cd83dc4a97 |
deviceRecipe |
Device Recipe Post |
Y |
New device recipe information |
|
Device Recipe Post Example |
tagsAsObject |
string |
N |
Return tags as an object map instead of an array |
|
false |
attributesAsObject |
string |
N |
Return attributes as an object map instead of an array |
|
true |
losantdomain |
string |
N |
Domain scope of request (rarely needed) |
|
example.com |
Code |
Type |
Description |
201 |
Device Recipe |
Successfully created device recipe |
Code |
Type |
Description |
400 |
Error |
Error if malformed request |
404 |
Error |
Error if application was not found |