get_document
Retrieve a document's metadata from Polarion, including title, type, status, and custom fields. Optionally fetch its raw HTML body for round-trip editing.
Instructions
Get a document's metadata (and optionally its raw body source).
Returns title/type/status/custom fields. With
include_homepage_content_html=True, content_html carries
homePageContent as raw HTML — the round-trip shape for
update_document. homePageContent is inline prose only (headings and
embedded work items are separate); use read_document end-to-end. Feed
content_html back only when the flag was True (False blanks it; ""
rejected on write).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| project_id | Yes | Polarion project ID. | |
| space_id | Yes | Space ID containing the document (e.g. '_default'). | |
| document_name | Yes | Document name within the space (spaces handled automatically). | |
| include_homepage_content_html | No | When True, fill ``content_html`` with raw HTML for round-trip editing. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| title | Yes | ||
| type | No | ||
| status | No | ||
| content_html | No | ||
| custom_fields | No |