Application Templates Actions
https://api.losant.com/applicationTemplates
Below are the various requests that can be performed against the Application Templates resource, as well as the expected parameters and the potential responses.
Get
Returns the application templates the current user has permission to see
Method And Url
GET https://api.losant.com/applicationTemplates
Authentication
A valid API access token is required to access this endpoint. The token must
include at least one of the following scopes:
all.User, all.User.read, applicationTemplates.*, or applicationTemplates.get.
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, authorName | filterField=name | |
| filter | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | filter=my * app | |
| keywords | N | List of keywords to filter by. Matches all provided keywords. | keywords[0]=gps&keywords[1]=aws | |
| categoryId | N | ID of a category to filter by. | categoryId=575ec76c7ae143cd83dc4a96 |
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/applicationTemplates
Successful Responses
| Code | Type | Description |
|---|---|---|
| 200 | Application Templates | Collection of application templates |
Error Responses
| Code | Type | Description |
|---|---|---|
| 400 | Error | Error if malformed request |
Get Categories
Returns a category list, beginning at the specified category
Method And Url
GET https://api.losant.com/applicationTemplates/categories
Authentication
A valid API access token is required to access this endpoint. The token must
include at least one of the following scopes:
all.User, all.User.read, applicationTemplates.*, or applicationTemplates.getCategories.
Request Query Parameters
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| baseId | N | ID of the category to begin from | baseId=575ed6e87ae143cd83dc4aa8 |
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/applicationTemplates/categories
Successful Responses
| Code | Type | Description |
|---|---|---|
| 200 | Application Template Categories | Collection of application categories |
Error Responses
| Code | Type | Description |
|---|---|---|
| 400 | Error | Error if malformed request |
Get Unique Keywords
Returns an array of all unique keywords currently in use by templates
Method And Url
GET https://api.losant.com/applicationTemplates/keywords
Authentication
A valid API access token is required to access this endpoint. The token must
include at least one of the following scopes:
all.User, all.User.read, applicationTemplates.*, or applicationTemplates.getUniqueKeywords.
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/applicationTemplates/keywords
Successful Responses
| Code | Type | Description |
|---|---|---|
| 200 | Template Keywords | Array of all unique template keywords |
Error Responses
| Code | Type | Description |
|---|---|---|
| 400 | Error | Error if malformed request |
Schemas
Application Template Categories
Schema for a collection of Application Template Categories
Application Template Categories Schema
- ▶{} 3 keys
- "http://json-schema.org/draft-07/schema#"
- "object"
- ▶{} 4 keys
- ▶{} 2 keys
- ▶{} 2 keys
- ▶{} 1 key
- ▶{} 1 key
Application Template Categories Example
- ▶{} 4 keys
- ▶[] 2 items
- "586e9d5151265cb9d72f6ec6"
- 2
- 2
Application Templates
Schema for a collection of Application Templates
Application Templates Schema
- ▶{} 3 keys
- "http://json-schema.org/draft-07/schema#"
- "object"
- ▶{} 11 keys
- ▶{} 2 keys
- ▶{} 1 key
- ▶{} 1 key
- ▶{} 1 key
- ▶{} 1 key
- ▶{} 1 key
- ▶{} 1 key
- ▶{} 2 keys
- ▶{} 3 keys
- ▶{} 1 key
- ▶{} 2 keys
Application Templates Example
- ▶{} 7 keys
- ▶[] 1 item
- 1
- 8
- 1
- 0
- "name"
- "asc"
Error
Schema for errors returned by the API
Error Schema
- ▶{} 3 keys
- "http://json-schema.org/draft-07/schema#"
- "object"
- ▶{} 2 keys
- ▶{} 1 key
- ▶{} 1 key
Error Example
- ▶{} 2 keys
- "NotFound"
- "Application was not found"
Template Keywords
Schema for a collection of template keywords
Template Keywords Schema
- ▶{} 3 keys
- "http://json-schema.org/draft-07/schema#"
- ▶{} 1 key
- ▶{} 3 keys
- false
Template Keywords Example
- ▶{} 1 key
- ▶[] 2 items
Was this page helpful?
Still looking for help? You can also search the Losant Forums or submit your question there.