get_polarion_document
Access structured documents like specifications and manuals from Polarion spaces using project ID, space ID, and document name to retrieve organized requirement collections.
Instructions
<purpose>Access specific structured documents within a Polarion space</purpose>
<when_to_use>
- When you need access to organized documents (specifications, manuals)
- When user provides specific space and document names
- When work items reference specific documents that need direct access
- For accessing curated requirement collections in document format
</when_to_use>
<workflow_position>
STEP 1: Use get_polarion_projects() to identify project
STEP 2: Use get_polarion_work_items() to explore and potentially discover space references
STEP 3: Use this tool when you have specific space_id and document_name
ALTERNATIVE: Often get_polarion_work_items() provides equivalent or better information
</workflow_position>
<parameters>
- project_id: Required. From get_polarion_projects()
- space_id: Required. EXACT space name (user-provided or from work item references)
- document_name: Required. Document name (e.g., "HMI", "System Requirements Specification")
- fields: "@basic" for summary, "@all" for complete content
</parameters>
<examples>
- HMI specifications: project_id="AutoCar", space_id="Master Specifications", document_name="HMI"
- System requirements: project_id="AutoCar", space_id="Requirements", document_name="System"
</examples>
<critical_requirements>
- space_id must be EXACT name (case-sensitive)
- document_name is case-sensitive
- Use quotes around space names with spaces (e.g., "Master Specifications")
- Space names typically provided by user or discovered from work item exploration
</critical_requirements>
<output>
Structured document content including organized requirements and specifications
Often contains similar information to work items but in document format
</output>
<troubleshooting>
If 404 error: Verify space_id and document_name spelling
Common spaces: "Master Specifications", "Requirements", "Design Documents"
Try exploring with get_polarion_work_items() first for context
</troubleshooting>
<note>
Space names are not discoverable via API - they come from user knowledge or work item references
</note>
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| document_name | Yes | ||
| fields | No | @basic | |
| project_id | Yes | ||
| space_id | Yes |
Input Schema (JSON Schema)
{
"properties": {
"document_name": {
"title": "Document Name",
"type": "string"
},
"fields": {
"default": "@basic",
"title": "Fields",
"type": "string"
},
"project_id": {
"title": "Project Id",
"type": "string"
},
"space_id": {
"title": "Space Id",
"type": "string"
}
},
"required": [
"project_id",
"space_id",
"document_name"
],
"type": "object"
}