Document apiReferenceHyperlinks

hyperlinks.get

Retrieve details of a specific hyperlink by its inline address.

read-onlyidempotent
doc.hyperlinks.get(…)

Expected result

Returns a HyperlinkInfo object with the address, destination properties, and display text.

Inputs

targetobjectrequired
Fields
kind"inline"required
nodeType"hyperlink"required
anchorInlineAnchorrequired
Fields
startPositionrequired
endPositionrequired

Result

Output fields
addressobjectrequired
Fields
kind"inline"required
nodeType"hyperlink"required
anchorInlineAnchorrequired
Fields
startPositionrequired
endPositionrequired
propertiesobjectrequired
Fields
hrefstring
anchorstring
docLocationstring
tooltipstring
targetstring
relstring
textstring

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas