get_document
Retrieve a Polarion document's metadata including title, type, status, timestamps, editors, and custom fields. Optionally include raw home page content HTML for round-trip editing.
Instructions
Get a document's metadata: title/type/status/timestamps/editors/custom fields.
include_home_page_content_html=True fills content_html with raw homePageContent HTML — the required source for update_document(home_page_content_html=...). That body is inline prose only — headings and embedded work items render via read_document. Never feed back a blanked (flag=False) body.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"project_id": "<project_id>",
"space_id": "<space_id>",
"document_name": "<document_name>"
},
"name": "get_document"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| space_id | Yes | Space ID ('_default' = default space). | |
| project_id | Yes | Polarion project ID. | |
| document_name | Yes | Document name within space_id. | |
| include_home_page_content_html | No | Fill content_html with raw HTML for round-trip editing. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | ||
| title | Yes | ||
| status | No | ||
| created | No | ||
| updated | No | ||
| author_id | No | ||
| author_name | No | ||
| auto_suspect | No | ||
| content_html | No | ||
| custom_fields | No | ||
| last_updated_by_id | No | ||
| last_updated_by_name | No | ||
| rendering_layout_types | No | ||
| uses_outline_numbering | No |