Document apiReferenceTables

tables.split

Split a table into two tables at the target row.

mutates documentdry runnon-idempotent
doc.tables.split(…)

Expected result

Returns a TableMutationResult receipt confirming the table was split at the target row.

Inputs

targetTableAddressconditionally required
Fields
kind"block"required
nodeType"table"required
nodeIdstringrequired
nodeIdstringconditionally required
rowIndexintegerrequired

Result

Output fields
true
successtruerequired
tableTableAddress
Fields
kind"block"required
nodeType"table"required
nodeIdstringrequired
trackedChangeRefsEntityAddress[]
false
successfalserequired
failureobjectrequired
Fields
code"NO_OP" | "INVALID_TARGET" | "TARGET_NOT_FOUND" | "CAPABILITY_UNAVAILABLE"required
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • CAPABILITY_UNAVAILABLE

Non-applied receipt codes

  • 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