The chat responses are generated using Generative AI technology for intuitive search and may not be entirely accurate. They are not intended as professional advice. For full details, including our use rights, privacy practices and potential export control restrictions, please refer to our Generative AI Service Terms of Use and Generative AI Service Privacy Information. As this is a test version, please let us know if something irritating comes up. Like you get recommended a chocolate fudge ice cream instead of an energy managing application. If that occurs, please use the feedback button in our contact form!
Skip to content
Siemens Xcelerator Marketplace
Polarion

The Polarion REST API gives external applications an integration layer with Polarion that gives you greater control over the information you use in both Polarion and the applications you use daily.

Access REST API¶

If you enabled the REST API you can access it with the following root URL.

https://[Your_Polarion_server]/polarion/rest/v1

If you also enabled the Swagger UI you can view it in a web browser at the following URL.

https://[Your_Polarion_server]/polarion/rest/v1

Polarion's Swagger UI

URI Structure¶

Polarion's REST API lets you access resources (data entities) via URI paths.

To the REST API, your application makes an HTTP request and parses the response.

The URI structure for Polarion REST API resources is as follows:

https://[Your_Polarion_server]/polarion/rest/[api-version]/[endpoint_URL_part]?[URL_parameters]

Example

  • https://myhost/polarion/rest/v1/projects/myProject/workitems/WI-123?revision=5
  • The URI is influenced by whatever is in the base.url property of the polarion.properties file on your Polarion server.

REST API Versioning¶

It's easy to determine the REST API version number because it is right in the URI: (v1 in the example below.)

Example

https://myhost/polarion/rest/v1/projects

The REST API is backward compatible, so any implementation you deploy from a previous version will work whether or not you choose to update to a newer version.

New versions will only be released when significant changes (like the addition of renaming and removing are added).

There may be additional patch updates or minor changes, but they will not affect existing implementations.

REST API in a Cluster setup¶

A Clustered setup is a group of Polarion servers (application nodes) that access a single instance of shared data.

(See the Deployment and Maintenance Guide for more information.)

When using REST API in a Clustered setup:

  • Use the Load Balancer URL (the default base URL) to access the REST API.

    (Requests should not be sent directly to individual nodes.)

  • If you want to access the Swagger UI (if enabled), you should also use the base.url.

  • REST API response links always point to the Load Balancer URL (base URL), regardless of the node that processes the request.

Notes¶

  • Polarion properties related to the REST API should be configured on the Shared Services server machine.

    (In the polarion.properties file shared with nodes.)

  • There is no need to safelist the nodes in a Cluster environment with the com.siemens.polarion.rest.cors.allowedOrigins property. (They are allowed by design.)

  • Updating the same resource in rapid succession may result in a conflict error because the calls end on other nodes are not propagating fast enough. (Propagation changes only occur every three seconds and are not configurable.)

Explore

Community

Siemens.com Global
Contact us
© Siemens 1996 - 2024