Document apiReferenceCross refs

crossRefs.get

Get detailed information about a specific cross-reference field.

read-onlyidempotent
doc.crossRefs.get(…)

Expected result

Returns a CrossRefInfo object with the cross-reference's target, display, and resolved text.

Inputs

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

Result

Output fields

No fields.

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • CAPABILITY_UNAVAILABLE

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