Read LiveDoc as Markdown
read_document_markdownRetrieve a Polarion LiveDoc's full body as Markdown with an outline, including embedded Work Item titles and descriptions, from the current or a specified repository revision.
Instructions
Reads a LiveDoc from its current or requested repository revision and returns {markdown, outline}; embedded Work Items are rendered with their title and description. Use this for the full document body; use get_document_outline for headings only or read_document_section for one section. Requires a project ID, space ID, and document name the signed-in Polarion user can read.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| spaceId | Yes | Document space ID within the project, such as `Specifications`. | |
| document | Yes | LiveDoc name within the space, not a composite project/space/document path. | |
| revision | No | Repository revision to read; omit to use the current revision. | |
| projectId | Yes | Polarion project ID that owns the LiveDoc, such as `PROJECT`. |