Skip to content

Risk Center

Risk Center endpoints on the External API cover risk CRUD, associations, treatment↔task links, files, and heat map.

All paths are under /external. Authenticate with an API key (see Authentication).

Typical workflows

Create a risk

  1. GET /external/risk/status/list and GET /external/risk/category/list if you need IDs
  2. POST /external/risk/framework/{framework}/new with title, impact (1–5), probability (1–5), dueDate
  3. Optional: PATCH /external/risk/{riskUniqueId}/edit for treatment plan, status, owner, category
  4. Verify: GET /external/risk/{riskUniqueId}/item
  1. Resolve inventory or assessment uniqueId
  2. PATCH /external/risk/{riskUniqueId}/association/add with module + moduleIdentifier
  3. 5 = assessment, 6 = process, 7 = vendor, 8 = asset
  4. Tasks are not associations — use treatment↔task endpoints below

Connect tasks to a treatment plan

  1. GET /external/risk/{riskUniqueId}/item → read riskTreatment.uniqueId (or treatmentPlan.uniqueId in AI tools)
  2. POST /external/risk-treatment/{riskTreatmentUniqueId}/tasks/connect with taskUniqueIds
  3. List: GET .../tasks/list?connected=true

Files and heat map

  • Attach/download/remove: /external/risk/{riskUniqueId}/file/...
  • Matrix: GET /external/risk/heat-map
  • Labels: GET /external/risk/heat-map/labels · replace: POST /external/risk/heat-map/labels/new (exactly 5 strings per array)
  • Title search: GET /external/risk/autocomplete?search=...

Status changes

There is no separate status endpoint. Send statusTypeId on PATCH /external/risk/{riskUniqueId}/edit (from GET /external/risk/status/list).

Endpoint summary

Endpoint Method Description
/risk/list GET List risks
/risk/autocomplete GET Title autocomplete
/risk/{id}/item GET Risk detail
/risk/framework/{framework}/new POST Create risk
/risk/{id}/edit PATCH Update risk (incl. status)
/risk/{id}/delete DELETE Delete risk
/risk/{id}/association/add PATCH Add association
/risk/list/module/{module}/identifier/{id} GET List by association
/risk/status/list GET Status catalog
/risk/category/list GET Categories
/risk/category/new POST Create category
/risk-treatment/{id}/tasks/list GET Treatment tasks
/risk-treatment/{id}/tasks/connect POST Link tasks
/risk-treatment/{id}/tasks/disconnect POST Unlink tasks
/risk/{id}/file/add POST Attach file
/risk/{id}/file/{uuid}/show GET Download/preview
/risk/{id}/file/{uuid}/remove DELETE Remove file
/risk/heat-map GET Heat map aggregates
/risk/heat-map/labels GET Heat map labels
/risk/heat-map/labels/new POST Replace labels