Document apiReferenceLists

lists.apply

Apply a numbering definition to a paragraph. When `/word/numbering.xml` is absent it is materialized atomically together with the package content-type override and document relationship. Seeds bullet or ordered single-level definitions when no `reuseNumId` is provided. Available on v2-backed sessions only; v1-backed sessions currently return `CAPABILITY_UNAVAILABLE`.

mutates documenttracked modenon-idempotent
doc.lists.apply(…)

Expected result

Returns a ListsMutateItemResult receipt with txId; partsChanged includes numbering / content-types / rels when first-list materialization fires.

Inputs

targetparagraph | listItemrequired
paragraph
kind"block"required
nodeType"paragraph"required
nodeIdstringrequired
listItem
kind"block"required
nodeType"listItem"required
nodeIdstringrequired
seed"bullet" | "ordered"required
2 additional input fields
reuseNumIdstring
ilvlinteger

Result

Output fields
true
successtruerequired
itemListItemAddressrequired
Fields
kind"block"required
nodeType"listItem"required
nodeIdstringrequired
storyStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
affectedStoriesStoryLocator[]
remappedRefsAffectedRefRemapping[]
textRangeShiftsTextRangeShift[]
txIdstring
changedboolean
trackedChangeRefsTrackedChangeAddress[]
false
successfalserequired
failureobjectrequired
Fields
code"INVALID_TARGET" | "TARGET_NOT_FOUND" | "CAPABILITY_UNAVAILABLE" | "INVALID_CONTEXT" | "INVALID_INPUT"required
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • CAPABILITY_UNAVAILABLE
  • INVALID_TARGET
1 more codes
  • INVALID_INPUT

Non-applied receipt codes

  • INVALID_TARGET
  • TARGET_NOT_FOUND
  • CAPABILITY_UNAVAILABLE
2 more codes
  • INVALID_CONTEXT
  • INVALID_INPUT

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