customXml.parts.get

Get a single Custom XML Data Storage Part by itemID or package part name, including its full content. v1 partName targeting is limited to Word-style customXml/itemN.xml paths.

read-onlyidempotent
doc.customXml.parts.get(…)

Expected result

Returns a CustomXmlPartInfo with id, partName, namespaces, schemaRefs, and content; or null if not found.

Inputs

targetid | partNamerequired
id
idstringrequired
partName
partNamestringrequired

Result

Output fields
Variant 1

No fields.

Variant 2

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