Skip to main content
Alpha: Document API is currently alpha and subject to breaking changes.

​
Summary

  • Operation ID: trackChanges.get
  • API member path: editor.doc.trackChanges.get(...)
  • Mutates document: no
  • Idempotency: idempotent
  • Supports tracked mode: no
  • Supports dry run: no
  • Deterministic target resolution: yes

​
Input fields

FieldTypeRequiredDescription
idstringyes

​
Example request

{
  "id": "id-001"
}

​
Output fields

FieldTypeRequiredDescription
addressTrackedChangeAddressyesTrackedChangeAddress
authorstringno
authorEmailstringno
authorImagestringno
datestringno
excerptstringno
idstringyes
typeenumyes"insert", "delete", "format"

​
Example response

{
  "address": {
    "entityId": "entity-789",
    "entityType": "trackedChange",
    "kind": "entity"
  },
  "author": "Jane Doe",
  "authorEmail": "jane@example.com",
  "id": "id-001",
  "type": "insert"
}

​
Pre-apply throws

  • TARGET_NOT_FOUND

​
Non-applied failure codes

  • None

​
Raw schemas

{
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string"
    }
  },
  "required": [
    "id"
  ],
  "type": "object"
}

{
  "additionalProperties": false,
  "properties": {
    "address": {
      "$ref": "#/$defs/TrackedChangeAddress"
    },
    "author": {
      "type": "string"
    },
    "authorEmail": {
      "type": "string"
    },
    "authorImage": {
      "type": "string"
    },
    "date": {
      "type": "string"
    },
    "excerpt": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "type": {
      "enum": [
        "insert",
        "delete",
        "format"
      ]
    }
  },
  "required": [
    "address",
    "id",
    "type"
  ],
  "type": "object"
}