Limitations and Known Issues¶

The following list identifies the most common use cases that are not yet available via the Polarion REST API:

General¶

• Trigger a PDF export of objects that already support it via the UI.

• Apply default sorting to all collection GET requests to achieve consistency of returned paginated results.

• Introduce a user-friendly way to work with an object's history.

• Get the specific revision ID of an object requested in the HEAD revision.

• Support a variable identifying the current user (@me) in the REST calls.

• Introduce full support for the OpenAPI Generator.

• Support a way to exclude specific Sparse Fields from the @all definition in queries.

• Provide a generic Search that will return all Polarion Objects.

• Invoke REST API calls from Workflow scripts.

• Enable the use of eSignatures via the REST API.

Administration¶

• The majority of the Administration topics are not yet available through the REST API.

• The exceptions (with varying levels of coverage) are:

  • Custom Fields,
  • Enumerations,
  • Icons,
  • Licenses,
  • Project Templates,
  • Projects,
  • Roles,
  • User Groups,
  • Users.

Baselines¶

• The Polarion REST API has not yet covered this topic.

• Support Collection, Document, and Project Baselines.

Build Management¶

• The Polarion REST API has not yet covered this topic.

Categories¶

• The Polarion REST API has not yet covered this topic.

Documents¶

• Assign Document Layout to each Work Item.

• Import Word Documents using an existing document import configuration.

• Derive a Document/update a derived Document.

• Use Word/ReqIF Round-trip.

• Move/rename a Document.

• Delete a Document.

• Delete a Document Attachment.

• Copy a Document with a different title.

• Override a branched Work Item in a Document.

• Move Work Items to the Recycle Bin.

• Work with Document Approvals.

• Update a derived Document.

• Compare Documents.

• Get the Wiki Content section as already processed HTML instead of just its code.

• Combine/append Documents.

Enumerations¶

• The following out-of-the-box Object enumerations are not supported in the current version and are treated as String enumerations:

  • Builds,
  • Project Groups,
  • Time Points,
  • Wiki Pages.

• Management of the Dependent Enumerations.

Icons¶

• Replace or delete an icon.

Pages¶

• Download a Page as an archive.

• Import Page Archive into Polarion.

Permissions¶

• Provide more granular per-endpoint permissions for Global- and Project-level endpoints.

Plans¶

• Get Plan Statistics.

Projects¶

• Get all users of a Project.

Project Groups¶

• The Polarion REST API has not yet covered this topic.

Spaces¶

• The Polarion REST API has not yet covered this topic.

Test Management¶

• Support automatic Defect creation when importing Test Results.

• List recent Tes t Records for a given Work Item.

• Provide a stand-alone Execute Test Case action.

• Work with Testing/Test Step Table Configuration.

Time Points¶

• The Polarion REST API has not yet covered this topic.

User Management¶

• Get a list of all User Roles or User Groups.

• Delete a User.

• Manage User Roles or Groups.

• Provide REST API endpoints to manage Personal Access Tokens.

Variant Management¶

• The Polarion REST API has not yet covered this topic.

Wiki Pages¶

• Polarion REST APIs will not cover this topic because it is a feature that is being phased out.

Work Items¶

• Add the option to add or remove a Work Item to/from a Plan.

• Provide an action to Duplicate a Work Item.

• Get Rich Text field content as processed HTML instead of its source code.

• Provide a way to trigger the Initial Workflow action when posting a new Work Item in a single request.

• Improve Work Records creation so it correctly adjusts the Time Spent and Remaining Estimate fields.

The Polarion REST API is actively being developed, and our main focus for future Polarion releases is to cover as many gaps identified in the above list as possible. This list is internally being maintained based on the feedback we receive from you, and it will be updated with every Polarion release.