Skip to navigation
API ReferenceIntegrations & AutomationFlow Configurations

Check a Flow without saving it

Runs the checks that a publish runs and saves nothing. The problems are in the response. A body that names exactly one existing Flow is checked as that Flow’s next draft. A name that breaks the naming rules is refused with 400, and a name that several Flows hold with 409, rather than listed as a problem.

Permissions for nested calls. This endpoint calls other Fynapse services with your token. Depending on the request, the token also needs:

  • data_structure_read or bulk_configurator_read, when the Flow uses an Entity.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

This endpoint expects an object.
namestringOptional

Letters, digits, spaces and ()!_.-, starting with a letter, at most 64 characters, unique.

descriptionstringOptional
Description of the flow.
graphobjectOptional
The steps of a flow and how they connect. Node ids can change when a draft is saved, so read the draft again before you refer to a node.

Response

OK
validboolean
True when there are no problems.
persistedfalse

Always false; the check saves nothing.

problemslist of objects

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
5XX
Server Error