Skip to content
Brooklyn Solutions Developers

Flows

Flows: structured workflows that track obligations, deadlines and who owns them.

Loading a list with search, filters and paging? Use Flows — list screen: the filters go in the request body.

Base path
/obligations

Endpoints

32 endpoints

Method

Standard Operations

7
  • GET /obligations List flows (with search, filters and paging).
  • POST /obligations Create a new flow.
  • PATCH /obligations/bulk Update several flows at once.
  • GET /obligations/{id} Open a single flow.
  • PUT /obligations/{id} Replace a flow's details in full.
  • PATCH /obligations/{id} Edit a flow.
  • DELETE /obligations/{id} Delete a flow.

Additional Operations

25
  • GET /obligations/{obligationId}/risks List risks linked to a flow.
  • GET /obligations/{obligationId}/reviewItems List review items linked to a flow.
  • GET /obligations/{flowId}/flow-future-open-actions-count Count the future actions a flow will still create.
  • GET /obligations/{obligationsId}/files List documents attached to a flow.
  • POST /obligations/{obligationsId}/files Attach a document to a flow.
  • PATCH /obligations/{obligationsId}/file/{fileId} Update a document attached to a flow.
  • DELETE /obligations/{obligationsId}/file/{fileId} Remove a document from a flow.
  • POST /obligations/obligations-files Attach documents to several flows at once.
  • POST /obligations/obligations-bulk Create several flows at once.
  • POST /obligations/{id}/cancel Cancel a flow.
  • DELETE /obligations/{id}/tags/{tagId} Remove a tag from a flow.
  • GET /obligations/{id}/tags See the tags on a flow.
  • POST /obligations/{id}/tags Add a tag to a flow.
  • GET /obligations/reports Flows report.
  • POST /obligations/create-flow-template Save a flow as a reusable template.
  • GET /obligations/templates List flow templates.
  • POST /obligations/export-templates Download flow templates as a file.
  • POST /obligations/import-templates Upload flow templates from a file.
  • GET /obligations/timeline Show flows on a timeline by date.
  • PATCH /obligations/{obligationId}/groups Set which user groups a flow is assigned to.
  • POST /obligations/csv Download the flows list as a spreadsheet.
  • GET /obligations/metric/{metricName} Get a single headline figure about flows (e.g. number overdue).
  • GET /obligations/contained-items-count Count the items linked to a flow.
  • GET /obligations/{id}/checkRequirementsForMovingToAnotherVCS Check whether a flow can be moved to another stage.
  • GET /obligations/{flowId}/relationship-hierarchy Show the parent/child records around a flow.