Resource Job Actions

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

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

Cancel Execution

Marks a specific resource job execution for cancellation

Method And Url

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

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, resourceJob.*, or resourceJob.cancelExecution.

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
executionId	Y	The ID of the execution to cancel		executionId=632e18632f59592e773a4153

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 POST \
    https://api.losant.com/applications/APPLICATION_ID/resource-jobs/RESOURCE_JOB_ID/cancelExecution?executionId=632e18632f59592e773a4153

Successful Responses

Code	Type	Description
200	Success	If the execution was successfully marked for cancellation

Error Responses

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

Delete

Deletes a resource job

Method And Url

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

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, resourceJob.*, or resourceJob.delete.

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
includeWorkflows	N	If the workflows that trigger from this resource job should also be deleted.		includeWorkflows=true

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 DELETE \
    https://api.losant.com/applications/APPLICATION_ID/resource-jobs/RESOURCE_JOB_ID

Successful Responses

Code	Type	Description
200	Success	If resource job was successfully deleted

Error Responses

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

Execute

Queues the execution of a resource job

Method And Url

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

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, resourceJob.*, or resourceJob.execute.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
RESOURCE_JOB_ID	ID associated with the resource job	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 Execution Options schema. For example, the following would be a valid body for this request:

{
  "templateContext": "{ \"myData\": 123 }"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"templateContext":"{ \"myData\": 123 }"}' \
    https://api.losant.com/applications/APPLICATION_ID/resource-jobs/RESOURCE_JOB_ID/execute

Successful Responses

Code	Type	Description
200	Success With Execution ID	If the job was successfully queued

Error Responses

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

Get

Returns a resource job

Method And Url

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

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, resourceJob.*, or resourceJob.get.

Request Path Components

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

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

Successful Responses

Code	Type	Description
200	Resource Job	A single resource job

Error Responses

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

Logs

Retrieves information on resource job executions

Method And Url

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

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, resourceJob.*, or resourceJob.logs.

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
limit	N	Max log entries to return (ordered by time descending)	1	limit=10
since	N	Look for log entries since this time (ms since epoch)		since=1465790400000

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/RESOURCE_JOB_ID/logs

Successful Responses

Code	Type	Description
200	Resource Job Execution Logs	Resource job execution information

Error Responses

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

Patch

Update a resource job

Method And Url

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

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, resourceJob.*, or resourceJob.patch.

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	575ec8687ae143cd83dc4a97
RESOURCE_JOB_ID	ID associated with the resource job	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 Patch schema. For example, the following would be a valid body for this request:

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

Curl Example

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

Successful Responses

Code	Type	Description
201	Resource Job	Successfully updated resource job

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if resource job 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 Execution Logs

Schema for a set of Resource Job execution logs

Resource Job Execution Logs Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"array"
▶
items:{} 6 keys

Resource Job Execution Logs Example

▶
root:[] 1 item
▶
0:{} 14 keys

Resource Job Execution Options

Schema for a resource job execution configuration

Resource Job Execution Options Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
templateContext:{} 2 keys
▶
queryJson:{} 2 keys
▶
dataTableId:{} 1 key
additionalProperties:false

Resource Job Execution Options Example

▶
root:{} 1 key
templateContext:"{ "myData": 123 }"

Resource Job Patch

Schema for a resource job update

Resource Job Patch Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 12 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
dataTableId:{} 1 key
▶
queryJson:{} 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

Resource Job Patch Example

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

Success

Schema for reporting a successful operation

Success Schema

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

Success Example

▶
root:{} 1 key
success:true

Success With Execution ID

Schema for reporting a successful operation with a corresponding execution ID

Success With Execution ID Schema

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

Success With Execution ID Example

▶
root:{} 2 keys
success:true
executionId:"575ed78e7ae143cd83dc4aab"