Bulk Update Client Objective Notes

Updates notes for multiple objectives in a client framework in one request. A prior notes read is optional.

Update rules

  • Include only the fields you want to update. Supplied text replaces the current value. Send an empty string to clear it.
  • Use remarks for parent objectives, implementation_details for parent or child objectives, and mapped IDs in
    sub_objectives for assessment notes. Implementation variables are stored as supplied.
  • Changes are applied together. An invalid target, changed mapping, duplicate objective ID, or conflicting edits
    to a shared assessment rejects the entire batch. Identical edits to a shared assessment are applied once.
  • Changing an auto-answered assessment note marks it as reviewed. Existing answers, compliance status, maturity,
    and remediation plans are preserved. Objectives are not retested.

Batch limits

  • Send up to 500 objectives, 500 assessment edits, and 8 MiB of raw UTF-8 note text per request.
  • Split larger batches that touch more than 5,000 mapped assessments or 5,000 objectives, including shared mappings.
    Remarks are also subject to the encoded storage limit.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Client UUID or tenant identifier

Accepts either the client UUID or the client's tenant_id.

int32
required
≥ 1

Client framework ID

Body Params

Atomic replacement of distinct notes inside one framework. At most 500 objectives, 500 assessment edits, and 8 MiB of raw UTF-8 note text across the request. Duplicate objective IDs and conflicting shared-assessment edits are rejected

objectives
array of objects
required
length between 1 and 500

Objectives to update in input order; every ID must be unique

objectives*
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json