Applications Actions

https://api.losant.com/applications

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

Get

Returns the applications the current user has permission to see

Method And Url

GET https://api.losant.com/applications

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, applications.*, or applications.get.

Request Query Parameters

Name	Required	Description	Default	Example
sortField	N	Field to sort the results by. Accepted values are: name, id, creationDate, ownerId, 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 * app
orgId	N	If not provided, return all applications. If provided but blank, only return applications belonging to the current user. If provided and an id, only return applications belonging to the given organization id.		orgId=575ecdf07ae143cd83dc4a9a
summaryExclude	N	Comma-separated list of summary fields to exclude from application summary		summaryExclude=payloadCount
summaryInclude	N	Comma-separated list of summary fields to include in application summary		summaryInclude=payloadCount

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

Successful Responses

Code	Type	Description
200	Applications	Collection of applications

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Import

Create a new application from an import bundle

Method And Url

POST https://api.losant.com/applications/import

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.User, applications.*, or applications.import.

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 a multipart form data post containing the following:

Name	Required	Description	Default	Example
importBundle	N	The zip file containing the application to import and all of its resources		``
ownerId	N	The owner id of the new application, defaults to the id of the user making the request		ownerId=575ed6e87ae143cd83dc4aa8
ownerType	N	The type of the owner id. Accepted values are: user, organization	user	ownerType=user
includeDevices	N	If set, import devices from the import bundle		includeDevices=true
includeDataTableRows	N	If set, import data table rows from import bundle		includeDataTableRows=true
includeFiles	N	If set, import files from import bundle		includeFiles=true
email	N	Email address to notify the user when the job to import the application has completed or errored, defaults to the email address of the user making the request		email=email@example.com
options	N	Additional import options. See Applications Import Options for more details.		options={"importUrl":"https://storage.example.com/myZipFile.zip","include":["Flow","Device"]}

Curl Example

curl -H 'Content-Type: multipart/form-data' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    https://api.losant.com/applications/import

Successful Responses

Code	Type	Description
201	Application Creation By Template Result	Successfully created application
202	Job Enqueued API Result	If application was enqueued to be imported

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if application is not found
422	Validation Error	Error if too many validation errors occurred on other resources

Period Summaries

Returns application usage summaries over a selected date range

Method And Url

GET https://api.losant.com/applications/periodSummaries

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.Organization.read, all.User, all.User.read, applications.*, or applications.periodSummaries.

Request Query Parameters

Name	Required	Description	Default	Example
start	N	Start of range for resource count queries (ms since epoch)		start=0
end	N	End of range for resource count queries (ms since epoch)		end=1465790400000
asBytes	N	If the resulting payload counts should be returned as bytes	false	asBytes=true
includeNonBillable	N	If non-billable payloads should be included in the result	false	includeNonBillable=true
sortField	N	Field to sort the results by. Accepted values are: name, id, creationDate, ownerId, 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 * app
orgId	N	If not provided, return all applications. If provided but blank, only return applications belonging to the current user. If provided and an id, only return applications belonging to the given organization id.		orgId=575ecdf07ae143cd83dc4a9a
exclude	N	Comma-separated list of resources to exclude from summary		exclude=payloadCounts, deviceCounts, notebookMinuteCounts
include	N	Comma-separated list of summary fields to include in application summary		include=deviceCounts

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

Successful Responses

Code	Type	Description
200	Application Period Summaries	Collection of application period summaries

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Post

Create a new application

Method And Url

POST https://api.losant.com/applications

Authentication

A valid API access token is required to access this endpoint. The token must include at least one of the following scopes: all.Organization, all.User, applications.*, or applications.post.

Request Query Parameters

Name	Required	Description	Default	Example
summaryExclude	N	Comma-separated list of summary fields to exclude from application summary		summaryExclude=payloadCount
summaryInclude	N	Comma-separated list of summary fields to include in application summary		summaryInclude=payloadCount

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

{
  "name": "My New Application",
  "description": "Description of my new application"
}

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 Application","description":"Description of my new application"}' \
    https://api.losant.com/applications

Successful Responses

Code	Type	Description
201	Application	Successfully created application

Error Responses

Code	Type	Description
400	Error	Error if malformed request

Schemas

Application

Schema for a single Application

Application Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 19 keys
▶
id:{} 2 keys
▶
applicationId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
appliedTemplateIds:{} 3 keys
▶
ownerId:{} 2 keys
▶
ownerType:{} 2 keys
▶
organizationName:{} 3 keys
▶
organizationIconColor:{} 2 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
endpointSlug:{} 4 keys
▶
expUserTokenCutoff:{} 2 keys
▶
endpointDefaultCors:{} 1 key
▶
globals:{} 3 keys
▶
blobUrlTTL:{} 3 keys
▶
summary:{} 2 keys
▶
ftueTracking:{} 3 keys
▶
archiveConfig:{} 3 keys

Application Example

▶
root:{} 10 keys
id:"575ec8687ae143cd83dc4a97"
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
ownerId:"575ed70c7ae143cd83dc4aa9"
ownerType:"user"
name:"My Application"
description:"The is the best application description"
▶
summary:{} 6 keys
▶
archiveConfig:{} 3 keys

Application Creation By Template Result

Schema for creating an application by template result

Application Creation By Template Result Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys
▶
application:{} 4 keys
▶
validationErrors:{} 2 keys
additionalProperties:false

Application Creation By Template Result Example

▶
root:{} 1 key
▶
application:{} 10 keys

Application Post

Schema for the body of an Application creation request

Application Post Schema

▶
root:{} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 11 keys
▶
orgId:{} 2 keys
▶
applicationTemplateId:{} 2 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
appliedTemplateIds:{} 3 keys
▶
endpointSlug:{} 4 keys
▶
expUserTokenCutoff:{} 2 keys
▶
endpointDefaultCors:{} 1 key
▶
globals:{} 3 keys
▶
archiveConfig:{} 3 keys
▶
blobUrlTTL:{} 3 keys
additionalProperties:false
▶
required:[] 1 item

Application Post Example

▶
root:{} 2 keys
name:"My New Application"
description:"Description of my new application"

Applications

Schema for a collection of Applications

Applications Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 9 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

Applications Example

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

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"

Applications Import Options

Schema for additional application import options (new application)

Applications Import Options Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 4 keys
▶
importUrl:{} 3 keys
▶
callbackUrl:{} 3 keys
▶
include:{} 3 keys
▶
forceJob:{} 2 keys
additionalProperties:false

Applications Import Options Example

▶
root:{} 2 keys
importUrl:"https://storage.example.com/myZipFile.zip"
▶
include:[] 2 items

Job Enqueued API Result

Schema for the result of a job being queued

Job Enqueued API Result Schema

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

Job Enqueued API Result Example

▶
root:{} 3 keys
jobQueued:true
jobId:"clnHvJbyVkOWAZwYAwLP4"
success:true

Application Period Summaries

Schema for a collection of Application Period Summaries

Application Period Summaries Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 9 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

Application Period Summaries Example

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

Validation Error

Schema for validation errors returned by the API

Validation 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

Validation Error Example

▶
root:{} 3 keys
type:"Validation"
message:"Too many validation errors occurred."
▶
validationErrors:[] 1 item