Skip to content

flows.md

Latest commit

 

History

History
229 lines (166 loc) · 9.82 KB

flows.md

File metadata and controls

229 lines (166 loc) · 9.82 KB

Flows Actions

Details on the various actions that can be performed on the Flows resource, including the expected parameters and the potential responses.

Contents

Get

Returns the flows for an application

result = client.flows.get(applicationId=my_application_id)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. 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.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
sortField string N Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated name name
sortDirection string N Direction to sort the results by. Accepted values are: asc, desc asc asc
page string N Which page of results to return 0 0
perPage string N How many items to return per page 100 10
filterField string N Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name name
filter string N Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. my*flow
flowClass string N Filter the workflows by the given flow class. Accepted values are: edge, embedded, cloud, customNode, experience cloud cloud
triggerFilter Workflow Trigger Filter N Array of triggers to filter by - always filters against default flow version. Workflow Trigger Filter Example
includeCustomNodes string N If the result of the request should also include the details of any custom nodes referenced by the returned workflows false true
query Advanced Workflow Query N Workflow filter JSON object which overrides the filterField, filter, triggerFilter, and flowClass parameters. Advanced Workflow Query Example
allVersions string N If the request should also return flows with matching versions. Only applicable for requests with an advanced query. false true
losantdomain string N Domain scope of request (rarely needed) example.com

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

result = client.flows.get_by_version(
    applicationId=my_application_id,
    version=my_version)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. 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.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
sortField string N Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated name name
sortDirection string N Direction to sort the results by. Accepted values are: asc, desc asc asc
page string N Which page of results to return 0 0
perPage string N How many items to return per page 100 10
filterField string N Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name name
filter string N Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. my*flow
flowClass string N Filter the workflows by the given flow class. Accepted values are: edge, embedded, cloud, customNode, experience cloud cloud
version string Y Return the workflow versions for the given version. myVersion
triggerFilter Workflow Trigger Filter N Array of triggers to filter by - always filters against default flow version. Workflow Trigger Filter Example
includeCustomNodes string N If the result of the request should also include the details of any custom nodes referenced by the returned workflows false true
query Advanced Workflow By Version Query N Workflow filter JSON object which overrides the filterField, filter, triggerFilter, and flowClass parameters. Advanced Workflow By Version Query Example
losantdomain string N Domain scope of request (rarely needed) example.com

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

result = client.flows.api_import(
    applicationId=my_application_id,
    importData=my_import_data)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, flows.*, or flows.import.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
importData Workflows Import Post Y New flow and flow version information Workflows Import Post Example
losantdomain string N Domain scope of request (rarely needed) example.com

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

result = client.flows.palette(applicationId=my_application_id)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. 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.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
losantdomain string N Domain scope of request (rarely needed) example.com

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

result = client.flows.post(
    applicationId=my_application_id,
    flow=my_flow)

print(result)

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, flows.*, or flows.post.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
flow Workflow Post Y New flow information Workflow Post Example
includeCustomNodes string N If the result of the request should also include the details of any custom nodes referenced by the returned workflows false true
losantdomain string N Domain scope of request (rarely needed) example.com

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