ControlMap API - Objective notes and bulk updates
Summary
The API reference now describes reading editable objective note source, updating mapped assessment notes, and replacing notes across a framework in one atomic request. Implementation source retains unexpanded document variables. The major version remains v1.
Changes
Added
-
GET
/controlmap/v1/clients/{client_id}/frameworks/{framework_id}/objectives/{objective_id}/notes- Read objective remarks, implementation source, and mapped assessment notes in the
notesobject without retesting compliance.
- Read objective remarks, implementation source, and mapped assessment notes in the
-
PATCH
/controlmap/v1/clients/{client_id}/frameworks/{framework_id}/objectives/bulk-update- Replace or clear notes for up to 500 objectives and 500 assessment note edits in one client framework, with a total raw UTF-8 text limit of 8 MiB.
- Send note updates directly. Any invalid target, changed assessment mapping, conflicting shared edit, or batch-limit failure rejects the entire request.
- Successful responses contain updated and unchanged counts plus one result per submitted objective in
data, in request order. - Authorization failures return
403with the standarderrorsresponse envelope.
Changed
-
PATCH
/controlmap/v1/clients/{client_id}/frameworks/{framework_id}/objectives/{objective_id}- Update mapped assessment notes through
sub_objectives, using assessment row IDs returned by the editable notes read. - An assessment mapping conflict rejects the request and rolls back every field.
- Send empty note strings to clear values; omitted fields are preserved. Assessment note edits preserve answers, compliance status, maturity, and POAM.
- Update mapped assessment notes through
-
Objective detail responses describe
created_at,updated_at, andautomated_tested_onas timestamp strings without a timezone offset, matching the existing responses.
Compatibility
Existing PATCH requests remain supported. The objective notes read and bulk update use the response shapes above. Writes can run without an initial read or a revision check.
Dates
- Effective: [2026-11-05]
