A user should be able to trigger and execute a flow via an endpoint in the REST API.
Goal*
Using a FlowSchema.identifier, a Person.email and an Environment.identifier as a payload the endpoint should create a new FlowInstance instance and start executing the flow.
Implementation Details*
Ensure that this endpoint accepts either the identifier and email fields OR the actual ids of each model instance.
Check that there isn't already an existing instance. Maybe this could be a model constraint to ensure there's only a single record for each of these input parameters?
Acceptance Criteria*
Make sure the OpenAPI spec contains these endpoints.
Should respond with a 200 when the parameters are valid and the flow can be started.
Should respond with a 400 or greater if params are invalid.
Background & Context*
A user should be able to trigger and execute a flow via an endpoint in the REST API.
Goal*
FlowSchema.identifier
, aPerson.email
and anEnvironment.identifier
as a payload the endpoint should create a newFlowInstance
instance and start executing the flow.Implementation Details*
identifier
andemail
fields OR the actualid
s of each model instance.Acceptance Criteria*
200
when the parameters are valid and the flow can be started.400
or greater if params are invalid.Dependencies
Blockers:
22
*required field.