Workflows Actions

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

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

Get

Returns the flows for an application

Method And Url

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

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

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
sortField	N	Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated	name	sortField=name
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: name		filterField=name
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		filter=my*flow
flowClass	N	Filter the workflows by the given flow class. Accepted values are: edge, embedded, cloud, customNode, experience	cloud	flowClass=cloud
triggerFilter	N	Array of triggers to filter by - always filters against default flow version. See Workflow Trigger Filter for more details.		triggerFilter[0][type]=webhook&triggerFilter[0][key]=575ed78e7ae143cd83dc4aab
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, filter, triggerFilter, and flowClass parameters. See Advanced Workflow Query for more details.		query={"$or":[{"name":{"$ne":"flowie"}},{"enabled":false}]}
allVersions	N	If the request should also return flows with matching versions. Only applicable for requests with an advanced query.	false	allVersions=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

Successful Responses

Code	Type	Description
200	Workflows	Collection of flows

Error Responses

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

Get by Version

Returns the flows by version for an application

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/flows/version

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

Request Path Components

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

Request Query Parameters

Name	Required	Description	Default	Example
sortField	N	Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated	name	sortField=name
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: name		filterField=name
filter	N	Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.		filter=my*flow
flowClass	N	Filter the workflows by the given flow class. Accepted values are: edge, embedded, cloud, customNode, experience	cloud	flowClass=cloud
version	Y	Return the workflow versions for the given version.		version=myVersion
triggerFilter	N	Array of triggers to filter by - always filters against default flow version. See Workflow Trigger Filter for more details.		triggerFilter[0][type]=webhook&triggerFilter[0][key]=575ed78e7ae143cd83dc4aab
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, filter, triggerFilter, and flowClass parameters. See Advanced Workflow By Version Query for more details.		query={"flowId":"000000000000000000000000"}

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/version?version=myVersion

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 application was not found

Import

Import a set of flows and flow versions

Method And Url

POST https://api.losant.com/applications/APPLICATION_ID/flows/import

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

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	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 Workflows Import Post schema. For example, the following would be a valid body for this request:

{
  "flows": [
    {
      "name": "My New Workflow",
      "description": "Description of my new workflow"
    }
  ],
  "flowVersions": []
}

Curl Example

curl -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer YOUR_API_ACCESS_TOKEN' \
    -X POST \
    -d '{"flows":[{"name":"My New Workflow","description":"Description of my new workflow"}],"flowVersions":[]}' \
    https://api.losant.com/applications/APPLICATION_ID/flows/import

Successful Responses

Code	Type	Description
201	Workflow Import Result	Successfully imported workflows

Error Responses

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

Palette

Gets additional nodes that should be available in the palette

Method And Url

GET https://api.losant.com/applications/APPLICATION_ID/flows/palette

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

Request Path Components

Path Component	Description	Example
APPLICATION_ID	ID associated with the application	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/flows/palette

Successful Responses

Code	Type	Description
200	Palette Response	The additional nodes available in the palette

Error Responses

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

Post

Create a new flow for an application

Method And Url

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

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

Request Path Components

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

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

{
  "name": "My New Workflow",
  "description": "Description of my new workflow"
}

Curl Example

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

Successful Responses

Code	Type	Description
201	Workflow	Successfully created flow

Error Responses

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

Schemas

Advanced Workflow By Version Query

Schema for advanced workflow queries

Advanced Workflow By Version Query Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 10 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
▶
flowId:{} 1 key
additionalProperties:false

Advanced Workflow By Version Query Example

▶
root:{} 1 key
flowId:"000000000000000000000000"

Advanced Workflow Query

Schema for advanced workflow queries

Advanced Workflow 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
▶
defaultVersion:{} 1 key
▶
triggers:{} 1 key
▶
nodes:{} 1 key
▶
customNodeSupports:{} 1 key
additionalProperties:false

Advanced Workflow Query Example

▶
root:{} 1 key
▶
$or:[] 2 items

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

Schema for a single Workflow

Workflow Schema

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

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 Post

Schema for the body of a Workflow creation request

Workflow Post Schema

▶
root:{} 5 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 14 keys
▶
name:{} 3 keys
▶
description:{} 2 keys
▶
shortDescription:{} 2 keys
▶
iconData:{} 1 key
▶
docsUrl:{} 2 keys
▶
category:{} 2 keys
▶
enabled:{} 1 key
▶
triggers:{} 2 keys
▶
nodes:{} 2 keys
▶
globals:{} 3 keys
▶
flowClass:{} 2 keys
▶
minimumAgentVersion:{} 2 keys
▶
customNodeConfig:{} 4 keys
▶
customNodeSupports:{} 3 keys
additionalProperties:false
▶
required:[] 1 item

Workflow Post Example

▶
root:{} 2 keys
name:"My New Workflow"
description:"Description of my new workflow"

Workflow Trigger Filter

Array of triggers for filtering workflows. Trigger keys and trigger types are optional.

Workflow Trigger Filter Schema

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

Workflow Trigger Filter Example

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

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"

Workflows

Schema for a collection of Workflows

Workflows 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
▶
flowClass:{} 2 keys

Workflows Example

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

Workflows Import Post

Schema for the body of a workflow import request

Workflows Import Post Schema

▶
root:{} 4 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 2 keys
▶
flows:{} 3 keys
▶
flowVersions:{} 3 keys
additionalProperties:false

Workflows Import Post Example

▶
root:{} 2 keys
▶
flows:[] 1 item
flowVersions:[] 0 items

Workflow Import Result

Schema for the result of a workflow import request

Workflow Import Result Schema

▶
root:{} 3 keys
$schema:"http://json-schema.org/draft-07/schema#"
type:"object"
▶
properties:{} 4 keys
▶
flows:{} 3 keys
▶
flowVersions:{} 3 keys
▶
importedFlowIdMap:{} 2 keys
▶
importedVersionIdMap:{} 2 keys

Workflow Import Result Example

▶
root:{} 4 keys
▶
flows:[] 1 item
flowVersions:[] 0 items
▶
importedFlowIdMap:{} 1 key
importedVersionIdMap:{} 0 keys

Palette Response

Schema for the set of additional nodes for the workflow palette

Palette Response Schema

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

Palette Response Example

▶
root:{} 2 keys
applicationId:"61f407b56dd9921e15f2b02b"
▶
customNodes:[] 2 items