bookmarks.get

Summary

Get detailed information about a specific bookmark.

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

Expected result

Returns a BookmarkInfo object with the bookmark’s name, range, and optional table-column data.

Input fields

Field	Type	Required	Description
`target`	object(kind=“entity”)	yes
`target.entityType`	`"bookmark"`	yes	Constant: `"bookmark"`
`target.kind`	`"entity"`	yes	Constant: `"entity"`
`target.name`	string	yes
`target.story`	StoryLocator	no	StoryLocator

Example request

{
  "target": {
    "entityType": "bookmark",
    "kind": "entity",
    "name": "example",
    "story": {
      "kind": "story",
      "storyType": "body"
    }
  }
}

Output fields

No fields.

Example response

{}

Pre-apply throws

TARGET_NOT_FOUND
CAPABILITY_UNAVAILABLE

Non-applied failure codes

None

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "target": {
      "additionalProperties": false,
      "properties": {
        "entityType": {
          "const": "bookmark"
        },
        "kind": {
          "const": "entity"
        },
        "name": {
          "type": "string"
        },
        "story": {
          "$ref": "#/$defs/StoryLocator"
        }
      },
      "required": [
        "kind",
        "entityType",
        "name"
      ],
      "type": "object"
    }
  },
  "required": [
    "target"
  ],
  "type": "object"
}

Raw output schema

{
  "type": "object"
}

Getting Started

Editor

Document Engine

AI

Solutions

Resources

Summary

Expected result

Input fields

Example request

Output fields

Example response

Pre-apply throws

Non-applied failure codes

Raw schemas

​Summary

​Expected result

​Input fields

​Example request

​Output fields

​Example response

​Pre-apply throws

​Non-applied failure codes

​Raw schemas

Summary

Expected result

Input fields

Example request

Output fields

Example response

Pre-apply throws

Non-applied failure codes

Raw schemas