Resource Jobs Actions

https://api.losant.com/applications/APPLICATION_ID/resource-jobs

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

Get

Returns the resource jobs for an application

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/resource-jobs

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, resourceJobs.*, or resourceJobs.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, lastExecutionRequested, resourceType	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, resourceType		filterField=device
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		filter=my*job

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/resource-jobs

Successful Responses

Code	Type	Description
200	Resource Jobs	Collection of resource jobs

Error Responses

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

Post

Create a new resource job for an application

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/resource-jobs

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

Request Path Components

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

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

{
  "name": "Example Resource Job",
  "resourceType": "device",
  "queryJson": "{ \"name\": \"my device\"}"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"name":"Example Resource Job","resourceType":"device","queryJson":"{ \"name\": \"my device\"}"}' \
    https://api.losant.com/applications/APPLICATION_ID/resource-jobs

Successful Responses

Code	Type	Description
201	Resource Job	Successfully created resource job

Error Responses

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

Schemas

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"

Resource Job

Schema for a single resource job

Resource Job Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 19 keys
▶
id:{} 2 keys
▶
resourceJobId:{} 2 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
applicationId:{} 2 keys
▶
dataTableId:{} 1 key
▶
queryJson:{} 2 keys
▶
resourceType:{} 2 keys
▶
maxIterationConcurrency:{} 2 keys
▶
iterationDelay:{} 3 keys
▶
iterationTimeout:{} 3 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
lastExecutionRequested:{} 2 keys
▶
defaultContext:{} 2 keys
▶
retryOnTimeout:{} 1 key
▶
retryOnFailure:{} 1 key
▶
maxIterationRetries:{} 3 keys
▶
retryDelay:{} 3 keys
additionalProperties:false

Resource Job Example

▶
root:{} 11 keys
name:"Example Resource Job"
iterationDelay:60
iterationTimeout:60000
defaultContext:"{}"
applicationId:"6328c6c026517badf9142116"
maxIterationConcurrency:1
creationDate:"2022-09-19T19:45:04.453Z"
lastUpdated:"2022-09-19T19:45:04.453Z"
resourceJobId:"6328c6c026517badf914211a"
resourceType:"device"
queryJson:"{ "name": "my device"}"

Resource Job Post

Schema for a resource job creation

Resource Job Post Schema

▶
root:{} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 13 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
dataTableId:{} 1 key
▶
queryJson:{} 2 keys
▶
resourceType:{} 2 keys
▶
maxIterationConcurrency:{} 2 keys
▶
iterationDelay:{} 3 keys
▶
iterationTimeout:{} 3 keys
▶
defaultContext:{} 2 keys
▶
retryOnTimeout:{} 1 key
▶
retryOnFailure:{} 1 key
▶
maxIterationRetries:{} 3 keys
▶
retryDelay:{} 3 keys
additionalProperties:false
▶
required:[] 2 items

Resource Job Post Example

▶
root:{} 3 keys
name:"Example Resource Job"
resourceType:"device"
queryJson:"{ "name": "my device"}"

Resource Jobs

Schema for a collection of Resource Jobs

Resource Jobs 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

Resource Jobs Example

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