Workflow Actions

https://api.losant.com/applications/APPLICATION_ID/flows/FLOW_ID

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

Clear Storage Entries

Clear all storage entries

Method And Url

DELETE https://api.losant.com/applications/APPLICATION_ID/flows/FLOW_ID/storage

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.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, flow.*, or flow.clearStorageEntries.

Request Path Components

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

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/flows/FLOW_ID/storage

Successful Responses

Code	Type	Description
200	Workflow Storage Entries	The current storage entries

Error Responses

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

Delete

Deletes a flow

Method And Url

DELETE https://api.losant.com/applications/APPLICATION_ID/flows/FLOW_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.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, flow.*, or flow.delete.

Request Path Components

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

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/flows/FLOW_ID

Successful Responses

Code	Type	Description
200	Success	If flow was successfully deleted

Error Responses

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

Errors

Get information about errors that occurred during runs of this workflow

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/flows/FLOW_ID/errors

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.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, flow.*, or flow.errors.

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
duration	N	Duration of time range in milliseconds	86400000	duration=86400000
end	N	End of time range in milliseconds since epoch	0	end=0
limit	N	Maximum number of errors to return	25	limit=25
sortDirection	N	Direction to sort the results by. Accepted values are: asc, desc	desc	sortDirection=desc
flowVersion	N	Flow version name or ID. When not included, will be errors for all versions. Pass develop for just the develop version.		flowVersion=develop
deviceId	N	For edge or embedded workflows, the Device ID for which to return workflow errors. When not included, will be errors for all device IDs.		deviceId=575ed18f7ae143cd83dc4bb6

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/flows/FLOW_ID/errors

Successful Responses

Code	Type	Description
200	Workflow Errors	Workflow error information

Error Responses

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

Get

Retrieves information on a flow

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/flows/FLOW_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.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, flow.*, or flow.get.

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
includeCustomNodes	N	If the result of the request should also include the details of any custom nodes referenced by the returned workflows	false	includeCustomNodes=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 GET \
    https://api.losant.com/applications/APPLICATION_ID/flows/FLOW_ID

Successful Responses

Code	Type	Description
200	Workflow	Flow information

Error Responses

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

Get Log Entries

Retrieve the recent log entries about runs of this workflow

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/flows/FLOW_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.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, flow.*, or flow.log.

Request Path Components

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

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/flows/FLOW_ID/logs

Successful Responses

Code	Type	Description
200	Workflow Log	Recent log entries

Error Responses

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

Get Storage Entries

Gets the current values in persistent storage

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/flows/FLOW_ID/storage

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.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, flow.*, or flow.getStorageEntries.

Request Path Components

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

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/flows/FLOW_ID/storage

Successful Responses

Code	Type	Description
200	Workflow Storage Entries	The current storage entries

Error Responses

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

Get Storage Entries Metadata

Gets metadata about storage for this flow

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/flows/FLOW_ID/storage-metadata

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.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, flow.*, or flow.getStorageEntriesMetadata.

Request Path Components

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

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/flows/FLOW_ID/storage-metadata

Successful Responses

Code	Type	Description
200	Get Workflow Storage Entries Metadata	The meta data for the current storage entries

Error Responses

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

Patch

Updates information about a flow

Method And Url

PATCH https://api.losant.com/applications/APPLICATION_ID/flows/FLOW_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.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, flow.*, or flow.patch.

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
includeCustomNodes	N	If the result of the request should also include the details of any custom nodes referenced by the returned workflows	false	includeCustomNodes=true
strictValidation	N	When true, perform stricter validation on node and trigger configuration	false	strictValidation=true

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

{
  "name": "My Updated Workflow",
  "description": "Description of my updated workflow",
  "enabled": false
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"name":"My Updated Workflow","description":"Description of my updated workflow","enabled":false}' \
    https://api.losant.com/applications/APPLICATION_ID/flows/FLOW_ID

Successful Responses

Code	Type	Description
200	Workflow	Updated flow information

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if flow is not found

Press Virtual Button

Presses the specified virtual button on the flow

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/flows/FLOW_ID/virtualButton

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.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, flow.*, or flow.pressVirtualButton.

Request Path Components

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

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

{
  "key": "575ed18f7ae143cd83dc4aa6-SJaEw_dV",
  "payload": {
    "some": "data"
  }
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"key":"575ed18f7ae143cd83dc4aa6-SJaEw_dV","payload":{"some":"data"}}' \
    https://api.losant.com/applications/APPLICATION_ID/flows/FLOW_ID/virtualButton

Successful Responses

Code	Type	Description
200	Success	Virtual button was pressed

Error Responses

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

Set Storage Entry

Sets a storage value

Method And Url

PATCH https://api.losant.com/applications/APPLICATION_ID/flows/FLOW_ID/storage

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.bounded, all.Organization, all.Organization.bounded, all.User, all.User.bounded, flow.*, or flow.setStorageEntry.

Request Path Components

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

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

{
  "key": "myStorageKey",
  "value": 12
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X PATCH \
    -d '{"key":"myStorageKey","value":12}' \
    https://api.losant.com/applications/APPLICATION_ID/flows/FLOW_ID/storage

Successful Responses

Code	Type	Description
200	Success	Value was successfully stored

Error Responses

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

Stats

Get statistics about workflow runs for this workflow

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/flows/FLOW_ID/stats

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.bounded, all.Application.read, all.Organization, all.Organization.bounded, all.Organization.read, all.User, all.User.bounded, all.User.read, flow.*, or flow.stats.

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
duration	N	Duration of time range in milliseconds	86400000	duration=86400000
end	N	End of time range in milliseconds since epoch	0	end=0
resolution	N	Resolution in milliseconds	3600000	resolution=3600000
flowVersion	N	Flow version name or ID. When not included, will be aggregate for all versions. Pass develop for just the develop version.		flowVersion=develop
deviceId	N	For edge or embedded workflows, the device ID to return workflow stats for. When not included, will be aggregate for all device IDs.		deviceId=575ed18f7ae143cd83dc4bb6

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/flows/FLOW_ID/stats

Successful Responses

Code	Type	Description
200	Workflow Statistics	Statistics for workflow runs

Error Responses

Code	Type	Description
400	Error	Error if malformed request
404	Error	Error if flow 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:{} 3 keys
▶
type:{} 1 key
▶
message:{} 1 key
▶
validationErrors:{} 2 keys

Error Example

▶
(root){} 2 keys
type:"NotFound"
message:"Application was not found"

Workflow

Schema for a single Workflow

Workflow Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 29 keys
▶
id:{} 2 keys
▶
flowId:{} 2 keys
▶
applicationId:{} 2 keys
▶
creationDate:{} 2 keys
▶
lastUpdated:{} 2 keys
▶
createdById:{} 2 keys
▶
createdByType:{} 2 keys
▶
lastUpdatedById:{} 2 keys
▶
lastUpdatedByType:{} 2 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
shortDescription:{} 2 keys
▶
iconData:{} 3 keys
▶
docsUrl:{} 2 keys
▶
category:{} 2 keys
▶
enabled:{} 1 key
▶
defaultVersionId:{} 2 keys
▶
minimumAgentVersion:{} 2 keys
▶
flowClass:{} 2 keys
▶
triggers:{} 2 keys
▶
nodes:{} 2 keys
▶
customNodeConfig:{} 4 keys
▶
customNodeSupports:{} 3 keys
▶
customNodeUseCount:{} 1 key
▶
globals:{} 3 keys
▶
deletedInDevelop:{} 1 key
▶
stats:{} 2 keys
▶
_customNodes:{} 2 keys
▶
_customNodeVersions:{} 2 keys

Workflow Example

▶
(root){} 12 keys
id:"575ed18f7ae143cd83dc4aa6"
flowId:"575ed18f7ae143cd83dc4aa6"
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
name:"My Workflow"
description:"Description of my empty workflow"
enabled:true
triggers:[] 0 items
nodes:[] 0 items
globals:[] 0 items
▶
stats:{} 2 keys

Workflow Errors

Workflow run error information

Workflow Errors Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 8 keys
▶
flowVersion:{} 3 keys
▶
flowVersionId:{} 2 keys
▶
deviceId:{} 2 keys
▶
start:{} 2 keys
▶
end:{} 2 keys
▶
limit:{} 1 key
▶
sortDirection:{} 2 keys
▶
errors:{} 2 keys

Workflow Errors Example

▶
(root){} 5 keys
start:"2016-06-03T00:00:00.000Z"
end:"2016-06-04T00:00:00.000Z"
limit:25
sortDirection:"desc"
▶
errors:[] 1 item

Workflow Log

Log of aggregated workflow run information

Workflow Log Schema

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

Workflow Log Example

▶
(root)[] 2 items
▶
0:{} 7 keys
▶
1:{} 7 keys

Workflow Patch

Schema for the body of a Workflow modification request

Workflow Patch Schema

▶
(root){} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 13 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
shortDescription:{} 2 keys
▶
iconData:{} 1 key
▶
docsUrl:{} 2 keys
▶
category:{} 2 keys
▶
enabled:{} 1 key
▶
defaultVersionId:{} 1 key
▶
triggers:{} 2 keys
▶
nodes:{} 2 keys
▶
globals:{} 3 keys
▶
minimumAgentVersion:{} 2 keys
▶
customNodeConfig:{} 4 keys
additionalProperties:false

Workflow Patch Example

▶
(root){} 3 keys
name:"My Updated Workflow"
description:"Description of my updated workflow"
enabled:false

Workflow Statistics

Statistics about the runs for a given workflow

Workflow Statistics Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 7 keys
▶
flowVersion:{} 3 keys
▶
flowVersionId:{} 2 keys
▶
deviceId:{} 2 keys
▶
start:{} 2 keys
▶
end:{} 2 keys
▶
resolution:{} 1 key
▶
metrics:{} 2 keys

Workflow Statistics Example

▶
(root){} 4 keys
start:"2016-06-03T00:00:00.000Z"
end:"2016-06-04T00:00:00.000Z"
resolution:86400000
▶
metrics:[] 1 item

Workflow Storage Entries

Set of persistent workflow storage values

Workflow Storage Entries Schema

▶
(root){} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
patternProperties:{} 1 key

Workflow Storage Entries Example

▶
(root){} 2 keys
myStorageKey:"hello"
▶
other key:[] 3 items

Workflow Storage Entry

Schema for the body of a request to set a Workflow storage entry

Workflow Storage Entry Schema

▶
(root){} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys
▶
key:{} 3 keys
value:{} 0 keys
additionalProperties:false
▶
required:[] 1 item

Workflow Storage Entry Example

▶
(root){} 2 keys
key:"myStorageKey"
value:12

Get Workflow Storage Entries Metadata

Schema for the result of a get storage metadata request

Get Workflow Storage Entries Metadata Schema

▶
(root){} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys
▶
memoryUsage:{} 1 key
▶
keyCount:{} 1 key
additionalProperties:false

Get Workflow Storage Entries Metadata Example

▶
(root){} 2 keys
memoryUsage:610
keyCount:2

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

Virtual Button Press

Schema for the body of a request to press a Workflow virtual button

Virtual Button Press Schema

▶
(root){} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 6 keys
▶
key:{} 1 key
payload:{} 0 keys
meta:{} 0 keys
▶
flowVersion:{} 3 keys
▶
deviceId:{} 2 keys
▶
deploymentId:{} 2 keys
▶
required:[] 1 item
additionalProperties:false

Virtual Button Press Example

▶
(root){} 2 keys
key:"575ed18f7ae143cd83dc4aa6-SJaEw_dV"
▶
payload:{} 1 key