Synatic Flows API
A Flow defines a specific end to end process that can be executed at any time
Operations 98
PUT
/v1/organizations(?:/([^/]+?))/flows/{flowId}/control-step/swap/{swapOption}
Swaps a control step in the flow
#
PUT
/v1/organizations(?:/([^/]+?))/flows/{flowId}/control-step/copy/add
Adds a copied control step to the flow
#
DELETE
/v1/organizations(?:/([^/]+?))/flows/{flowId}/map/steps/{mapStepId}
Deletes a step in the map
#
PUT
/v1/organizations(?:/([^/]+?))/flows/{flowId}/map/returns/{endStepId}
Updates the returns in a subflow
#
PUT
/v1/organizations(?:/([^/]+?))/flows/{flowId}/map/{subFlowStepId}/parentField/{field}
Updates the returns in a subflow
#
PUT
/v1/organizations(?:/([^/]+?))/flows/{flowId}/map/{startStepId}/properties
Updates the subflow properties
#
GET
/v1/organizations(?:/([^/]+?))/flows/{flowId}/runs/stats/{targetDate}
Gets the Run stats for a Flow for a specific target date
#
GET
/v1/organizations(?:/([^/]+?))/flows/{flowId}/checkStepsAllowed
Checks flow for blacklisted steps
#
GET
/v1/organizations(?:/([^/]+?))/flows/{flowId}/execute
Executes a synchronous Flow and returns the results
#
POST
/v1/organizations(?:/([^/]+?))/flows/{flowId}/test/{toMapStepId}
Runs a flow without source and destination as a test
#
POST
/v1/organizations(?:/([^/]+?))/flows/{flowId}/purge
Purges flow items like runes, records and events
#
DELETE
/v1/organizations(?:/([^/]+?))/flows/{flowId}/records
Deletes all the Run Records associated with this Flow
#
POST
/v1/organizations(?:/([^/]+?))/flows/{flowId}/records/clean
Cleans all the Run Records associated with this Flow
#
GET
/v1/organizations(?:/([^/]+?))/flows/{flowId}/versions/{versionId}
Returns a version of a Flow
#
POST
/v1/organizations(?:/([^/]+?))/flows/{flowId}/versions/{versionId}/checkout
Checks out a version of a FLow
#
POST
/v1/organizations(?:/([^/]+?))/flows/{flowId}/versions/{versionId}/deploy
Deploys a version of a flow that will run by default when a flow is run
#
POST
/v1/organizations(?:/([^/]+?))/flows/{flowId}/discard-changes
Discard changes on a flow and checks out the last deployed version
#
GET
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/usedby
Queries the flows that use a certain items
#
GET
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/common-steps
Returns an array of commonly used steps
#
GET
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/watchFiles
Gets the flows watch files
#
POST
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/runs
Executes a Flow and creates a run
#
GET
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/validations
Retrieves validations for the flow
#
POST
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/map/insert
Inserts a step into the flow map
#
PUT
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/control-step/swap/{swapOption}
Swaps a control step in the flow
#
PUT
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/control-step/copy
Gets the copied control step
#
PUT
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/control-step/copy/add
Adds a copied control step to the flow
#
PUT
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/map/steps/{mapStepId}
Updates a step in the map
#
DELETE
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/map/steps/{mapStepId}
Deletes a step in the map
#
PUT
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/map/returns/{endStepId}
Updates the returns in a subflow
#
PUT
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/map/{subFlowStepId}/parentField/{field}
Updates the returns in a subflow
#
PUT
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/map/{startStepId}/properties
Updates the subflow properties
#
POST
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/flowTriggers
Saves the Flow Triggers
#
GET
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/runs/stats
Gets the Run stats for a Flow
#
GET
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/runs/stats/{targetDate}
Gets the Run stats for a Flow for a specific target date
#
GET
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/runs/{runId}
Retrieves a Run for a flow
#
GET
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/checkStepsAllowed
Checks flow for blacklisted steps
#
POST
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/execute
Executes a Flow and creates a run
#
GET
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/execute
Executes a synchronous Flow and returns the results
#
POST
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/test/{toMapStepId}
Runs a flow without source and destination as a test
#
POST
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/purge
Purges flow items like runes, records and events
#
PUT
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/resetSequence
Resets a Flows sequence number
#
DELETE
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/records
Deletes all the Run Records associated with this Flow
#
DELETE
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/steps/{stepId}
Deletes a specific step
#
POST
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/records/clean
Cleans all the Run Records associated with this Flow
#
POST
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/versions
Commits a new version of a Flow
#
GET
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/versions/{versionId}
Returns a version of a Flow
#
POST
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/versions/{versionId}/checkout
Checks out a version of a FLow
#
POST
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/versions/{versionId}/deploy
Deploys a version of a flow that will run by default when a flow is run
#
POST
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}/discard-changes
Discard changes on a flow and checks out the last deployed version
#
PATCH
/v1/agencyfuse/organizations(?:/([^/]+?))/flows/{flowId}
Patches a Flow given the JSON Patch
#