Document apiReferenceContent controls

contentControls.validateWordCompatibility

Validate a content control for Word compatibility issues.

read-onlyidempotent
doc.contentControls.validateWordCompatibility(…)

Expected result

Returns a compatibility result with diagnostics.

Inputs

targetobjectrequired
Fields
kind"block" | "inline"required
nodeType"sdt"required
nodeIdstringrequired

Result

Output fields
compatiblebooleanrequired
diagnosticsobject[]required

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_INPUT
  • 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