Workflow Versions Actions

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

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

Delete

Delete flow versions

Method And Url

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

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

Request Body

The body of the request should be serialized JSON that validates against the Flow Versions Delete Post schema. For example, the following would be a valid body for this request:

{
  "query": {
    "version": {
      "$ne": "versionToKeep"
    }
  },
  "email": "email@example.com"
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"query":{"version":{"$ne":"versionToKeep"}},"email":"email@example.com"}' \
    https://api.losant.com/applications/APPLICATION_ID/flows/FLOW_ID/versions/delete

Successful Responses

Code	Type	Description
200	Bulk Deletion Response	Object indicating number of flow versions deleted or failed
202	Job Enqueued API Result	If a job was enqueued for the flow versions to be deleted

Error Responses

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

Get

Returns the flow versions for a flow

Method And Url

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

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, flowVersions.*, or flowVersions.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
sortField	N	Field to sort the results by. Accepted values are: version, id, creationDate, lastUpdated	version	sortField=version
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: version		filterField=version
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		filter=my*version
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
query	N	Workflow filter JSON object which overrides the filterField and filter parameters. See Advanced Workflow Version Query for more details.		query={"version":"theVersion"}

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

Successful Responses

Code	Type	Description
200	Workflow Versions	Collection of flow versions

Error Responses

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

Post

Create or replace a flow version for a flow

Method And Url

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

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

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
allowReplacement	N	Allow replacement of an existing flow version with same version name	false	allowReplacement=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 Post schema. For example, the following would be a valid body for this request:

{
  "version": "v1.2.3",
  "notes": "Notes about my new workflow version",
  "enabled": false
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"version":"v1.2.3","notes":"Notes about my new workflow version","enabled":false}' \
    https://api.losant.com/applications/APPLICATION_ID/flows/FLOW_ID/versions

Successful Responses

Code	Type	Description
201	Workflow Version	Successfully created flow version

Error Responses

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

Schemas

Advanced Workflow Version Query

Schema for advanced workflow queries

Advanced Workflow Version Query Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 13 keys
▶
$and:{} 3 keys
▶
$or:{} 3 keys
▶
$nor:{} 3 keys
▶
name:{} 1 key
▶
id:{} 1 key
▶
creationDate:{} 1 key
▶
lastUpdated:{} 1 key
▶
flowClass:{} 1 key
▶
enabled:{} 1 key
▶
version:{} 1 key
▶
triggers:{} 1 key
▶
nodes:{} 1 key
▶
customNodeSupports:{} 1 key
additionalProperties:false

Advanced Workflow Version Query Example

▶
root:{} 1 key
version:"theVersion"

Bulk Deletion Response

Schema for the response to a bulk deletion

Bulk Deletion Response Schema

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

Bulk Deletion Response Example

▶
root:{} 1 key
removed:3

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"

Workflow Version

Schema for a single Workflow Version

Workflow Version Schema

▶
root:{} 2 keys
$schema:"http://json-schema.org/draft-07/schema#"
▶
oneOf:[] 2 items

Workflow Version Example

▶
root:{} 13 keys
id:"675ed18f7ae143cd83dc4bb7"
flowVersionId:"675ed18f7ae143cd83dc4bb7"
flowId:"575ed18f7ae143cd83dc4aa6"
applicationId:"575ec8687ae143cd83dc4a97"
creationDate:"2016-06-13T04:00:00.000Z"
lastUpdated:"2016-06-13T04:00:00.000Z"
description:"Description of my workflow version"
flowClass:"experience"
▶
versions:[] 1 item
enabled:true
triggers:[] 0 items
nodes:[] 0 items
globals:[] 0 items

Workflow Version Post

Schema for the body of a Workflow Version creation request

Workflow Version Post Schema

▶
root:{} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 8 keys
▶
version:{} 3 keys
▶
notes:{} 2 keys
▶
enabled:{} 1 key
▶
triggers:{} 2 keys
▶
nodes:{} 2 keys
▶
globals:{} 3 keys
▶
minimumAgentVersion:{} 2 keys
▶
customNodeConfig:{} 4 keys
additionalProperties:false
▶
required:[] 1 item

Workflow Version Post Example

▶
root:{} 3 keys
version:"v1.2.3"
notes:"Notes about my new workflow version"
enabled:false

Workflow Versions

Schema for a collection of Workflow Versions

Workflow Versions Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 11 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
▶
flowId:{} 2 keys

Workflow Versions Example

▶
root:{} 9 keys
▶
items:[] 1 item
count:1
totalCount:4
perPage:1
page:0
sortField:"version"
sortDirection:"asc"
applicationId:"575ec8687ae143cd83dc4a97"
flowId:"575ed18f7ae143cd83dc4aa6"

Flow Versions Delete Post

Schema for the body of a bulk flow versions delete request

Flow Versions Delete Post Schema

▶
root:{} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 3 keys
▶
email:{} 3 keys
▶
query:{} 5 keys
▶
callbackUrl:{} 3 keys
additionalProperties:false
▶
required:[] 1 item

Flow Versions Delete Post Example

▶
root:{} 2 keys
▶
query:{} 1 key
email:"email@example.com"

Job Enqueued API Result

Schema for the result of a job being queued

Job Enqueued API Result Schema

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

Job Enqueued API Result Example

▶
root:{} 3 keys
jobQueued:true
jobId:"clnHvJbyVkOWAZwYAwLP4"
success:true