update_document
Partially update a Polarion document's metadata or body by supplying only the fields to change. Fetch the document first to preserve unchanged attributes.
Instructions
Update a document's metadata or body.
PATCHes only supplied attributes — omitted fields stay unchanged. Fetch via get_document BEFORE updating. home_page_content_html is raw Polarion HTML, sent verbatim — source from get_document(include_home_page_content_html=True). An empty string is rejected — pass '' for near-empty.
Body rules:
Inline .. auto-create heading work items — THE way to add a heading. For body text or work items use create_work_items + move_work_item_to_document, NOT this tool.
A polarion_wiki macro name=module-workitem leaves the work item's module unset — attach via move_work_item_to_document.
Polarion-specific constructs (tables, captions, image embeds, links, TOC/TOF widgets, page breaks) must be adapted from get_html_recipes templates, never hand-written. attachment:{id} image refs must name an existing attachment — confirm via list_document_attachments first.
workflow_action must pair with at least one attribute. Unknown status/type ids and custom_fields keys outside the type schema are rejected, values are not validated — resolve via list_document_enum_options first.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | New document type (e.g. 'req_specification'). | |
| title | No | New document title. | |
| status | No | New status; prefer workflow_action for real transitions. | |
| dry_run | No | Preview payload without writing; guards still query Polarion. | |
| space_id | Yes | Space ID ('_default' = default space). | |
| project_id | Yes | Polarion project ID. | |
| auto_suspect | No | Flag linked work items suspect on change. | |
| custom_fields | No | Partial; rich-text values as {'type':'text/html','value':...}. | |
| document_name | Yes | Document name within space_id. | |
| workflow_action | No | Workflow action ID. | |
| home_page_content_html | No | New body as raw HTML from get_document(include_home_page_content_html=True); '' rejected; anchorless blocks get id= auto-stamped. New tables, captions, images, or other Polarion constructs: call get_html_recipes first and adapt a template. | |
| uses_outline_numbering | No | Enable auto outline numbers (1, 1.1, ...). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| dry_run | Yes | ||
| updated | Yes | ||
| payload_preview | Yes |