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

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

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

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

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

Baselines¶

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

• Support Project, Collection, and Document Baselines.

Build Management¶

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

Categories¶

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

Custom Fields¶

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

Documents¶

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

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

• 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,
  • Documents & Pages,
  • Project Groups,
  • Time Points,
  • Wiki Pages.

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

  • For example, for Link Role Enumeration, the Rules for Link role section.

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

• Support for the Rules section of the Link Role enumeration.

• Management of the Dependent Enumerations.

Icons¶

• Replace or delete an icon.

Jobs¶

• Get a list of all Jobs.

• Execute a Job.

• Access to the Job logs.

Licensing¶

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

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

• Get all Attachments of a Page.

• Manage Page Attachments.

• Work with Page Comments and Watches.

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.

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

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

• Provide information about the current user.

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

• Support posting of Backlinked 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.

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.