Advanced Configuration¶

In addition to the com.siemens.polarion.rest.enabled and com.siemens.polarion.rest.swaggerUi.enabled properties that enable REST API and the Swagger UI, the following additional properties let you further customize the Polarion REST API. They are added to the polarion.properties file.

com.siemens.polarion.rest.cors.allowedOrigins¶

This property enables CORS (Cross-Origin Resource Sharing) access to all REST endpoints.

Supported Values¶

• Empty list CORS is disabled.

• * CORS requests from any host are allowed.

• Comma separated list of URI (schema://host:port) Only CORS requests from these origins are allowed.

(Standard ports - 80 for HTTP, 443 for HTTPS - should be omitted. For example, https://secured.host.name instead of https://secured.host.name:443)

com.siemens.polarion.rest.maxPageSize¶

This property sets the limit for the maximum page size that can be requested by a REST API client.

• The default value is 100.

• The absolute maximum page size is 10000. (Setting this property to a number larger than 10000 has no effect.)

com.siemens.polarion.rest.defaultPageSize¶

This property defines the default number of returned items for REST API endpoints.

• If defaultPageSize exceeds the maxPageSize (see above), the defaultPageSize value is replaced by the maxPageSize value.

• The default value is 100

com.siemens.polarion.rest.bodySizeLimit¶

This property limits the size of the request body in an HTTP request.

The limit is only valid for HTTP POST, HTTP PATCH, and HTTP DELETE requests with application/json content type.

The value is given as bytes.

com.siemens.polarion.rest.maxIncludedSize¶

This property specifies the number of results that are returned per page in the Included section for REST API endpoints. For more information, see Limit of included resources.

• If the number of entities exceeds the maxIncludedSize, they are not added to the Included section when requested.

• The default value of this property is 500 items, with a maximum limit of 10 000.

• If the provided value exceeds the 10 000 limit, it is capped.

com.siemens.polarion.rest.maxRelationshipSize¶

This property specifies the maximum number of entities that can be returned for each of the resource(s) relationship field(s). For more information, see Limit of included resources.

• If the number of entities exceeds the maxIncludedSize, they are not added to the Included section when requested.

• The default value of this property is 500 items, with a maximum limit of 10 000.

• If the provided value exceeds the 10 000 limit, it is capped.

Community

Connect and Collaborate with Industrial Professionals and Join the Community!