DealSleek API · Workflows
PreviewClose Workflow Incident
Close an incident. Requires a risk assessment + at least one corrective action (Art. 73(6)); closing unblocks re-promotion of the workflow.
/api/v1/workflows/dispatchHeaders
AuthorizationstringRequiredAccess token of the signed-in user, as a Bearer token. It identifies the user, their role and the workspace.
X-CQRS-ActionstringRequiredNames the command to run. Must be
CLOSE_WORKFLOW_INCIDENTfor this endpoint.Content-TypestringRequiredAlways
application/json.X-Idempotency-KeystringOptionalA key you choose that is unique to this attempt. A command repeated with the same key is not applied a second time.
X-Correlation-IdstringOptionalYour own identifier for the request. Returned in the
x-correlation-idresponse header; generated when you leave it out.
Request body
closed_byuuidRequiredNo description yet.
corrective_actionsarray of stringRequiredAt least one corrective action; these feed the governance regression loop (regression fixtures, re-promotion unblocking).
- minimum items 1
incident_iduuidRequiredNo description yet.
risk_assessmentstringRequiredArt. 73(6) — closing requires the investigation's risk assessment.
- minimum length 1
- maximum length 4000
tenant_iduuidRequiredNo description yet.
Response
Status 202. The command was applied. The body reports the outcome and, where the command changes a record, that record's new state.
successbooleanRequiredtruewhen the command was applied.error_messagestringRequiredEmpty when the command was applied.
projected_stateobjectOptionalThe record as it stands after the command.
event_payloadobjectOptionalThe event the command recorded.
insightsarray of objectOptionalAdvisory notes about the result. Each has a
code, amessageand animpactnumber.
Errors
Every error carries an HTTP status. Where it also carries a code, branch on the code, not on the message.
- 400
X-CQRS-Actionis missing or names a command this route does not accept. SendCLOSE_WORKFLOW_INCIDENT. - 400
DOMAIN_ROUTINGThe body is not a valid command. Check the required fields and their types. - 401The access token is missing, expired or not valid.
- 401
L1_AUTHThe caller's role is belowmanageror the caller has no access to this record. - 403
L1_POLICYA business rule refused the command. The message names the rule. - 409
L1_IDEMPOTENCYA command with this idempotency key was already applied. - 409
CONFLICTThe command would duplicate a record that must be unique. - 500
L3_COMMITThe command was valid but could not be saved.