Application Job Logs Actions

https://api.losant.com/applications/APPLICATION_ID/jobLogs

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

Get

Returns the job logs for an application

Method And Url

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

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, applicationJobLogs.*, or applicationJobLogs.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, status, resourceType, runQueuedAt, runStartedAt, runCompletedAt	runQueuedAt	sortField=status
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
query	N	Filter application job logs by a query. See Advanced Application Job Log Query for more details.		query={"name":"ApplicationExport","status":{"$in":["errored","failed","completed"]}}

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

Successful Responses

Code	Type	Description
200	Application Job Logs	Collection of application job logs

Error Responses

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

Schemas

Advanced Application Job Log Query

Schema for advanced application job logs queries

Advanced Application Job Log Query Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 11 keys
▶
$and:{} 3 keys
▶
$or:{} 3 keys
▶
$nor:{} 3 keys
▶
id:{} 1 key
▶
runQueuedAt:{} 1 key
▶
runStartedAt:{} 1 key
▶
runCompletedAt:{} 1 key
▶
status:{} 1 key
▶
name:{} 1 key
▶
resourceId:{} 1 key
▶
resourceType:{} 1 key

Advanced Application Job Log Query Example

▶
root:{} 2 keys
name:"ApplicationExport"
▶
status:{} 1 key

Application Job Logs

Schema for a collection of Application Job Logs

Application Job Logs 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
▶
query:{} 1 key
▶
perPage:{} 1 key
▶
page:{} 1 key
▶
sortField:{} 1 key
▶
sortDirection:{} 2 keys
▶
applicationId:{} 2 keys

Application Job Logs 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"