Flow Actions#

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

Below are the various requests that can be performed against the Flow 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.Organization, all.User, 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.Organization, all.User, 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

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.read, all.Organization, all.Organization.read, all.User, 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.read, all.Organization, all.Organization.read, all.User, 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 device 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.read, all.Organization, all.Organization.read, all.User, 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

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.Organization, all.User, 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

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.Organization, all.User, 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.Organization, all.User, 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