VEverdun
site summaries

Update Site Summary Inclusions

Tick one event into (or out of) this summary's customer e-mail.

require_summary_write (owner, monitoring manager, parent manager) for the same reason the settings write carries it: this decides what a customer reads, and a permission would also be held by any ordinary operator an owner had granted it. A customer-side login is refused BY ROLE — they read their own report, they do not edit it.

An event that is in neither of the sheet's lists is a 404 raised inside the scoped resolution, so there is no id a caller can probe to learn that an event exists in another tenant.

patch/site-summaries/{summary_id}/inclusions

Request

  • Base URL
    https://api.verdun.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.verdun.ai/site-summaries/{summary_id}/inclusions
  • Auth
    HTTP bearer

Path parameters

summary_idstring uuid required

Request body

event_idstring required

Event id to include or exclude. Must appear in this summary's escalations or reviewed_non_escalated list, else 404.

includedboolean required

True ticks the event INTO the customer e-mail; false writes an explicit exclusion rather than deleting the key, so 'never considered' and 'deliberately removed' stay distinguishable.

Example request

{
  "event_id": "9f8e7d6c-1111-4222-8333-444455556666",
  "included": true
}

Response

Successful Response

idstring required

Summary UUID.

site_idstring required

Site UUID this summary belongs to.

inclusionsstring[] required

Event ids currently ticked INTO the customer e-mail, in insertion order. Escalations are always sent and are not listed here unless explicitly ticked.

Example response

{
  "id": "9f8e7d6c-1111-4222-8333-444455556666",
  "site_id": "3f1e0d2c-1111-4222-8333-444455556666",
  "inclusions": [
    "9f8e7d6c-1111-4222-8333-444455556666"
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.