Flow Versions Actions

https://api.app.wnology.io/applications/APPLICATION_ID/flows/FLOW_ID/versions

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

Delete

Delete flow versions

Method And Url

POST https://api.app.wnology.io/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.app.wnology.io/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.app.wnology.io/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.app.wnology.io/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.app.wnology.io/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.app.wnology.io/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

Was this page helpful?

Still looking for help? You can also search the WEGnology Forums or submit your question there.