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

​
Summary

Update the properties of an existing XE index entry.
  • Operation ID: index.entries.update
  • API member path: editor.doc.index.entries.update(...)
  • Mutates document: yes
  • Idempotency: idempotent
  • Supports tracked mode: no
  • Supports dry run: no
  • Deterministic target resolution: yes

​
Expected result

Returns an IndexEntryMutationResult indicating success or a failure.

​
Input fields

FieldTypeRequiredDescription
patchobjectyes
patch.boldbooleanno
patch.crossReferencestringno
patch.entryTypestringno
patch.italicbooleanno
patch.pageRangeBookmarkstringno
patch.subEntrystringno
patch.textstringno
patch.yomistringno
targetobject(kind=“inline”)yes
target.anchorInlineAnchoryesInlineAnchor
target.anchor.endPositionyesPosition
target.anchor.end.blockIdstringyes
target.anchor.end.offsetintegeryes
target.anchor.startPositionyesPosition
target.anchor.start.blockIdstringyes
target.anchor.start.offsetintegeryes
target.kind"inline"yesConstant: "inline"
target.nodeType"indexEntry"yesConstant: "indexEntry"

​
Example request

{
  "patch": {
    "subEntry": "example",
    "text": "Hello, world."
  },
  "target": {
    "anchor": {
      "end": {
        "blockId": "block-abc123",
        "offset": 0
      },
      "start": {
        "blockId": "block-abc123",
        "offset": 0
      }
    },
    "kind": "inline",
    "nodeType": "indexEntry"
  }
}

​
Output fields

​
Variant 1 (entry.kind=“inline”)

FieldTypeRequiredDescription
entryobject(kind=“inline”)yes
entry.anchorInlineAnchoryesInlineAnchor
entry.anchor.endPositionyesPosition
entry.anchor.end.blockIdstringyes
entry.anchor.end.offsetintegeryes
entry.anchor.startPositionyesPosition
entry.anchor.start.blockIdstringyes
entry.anchor.start.offsetintegeryes
entry.kind"inline"yesConstant: "inline"
entry.nodeType"indexEntry"yesConstant: "indexEntry"
successtrueyesConstant: true

​
Variant 2 (success=false)

FieldTypeRequiredDescription
failureobjectyes
failure.codestringyes
failure.detailsanyno
failure.messagestringyes
successfalseyesConstant: false

​
Example response

{
  "entry": {
    "anchor": {
      "end": {
        "blockId": "block-abc123",
        "offset": 0
      },
      "start": {
        "blockId": "block-abc123",
        "offset": 0
      }
    },
    "kind": "inline",
    "nodeType": "indexEntry"
  },
  "success": true
}

​
Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • INVALID_INPUT
  • CAPABILITY_UNAVAILABLE

​
Non-applied failure codes

  • None

​
Raw schemas

{
  "additionalProperties": false,
  "properties": {
    "patch": {
      "additionalProperties": false,
      "properties": {
        "bold": {
          "type": "boolean"
        },
        "crossReference": {
          "type": "string"
        },
        "entryType": {
          "type": "string"
        },
        "italic": {
          "type": "boolean"
        },
        "pageRangeBookmark": {
          "type": "string"
        },
        "subEntry": {
          "type": "string"
        },
        "text": {
          "type": "string"
        },
        "yomi": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "target": {
      "additionalProperties": false,
      "properties": {
        "anchor": {
          "$ref": "#/$defs/InlineAnchor"
        },
        "kind": {
          "const": "inline"
        },
        "nodeType": {
          "const": "indexEntry"
        }
      },
      "required": [
        "kind",
        "nodeType",
        "anchor"
      ],
      "type": "object"
    }
  },
  "required": [
    "target",
    "patch"
  ],
  "type": "object"
}

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "entry": {
          "additionalProperties": false,
          "properties": {
            "anchor": {
              "$ref": "#/$defs/InlineAnchor"
            },
            "kind": {
              "const": "inline"
            },
            "nodeType": {
              "const": "indexEntry"
            }
          },
          "required": [
            "kind",
            "nodeType",
            "anchor"
          ],
          "type": "object"
        },
        "success": {
          "const": true
        }
      },
      "required": [
        "success",
        "entry"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "failure": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "type": "string"
            },
            "details": {},
            "message": {
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object"
        },
        "success": {
          "const": false
        }
      },
      "required": [
        "success",
        "failure"
      ],
      "type": "object"
    }
  ]
}

{
  "additionalProperties": false,
  "properties": {
    "entry": {
      "additionalProperties": false,
      "properties": {
        "anchor": {
          "$ref": "#/$defs/InlineAnchor"
        },
        "kind": {
          "const": "inline"
        },
        "nodeType": {
          "const": "indexEntry"
        }
      },
      "required": [
        "kind",
        "nodeType",
        "anchor"
      ],
      "type": "object"
    },
    "success": {
      "const": true
    }
  },
  "required": [
    "success",
    "entry"
  ],
  "type": "object"
}

{
  "additionalProperties": false,
  "properties": {
    "failure": {
      "additionalProperties": false,
      "properties": {
        "code": {
          "type": "string"
        },
        "details": {},
        "message": {
          "type": "string"
        }
      },
      "required": [
        "code",
        "message"
      ],
      "type": "object"
    },
    "success": {
      "const": false
    }
  },
  "required": [
    "success",
    "failure"
  ],
  "type": "object"
}