Document apiReferenceCross refs

crossRefs.rebuild

Rebuild (recalculate) a cross-reference field.

mutates documentdry runidempotent
doc.crossRefs.rebuild(…)

Expected result

Returns a CrossRefMutationResult indicating success or a failure.

Inputs

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

Result

Output fields
true
successtruerequired
appliedChangeMode"direct" | "tracked"
crossRefobjectrequired
Fields
kind"inline"required
nodeType"crossRef"required
anchorInlineAnchorrequired
Fields
startPositionrequired
endPositionrequired
false
successfalserequired
failureobjectrequired
Fields
codestringrequired
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • INVALID_INPUT
1 more codes
  • CAPABILITY_UNAVAILABLE

Non-applied receipt codes

  • 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