Skip to main content

Summary

List tracked changes in the document. Body-only by default; pass in: <StoryLocator> or in: "all" to widen scope.
  • Operation ID: trackChanges.list
  • API member path: editor.doc.trackChanges.list(...)
  • Mutates document: no
  • Idempotency: idempotent
  • Supports tracked mode: no
  • Supports dry run: no
  • Deterministic target resolution: yes

Expected result

Returns a TrackChangesListResult of logical tracked-change entries with SuperDoc ids, semantic type/subtype, author/date/excerpt, revisionGroupId, flat projection fields (grouping, insertedText, deletedText, formattingDeltaSummary, origin, imported, canonicalizationKind, addressKind, resolvableById), optional overlap metadata, and source provenance via sourceIds / wordRevisionIds. Structural whole-table changes surface subtypes such as table-insert and table-delete.

Input fields

Example request

Output fields

Example response

Pre-apply throws

  • INVALID_INPUT

Non-applied failure codes

  • None

Raw schemas