Workflow Version Actions
https://api.losant.com/applications/APPLICATION_ID
/flows/FLOW_ID
/versions/FLOW_VERSION_ID
Below are the various requests that can be performed against the Workflow Version resource, as well as the expected parameters and the potential responses.
Delete
Deletes a flow version
Method And Url
DELETE https://api.losant.com/applications/APPLICATION_ID
/flows/FLOW_ID
/versions/FLOW_VERSION_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
, flowVersion.*
, or flowVersion.delete
.
Request Path Components
Path Component | Description | Example |
---|---|---|
APPLICATION_ID | ID associated with the application | 575ec8687ae143cd83dc4a97 |
FLOW_ID | ID associated with the flow | 575ed18f7ae143cd83dc4aa6 |
FLOW_VERSION_ID | Version ID or version name associated with the flow version | 675ed18f7ae143cd83dc4bb7 |
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/versions/FLOW_VERSION_ID
Successful Responses
Code | Type | Description |
---|---|---|
200 | Success | If flow version was successfully deleted |
Error Responses
Code | Type | Description |
---|---|---|
400 | Error | Error if malformed request |
404 | Error | Error if flow version was not found |
Errors
Get information about errors that occurred during runs of this workflow version
Method And Url
GET https://api.losant.com/applications/APPLICATION_ID
/flows/FLOW_ID
/versions/FLOW_VERSION_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.read
, all.Organization
, all.Organization.read
, all.User
, all.User.read
, flowVersion.*
, or flowVersion.errors
.
Request Path Components
Path Component | Description | Example |
---|---|---|
APPLICATION_ID | ID associated with the application | 575ec8687ae143cd83dc4a97 |
FLOW_ID | ID associated with the flow | 575ed18f7ae143cd83dc4aa6 |
FLOW_VERSION_ID | Version ID or version name associated with the flow version | 675ed18f7ae143cd83dc4bb7 |
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 |
deviceId | N | For edge workflows, the Device ID to return workflow errors for. 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/versions/FLOW_VERSION_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 version was not found |
Get
Retrieves information on a flow version
Method And Url
GET https://api.losant.com/applications/APPLICATION_ID
/flows/FLOW_ID
/versions/FLOW_VERSION_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
, flowVersion.*
, or flowVersion.get
.
Request Path Components
Path Component | Description | Example |
---|---|---|
APPLICATION_ID | ID associated with the application | 575ec8687ae143cd83dc4a97 |
FLOW_ID | ID associated with the flow | 575ed18f7ae143cd83dc4aa6 |
FLOW_VERSION_ID | Version ID or version name associated with the flow version | 675ed18f7ae143cd83dc4bb7 |
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/versions/FLOW_VERSION_ID
Successful Responses
Code | Type | Description |
---|---|---|
200 | Workflow Version | Flow version information |
Error Responses
Code | Type | Description |
---|---|---|
400 | Error | Error if malformed request |
404 | Error | Error if flow version was not found |
Get Log Entries
Retrieve the recent log entries about runs of this workflow version
Method And Url
GET https://api.losant.com/applications/APPLICATION_ID
/flows/FLOW_ID
/versions/FLOW_VERSION_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
, flowVersion.*
, or flowVersion.log
.
Request Path Components
Path Component | Description | Example |
---|---|---|
APPLICATION_ID | ID associated with the application | 575ec8687ae143cd83dc4a97 |
FLOW_ID | ID associated with the flow | 575ed18f7ae143cd83dc4aa6 |
FLOW_VERSION_ID | Version ID or version name associated with the flow version | 675ed18f7ae143cd83dc4bb7 |
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/versions/FLOW_VERSION_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 version was not found |
Patch
Updates information about a flow version
Method And Url
PATCH https://api.losant.com/applications/APPLICATION_ID
/flows/FLOW_ID
/versions/FLOW_VERSION_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
, flowVersion.*
, or flowVersion.patch
.
Request Path Components
Path Component | Description | Example |
---|---|---|
APPLICATION_ID | ID associated with the application | 575ec8687ae143cd83dc4a97 |
FLOW_ID | ID associated with the flow | 575ed18f7ae143cd83dc4aa6 |
FLOW_VERSION_ID | Version ID or version name associated with the flow version | 675ed18f7ae143cd83dc4bb7 |
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 Version Patch schema. For example, the following would be a valid body for this request:
{
"notes": "Updated workflow version notes",
"enabled": false
}
Curl Example
curl -H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
-X PATCH \
-d '{"notes":"Updated workflow version notes","enabled":false}' \
https://api.losant.com/applications/APPLICATION_ID/flows/FLOW_ID/versions/FLOW_VERSION_ID
Successful Responses
Code | Type | Description |
---|---|---|
200 | Workflow Version | Updated flow version information |
Error Responses
Code | Type | Description |
---|---|---|
400 | Error | Error if malformed request |
404 | Error | Error if flow version was not found |
Stats
Get statistics about workflow runs for this workflow version
Method And Url
GET https://api.losant.com/applications/APPLICATION_ID
/flows/FLOW_ID
/versions/FLOW_VERSION_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.read
, all.Organization
, all.Organization.read
, all.User
, all.User.read
, flowVersion.*
, or flowVersion.stats
.
Request Path Components
Path Component | Description | Example |
---|---|---|
APPLICATION_ID | ID associated with the application | 575ec8687ae143cd83dc4a97 |
FLOW_ID | ID associated with the flow | 575ed18f7ae143cd83dc4aa6 |
FLOW_VERSION_ID | Version ID or version name associated with the flow version | 675ed18f7ae143cd83dc4bb7 |
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 |
deviceId | N | For edge 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/versions/FLOW_VERSION_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 version was not found |
Schemas
Error
Schema for errors returned by the API
Error Schema
- ▶{} 3 keys
- "http://json-schema.org/draft-07/schema#"
- "object"
- ▶{} 2 keys
- ▶{} 1 key
- ▶{} 1 key
Error Example
- ▶{} 2 keys
- "NotFound"
- "Application was not found"
Workflow Errors
Workflow run error information
Workflow Errors Schema
- ▶{} 3 keys
- "http://json-schema.org/draft-07/schema#"
- "object"
- ▶{} 8 keys
- ▶{} 3 keys
- ▶{} 2 keys
- ▶{} 2 keys
- ▶{} 2 keys
- ▶{} 2 keys
- ▶{} 1 key
- ▶{} 2 keys
- ▶{} 2 keys
Workflow Errors Example
- ▶{} 5 keys
- "2016-06-03T00:00:00.000Z"
- "2016-06-04T00:00:00.000Z"
- 25
- "desc"
- ▶[] 1 item
Workflow Log
Log of aggregated workflow run information
Workflow Log Schema
- ▶{} 3 keys
- "http://json-schema.org/draft-07/schema#"
- "array"
- ▶{} 2 keys
Workflow Log Example
- ▶[] 2 items
- ▶{} 7 keys
- ▶{} 7 keys
Workflow Statistics
Statistics about the runs for a given workflow
Workflow Statistics Schema
- ▶{} 3 keys
- "http://json-schema.org/draft-07/schema#"
- "object"
- ▶{} 7 keys
- ▶{} 3 keys
- ▶{} 2 keys
- ▶{} 2 keys
- ▶{} 2 keys
- ▶{} 2 keys
- ▶{} 1 key
- ▶{} 2 keys
Workflow Statistics Example
- ▶{} 4 keys
- "2016-06-03T00:00:00.000Z"
- "2016-06-04T00:00:00.000Z"
- 86400000
- ▶[] 1 item
Workflow Version
Schema for a single Workflow Version
Workflow Version Schema
- ▶{} 2 keys
- "http://json-schema.org/draft-07/schema#"
- ▶[] 2 items
Workflow Version Example
- ▶{} 13 keys
- "675ed18f7ae143cd83dc4bb7"
- "675ed18f7ae143cd83dc4bb7"
- "575ed18f7ae143cd83dc4aa6"
- "575ec8687ae143cd83dc4a97"
- "2016-06-13T04:00:00.000Z"
- "2016-06-13T04:00:00.000Z"
- "Description of my workflow version"
- "experience"
- ▶[] 1 item
- true
- [] 0 items
- [] 0 items
- [] 0 items
Workflow Version Patch
Schema for the body of a Workflow Version modification request
Workflow Version Patch Schema
- ▶{} 4 keys
- "http://json-schema.org/draft-07/schema#"
- "object"
- ▶{} 2 keys
- ▶{} 2 keys
- ▶{} 1 key
- false
Workflow Version Patch Example
- ▶{} 2 keys
- "Updated workflow version notes"
- false
Success
Schema for reporting a successful operation
Success Schema
- ▶{} 3 keys
- "http://json-schema.org/draft-07/schema#"
- "object"
- ▶{} 1 key
- ▶{} 2 keys
Success Example
- ▶{} 1 key
- true
Was this page helpful?
Still looking for help? You can also search the Losant Forums or submit your question there.