customXml.parts.create

Add a new Custom XML Data Storage Part to the document. Generates a fresh itemID GUID and emits the Properties Part.

mutates documentdry runnon-idempotent
doc.customXml.parts.create(…)

Expected result

Returns a CustomXmlPartsCreateResult with the generated id and package part names on success.

Inputs

contentstringrequired
1 additional input field
schemaRefsstring[]

Result

Output fields
true
successtruerequired
idstringrequired
partNamestringrequired
propsPartNamestringrequired
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

  • 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