Playground

Playground

RiskItem

/api/v1/risk-items

A tracked risk with likelihood, impact, and mitigation.

listgetcreateupdate

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
titlestringShort, descriptive title of the risk.
descriptionstringDetailed description of the risk, including the threat source, vulnerability exploited, and potential business impact.
categorystringBusiness category of the risk. Used to route risks to the appropriate risk owner team and generate category-specific risk dashboards.
likelihoodstringQualitative likelihood rating representing the probability that this risk will materialize. Maps to numeric values 1–5 for risk score computation.
impactstringQualitative impact rating representing the magnitude of harm if this risk materializes. Maps to numeric values 1–5 for risk score computation.
risk_scorenumberComputed risk score (likelihood × impact), where each dimension maps to 1–5. Range is 1 (lowest) to 25 (highest). Set by the platform whenever likelihood or imp
statusstringCurrent treatment status. 'mitigating' means active work is underway to reduce the risk. 'accepted' means the risk has been formally accepted by an authorized s
owneruuidUUID of the Person responsible for managing and reporting on this risk item.
linked_vulnerability_idsjsonUUIDs of Vulnerability records that contribute to or evidence this risk.
linked_control_idsjsonUUIDs of ComplianceControl records that mitigate or address this risk.
mitigation_planstringDocumented plan for mitigating or treating this risk, including actions, timelines, and responsible parties.
due_datedate-timeTarget date by which this risk should be mitigated, accepted, or closed.

API

client.risk.*
Loading manifest…