Skip to main content

URL Parameter Structure

RISKSHEET URLs follow this pattern:
https://<server>/polarion/risksheet/view?project=<projectId>&document=<documentId>&revision=<revisionId>&comparingTo=<baselineRevision>&view=<viewName>

Core Parameters

Document Navigation

ParameterTypeRequiredDescriptionExample
projectstringYesPolarion project ID where the document resides?project=MyProject
documentstringNoWiki document ID to open (default: uses context from page)?document=MyFolder/MyRisksheet
spacestringNoDocument space prefix for multi-space projects?space=default

Revision Control

ParameterTypeRequiredDescriptionExample
revisionstringNoSpecific document revision to view (empty = current/head)?revision=20250210_120000
comparingTostringNoBaseline revision to compare against (activates comparison mode)?comparingTo=20250101_000000

View Configuration

ParameterTypeRequiredDescriptionExample
viewstringNoName of saved view to display on load?view=Risk%20Assessment
searchstringNoInitial search/filter query for work items?search=severity%3DHigh
selectedItemstringNoItem ID to select/focus on load?selectedItem=ITEM-001

Parameter Encoding

URL parameters must be properly encoded:
CharacterEncodedExample
Space%20 or +Risk%20Assessment
Slash%2FFolder%2FRisksheet
Ampersand%26criteria%26status
Equals%3Dseverity%3DHigh
Pipe%7Citem%7Cstatus

Common URL Patterns

Open Current Document in Current Project

https://server/polarion/risksheet/view
No parameters needed if accessing from within a Polarion document context.

Open Specific Document

https://server/polarion/risksheet/view?project=Safety&document=FMEA/SystemFailures

View Historical Revision

https://server/polarion/risksheet/view?project=Safety&document=FMEA/SystemFailures&revision=20250101_120000
When viewing a historical revision:
  • The RISKSHEET displays in read-only mode
  • All editing is disabled
  • No save button appears
  • The document state reflects the point in time of that revision

Compare Two Revisions (Side-by-Side Diff)

https://server/polarion/risksheet/view?project=Safety&document=FMEA/SystemFailures&revision=20250210_120000&comparingTo=20250101_000000
Comparison mode shows:
  • Added items: Green background (new in current revision)
  • Removed items: Red background (deleted in baseline)
  • Modified items: Yellow background (changed properties)
  • Unchanged items: Normal display (no changes)

Load Specific Saved View

https://server/polarion/risksheet/view?project=Safety&document=FMEA/SystemFailures&view=Risk%20Assessment
The saved view named “Risk Assessment” displays on load, showing only its configured columns.
https://server/polarion/risksheet/view?project=Safety&document=FMEA/SystemFailures&search=severity%3DCritical
Filters displayed items based on the search query on load.

URL State Flow Diagram

diagram

Revision ID Format

Revision IDs in Polarion use timestamps:
PositionValueDescription
1-4YYYYYear (4 digits)
5-6MMMonth (01-12)
7-8DDDay (01-31)
10-11HHHours (00-23)
12-13MMMinutes (00-59)
14-15SSSeconds (00-59)
Example: 20250210_120000 = February 10, 2025 at 12:00:00 Example: 20250210_120000 = February 10, 2025 at 12:00:00

Comparison Mode Behavior

Visual Indicators

StateColorCSS ClassMeaning
AddedGreencomparison-addedItem exists in current but not baseline
RemovedRedcomparison-removedItem exists in baseline but not current
ModifiedYellowcomparison-modifiedItem properties changed
UnchangedNormalNo changes between versions

User Actions in Comparison Mode

ActionAllowed?Notes
Edit cellsNoAll cells are read-only in comparison mode
Create rowsNoCannot add new items while comparing
Delete rowsNoCannot remove items while comparing
Toggle ‘Show Unchanged’YesFilter to see only changed items
Exit comparisonYesClick comparison toolbar button to exit
When exiting comparison mode, the URL parameter comparingTo is removed. The RISKSHEET returns to normal editing mode for the current revision.

Read-Only Mode Triggers

The RISKSHEET automatically enters read-only mode when:
  1. Viewing a historical revision: ?revision=<pastDate> (not current revision)
  2. Configuration specifies readonly: "readonly": true in config
  3. User lacks edit permissions: Polarion permission check
  4. Comparison mode active: ?comparingTo=<baseline>
  5. Document is locked/approved: Workflow state prevents edits

Sharing and Bookmarking

Share Current State

Copy the current URL from the browser address bar:
https://server/polarion/risksheet/view?project=MyProject&document=MyFolder/MyRisksheet&view=Risk%20Assessment
This URL preserves:
  • Project and document
  • Selected saved view
  • Current scroll/selection (via focus parameter, if supported)

Share a Specific Revision

https://server/polarion/risksheet/view?project=MyProject&document=MyFolder/MyRisksheet&revision=20250101_000000
Recipients can review historical state without worrying about concurrent edits.

Share a Comparison

https://server/polarion/risksheet/view?project=MyProject&document=MyFolder/MyRisksheet&revision=20250210_000000&comparingTo=20250101_000000
Recipients see the exact differences between two revisions.

API URL Construction

The RISKSHEET internally constructs API URLs based on parameters:
UseURL TemplateExample
Data fetch/api/v2/projects/<project>/risks/<document>/api/v2/projects/MyProject/risks/FMEA%2FSystem
Revision data/api/v2/projects/<project>/risks/<document>?rev=<revision>...?rev=20250101_000000
Comparison query/api/v2/projects/<project>/risks/<document>/comparison?baseline=<comparingTo>...?baseline=20250101_000000

Special Parameters

Debug Parameter

?debug=true
Enables debug logging in the browser console. Useful for troubleshooting:
  • Configuration loading
  • Data fetch errors
  • Query execution
  • Editor behavior

Embedded/IFrame Mode

When RISKSHEET is embedded in a Polarion page via iframe, parameters are passed through the iframe src attribute:
<iframe src="/polarion/risksheet/view?project=MyProject&document=MyDoc"></iframe>

Browser Compatibility

BrowserVersionSupportNotes
Chrome90+FullURL length limit ~2000 chars
Firefox88+FullURL length limit ~2000 chars
Safari14+FullURL length limit ~2000 chars
Edge90+FullURL length limit ~2000 chars
IE 11NoneNot supported
Browser URL length limits are approximately 2000 characters. Complex queries with many filter criteria may exceed this. Use URL shortener services or bookmark complex RISKSHEET states instead.
Source Code
  • ShowConfigurationCommand.ts
  • AppConfig.ts
  • AppConfigParser.ts
  • SheetConstants.ts
  • NewBaselineCommand.ts