Limitations and Known Issues¶

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

General¶

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

• Provide REST API endpoints to manage Personal Access Tokens.

• Get the metadata of a given object. (Primarily, the list of all out-of-the-box custom fields and their attributes.)

• Get information about the current version of Polarion and the REST API configuration.

• Support a variable that will identify the current User (@me) in the REST calls.

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

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

• Enable the use of eSignatures via the REST API.

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

• Invoke REST API calls from Workflow scripts.

Administration¶

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

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

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

Baselines¶

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

• Support both Project and Document Baselines.

Build Management¶

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

Documents¶

• Get a list of all Documents filterable by a query.

• Derive a Document/update a derived Document.

• Use Word/ReqIF Round-trip.

• Delete a Document or a Document Attachment.

• Copy a Document with a different title.

• Move a Document.

• Combine/append Documents.

• Compare Documents.

• Move Work Items to the Recycle Bin.

• Work with all elements that can be present in a Document as Document Parts.

• Work with Document Approvals.

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

Enumerations¶

• The following OOTB Object enumerations are not supported in the current version and are treated as String enumerations:

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

• Some specialized attributes of some Enumeration types are not yet supported.

  • (i.e., for Link Role Enumeration, the Rules for Link Roles section.)

• Access and change the configuration of Dependent Enumerations.

• List of all Enumerations configured for a given level (Repository/Project).

• Support for Custom Fields.

Icons¶

• Replace or delete an icon.

Jobs¶

• Get a list of all Jobs.

• Execute a Job.

Licenses¶

• Get license usage statistics.
• Get or set license assignments for all users all at once.
• Get the license of a current or specific user.

Pages¶

• Get a list of all Pages filterable by a query.

• Work with repository-level Pages.

• Get all Attachments of a Page.

• Post or delete a Page, including its Home Page Content.

• Get all Attachments of a Page.

• Delete a Page Attachment.

• Work with Page Comments and Watches.

Plans¶

• Get Plan Statistics.

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¶

• 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.

Users¶

• Change the license of a User who already has one assigned.

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

• Delete a User.

• Work with User Roles or Groups.

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¶

• 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.

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.