Skip to content

Latest commit

 

History

History
146 lines (107 loc) · 5.96 KB

flowVersions.md

File metadata and controls

146 lines (107 loc) · 5.96 KB
Raw

Flow Versions Actions

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

Contents

Delete

Delete flow versions

result = client.flow_versions.delete(
    applicationId=my_application_id,
    flowId=my_flow_id,
    options=my_options)

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

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
flowId string Y ID associated with the flow 575ed18f7ae143cd83dc4aa6
options Flow Versions Delete Post Y Object containing flow version deletion options Flow Versions Delete Post Example
losantdomain string N Domain scope of request (rarely needed) example.com

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

result = client.flow_versions.get(
    applicationId=my_application_id,
    flowId=my_flow_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, flowVersions.*, or flowVersions.get.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
flowId string Y ID associated with the flow 575ed18f7ae143cd83dc4aa6
sortField string N Field to sort the results by. Accepted values are: version, id, creationDate, lastUpdated version version
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: version version
filter string N Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. my*version
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 Version Query N Workflow filter JSON object which overrides the filterField and filter parameters. Advanced Workflow 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 flow was not found

Post

Create or replace a flow version for a flow

result = client.flow_versions.post(
    applicationId=my_application_id,
    flowId=my_flow_id,
    flowVersion=my_flow_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.Organization, all.User, flowVersions.*, or flowVersions.post.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
flowId string Y ID associated with the flow 575ed18f7ae143cd83dc4aa6
flowVersion Workflow Version Post Y New flow version information Workflow Version 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
allowReplacement string N Allow replacement of an existing flow version with same version name false true
losantdomain string N Domain scope of request (rarely needed) example.com

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