openapi: 3.0.1 info: contact: name: Polarion REST API Support url: https://support.sw.siemens.com/ description:

About

The Polarion REST API lets you interact with Polarion programmatically. Use this API to integrate Polarion with your applications. This page documents the REST resources, including the HTTP response codes and example requests and responses.

For a detailed description of the REST API and how to use it, see the REST API User Guide (available on Support Center). license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html title: Polarion REST Account Work Items API version: v1 servers: - url: https://example.com/polarion/rest/v1 security: - bearerAuth: [] tags: - name: Work Items paths: /all/workitems: delete: operationId: deleteAllWorkItems requestBody: content: application/json: schema: $ref: '#/components/schemas/workitemsListDeleteRequest' description: The Work Item(s) body. required: true responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '409': description: Conflict '413': description: Request Entity Too Large '415': description: Unsupported Media Type 4XX-5XX: content: application/json: schema: $ref: '#/components/schemas/errors' description: 'Error responses have the following structure:' '500': description: Internal Server Error '503': description: Service Unavailable summary: Deletes a list of Work Items from the Global context. tags: - Work Items get: operationId: getAllWorkItems parameters: - name: page[size] in: query description: Limit the number of entities returned in a single response. See REST API User Guide for details. schema: type: integer format: int32 - name: page[number] in: query description: Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details. schema: type: integer format: int32 - name: fields in: query description: Filter returned resource fields. See REST API User Guide for details. style: deepObject schema: $ref: '#/components/schemas/sparseFields' - name: include in: query description: Include related entities. See REST API User Guide for details. schema: type: string - name: query in: query description: The query string. schema: type: string - name: sort in: query description: The sort string. schema: type: string - name: revision in: query description: The revision ID. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/workitemsListGetResponse' description: OK '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '406': description: Not Acceptable 4XX-5XX: content: application/json: schema: $ref: '#/components/schemas/errors' description: 'Error responses have the following structure:' '500': description: Internal Server Error '503': description: Service Unavailable summary: Returns a list of Work Items from all Projects. tags: - Work Items patch: operationId: patchAllWorkItems parameters: - name: workflowAction in: query description: The Workflow Action. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/workitemsListPatchRequest' description: The Work Item(s) body. required: true responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '409': description: Conflict '413': description: Request Entity Too Large '415': description: Unsupported Media Type 4XX-5XX: content: application/json: schema: $ref: '#/components/schemas/errors' description: 'Error responses have the following structure:' '500': description: Internal Server Error '503': description: Service Unavailable summary: Updates a list of Work Items in the Global context. tags: - Work Items /projects/{projectId}/workitems: delete: operationId: deleteWorkItems parameters: - name: projectId in: path description: The Project ID. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/workitemsListDeleteRequest' description: The Work Item(s) body. required: true responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '409': description: Conflict '413': description: Request Entity Too Large '415': description: Unsupported Media Type 4XX-5XX: content: application/json: schema: $ref: '#/components/schemas/errors' description: 'Error responses have the following structure:' '500': description: Internal Server Error '503': description: Service Unavailable summary: Deletes a list of Work Items. tags: - Work Items get: operationId: getWorkItems parameters: - name: projectId in: path description: The Project ID. required: true schema: type: string - name: page[size] in: query description: Limit the number of entities returned in a single response. See REST API User Guide for details. schema: type: integer format: int32 - name: page[number] in: query description: Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details. schema: type: integer format: int32 - name: fields in: query description: Filter returned resource fields. See REST API User Guide for details. style: deepObject schema: $ref: '#/components/schemas/sparseFields' - name: include in: query description: Include related entities. See REST API User Guide for details. schema: type: string - name: query in: query description: The query string. schema: type: string - name: sort in: query description: The sort string. schema: type: string - name: revision in: query description: The revision ID. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/workitemsListGetResponse' description: OK '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '406': description: Not Acceptable 4XX-5XX: content: application/json: schema: $ref: '#/components/schemas/errors' description: 'Error responses have the following structure:' '500': description: Internal Server Error '503': description: Service Unavailable summary: Returns a list of Work Items. tags: - Work Items patch: operationId: patchWorkItems parameters: - name: projectId in: path description: The Project ID. required: true schema: type: string - name: workflowAction in: query description: The Workflow Action. schema: type: string - name: changeTypeTo in: query description: The Type the Workitem to change to. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/workitemsListPatchRequest' description: The Work Item(s) body. required: true responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '409': description: Conflict '413': description: Request Entity Too Large '415': description: Unsupported Media Type 4XX-5XX: content: application/json: schema: $ref: '#/components/schemas/errors' description: 'Error responses have the following structure:' '500': description: Internal Server Error '503': description: Service Unavailable summary: Updates a list of Work Items. tags: - Work Items post: operationId: postWorkItems parameters: - name: projectId in: path description: The Project ID. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/workitemsListPostRequest' description: The Work Item(s) body. required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/workitemsListPostResponse' description: Created '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '406': description: Not Acceptable '409': description: Conflict '413': description: Request Entity Too Large '415': description: Unsupported Media Type 4XX-5XX: content: application/json: schema: $ref: '#/components/schemas/errors' description: 'Error responses have the following structure:' '500': description: Internal Server Error '503': description: Service Unavailable summary: Creates a list of Work Items. tags: - Work Items /projects/{projectId}/workitems/{workItemId}: get: operationId: getWorkItem parameters: - name: projectId in: path description: The Project ID. required: true schema: type: string - name: workItemId in: path description: The Work Item ID. required: true schema: type: string - name: fields in: query description: Filter returned resource fields. See REST API User Guide for details. style: deepObject schema: $ref: '#/components/schemas/sparseFields' - name: include in: query description: Include related entities. See REST API User Guide for details. schema: type: string - name: revision in: query description: The revision ID. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/workitemsSingleGetResponse' description: OK '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '406': description: Not Acceptable 4XX-5XX: content: application/json: schema: $ref: '#/components/schemas/errors' description: 'Error responses have the following structure:' '500': description: Internal Server Error '503': description: Service Unavailable summary: Returns the specified Work Item. tags: - Work Items patch: operationId: patchWorkItem parameters: - name: projectId in: path description: The Project ID. required: true schema: type: string - name: workItemId in: path description: The Work Item ID. required: true schema: type: string - name: workflowAction in: query description: The Workflow Action. schema: type: string - name: changeTypeTo in: query description: The Type the Workitem to change to. schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/workitemsSinglePatchRequest' description: The Work Item body. required: true responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '409': description: Conflict '413': description: Request Entity Too Large '415': description: Unsupported Media Type 4XX-5XX: content: application/json: schema: $ref: '#/components/schemas/errors' description: 'Error responses have the following structure:' '500': description: Internal Server Error '503': description: Service Unavailable summary: Updates the specified Work Item. tags: - Work Items /projects/{projectId}/workitems/{workItemId}/actions/getWorkflowActions: get: operationId: getWorkflowActionsForWorkItem parameters: - name: projectId in: path description: The Project ID. required: true schema: type: string - name: workItemId in: path description: The Work Item ID. required: true schema: type: string - name: page[size] in: query description: Limit the number of entities returned in a single response. See REST API User Guide for details. schema: type: integer format: int32 - name: page[number] in: query description: Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details. schema: type: integer format: int32 - name: revision in: query description: The revision ID. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/workflowActionsActionResponseBody' description: OK '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '406': description: Not Acceptable 4XX-5XX: content: application/json: schema: $ref: '#/components/schemas/errors' description: 'Error responses have the following structure:' '500': description: Internal Server Error '503': description: Service Unavailable summary: Returns a list of Workflow Actions. tags: - Work Items /projects/{projectId}/workitems/{workItemId}/actions/moveFromDocument: post: operationId: moveFromDocument parameters: - name: projectId in: path description: The Project ID. required: true schema: type: string - name: workItemId in: path description: The Work Item ID. required: true schema: type: string responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found 4XX-5XX: content: application/json: schema: $ref: '#/components/schemas/errors' description: 'Error responses have the following structure:' '500': description: Internal Server Error '503': description: Service Unavailable summary: Moves the specified Work Item from the Document. tags: - Work Items /projects/{projectId}/workitems/{workItemId}/actions/moveToDocument: post: operationId: moveToDocument parameters: - name: projectId in: path description: The Project ID. required: true schema: type: string - name: workItemId in: path description: The Work Item ID. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/moveWorkItemToDocumentRequestBody' description: Moving Work Item to Document parameters. required: true responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '409': description: Conflict '413': description: Request Entity Too Large '415': description: Unsupported Media Type 4XX-5XX: content: application/json: schema: $ref: '#/components/schemas/errors' description: 'Error responses have the following structure:' '500': description: Internal Server Error '503': description: Service Unavailable summary: Moves the specified Work Item to the Document. tags: - Work Items /projects/{projectId}/workitems/{workItemId}/fields/{fieldId}/actions/getAvailableOptions: get: operationId: getAvailableEnumOptionsForWorkItem parameters: - name: projectId in: path description: The Project ID. required: true schema: type: string - name: workItemId in: path description: The Work Item ID. required: true schema: type: string - name: fieldId in: path description: The Field ID. required: true schema: type: string - name: page[size] in: query description: Limit the number of entities returned in a single response. See REST API User Guide for details. schema: type: integer format: int32 - name: page[number] in: query description: Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details. schema: type: integer format: int32 responses: '200': content: application/json: schema: $ref: '#/components/schemas/enumOptionsActionResponseBody' description: OK '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '406': description: Not Acceptable 4XX-5XX: content: application/json: schema: $ref: '#/components/schemas/errors' description: 'Error responses have the following structure:' '500': description: Internal Server Error '503': description: Service Unavailable summary: Returns a list of available options for the requested field for the specified Work Item. tags: - Work Items /projects/{projectId}/workitems/{workItemId}/fields/{fieldId}/actions/getCurrentOptions: get: operationId: getCurrentEnumOptionsForWorkItem parameters: - name: projectId in: path description: The Project ID. required: true schema: type: string - name: workItemId in: path description: The Work Item ID. required: true schema: type: string - name: fieldId in: path description: The Field ID. required: true schema: type: string - name: page[size] in: query description: Limit the number of entities returned in a single response. See REST API User Guide for details. schema: type: integer format: int32 - name: page[number] in: query description: Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details. schema: type: integer format: int32 - name: revision in: query description: The revision ID. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/enumOptionsActionResponseBody' description: OK '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '406': description: Not Acceptable 4XX-5XX: content: application/json: schema: $ref: '#/components/schemas/errors' description: 'Error responses have the following structure:' '500': description: Internal Server Error '503': description: Service Unavailable summary: Returns a list of selected options for the requested field for specific Work Item. tags: - Work Items /projects/{projectId}/workitems/{workItemId}/relationships/{relationshipId}: delete: operationId: deleteWorkItemsRelationship parameters: - name: projectId in: path description: The Project ID. required: true schema: type: string - name: workItemId in: path description: The Work Item ID. required: true schema: type: string - name: relationshipId in: path description: The Relationship ID. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/relationshipsListDeleteRequest' description: The Relationship body. required: true responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '405': description: Not Allowed '409': description: Conflict '413': description: Request Entity Too Large '415': description: Unsupported Media Type 4XX-5XX: content: application/json: schema: $ref: '#/components/schemas/errors' description: 'Error responses have the following structure:' '500': description: Internal Server Error '503': description: Service Unavailable summary: Deletes a list of Work Item Relationships. tags: - Work Items get: operationId: getWorkItemsRelationships parameters: - name: projectId in: path description: The Project ID. required: true schema: type: string - name: workItemId in: path description: The Work Item ID. required: true schema: type: string - name: relationshipId in: path description: The Relationship ID. required: true schema: type: string - name: page[size] in: query description: Limit the number of entities returned in a single response. See REST API User Guide for details. schema: type: integer format: int32 - name: page[number] in: query description: Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details. schema: type: integer format: int32 - name: fields in: query description: Filter returned resource fields. See REST API User Guide for details. style: deepObject schema: $ref: '#/components/schemas/sparseFields' - name: include in: query description: Include related entities. See REST API User Guide for details. schema: type: string - name: revision in: query description: The revision ID. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/RelationshipResponseBody' description: OK '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '406': description: Not Acceptable 4XX-5XX: content: application/json: schema: $ref: '#/components/schemas/errors' description: 'Error responses have the following structure:' '500': description: Internal Server Error '503': description: Service Unavailable summary: Returns a list of Work Item Relationships. tags: - Work Items patch: operationId: patchWorkItemRelationships parameters: - name: projectId in: path description: The Project ID. required: true schema: type: string - name: workItemId in: path description: The Work Item ID. required: true schema: type: string - name: relationshipId in: path description: The Relationship ID. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RelationshipsRequestBody' description: The Relationship body. required: true responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '409': description: Conflict '413': description: Request Entity Too Large '415': description: Unsupported Media Type 4XX-5XX: content: application/json: schema: $ref: '#/components/schemas/errors' description: 'Error responses have the following structure:' '500': description: Internal Server Error '503': description: Service Unavailable summary: Updates a list of Work Item Relationships. tags: - Work Items post: operationId: postWorkItemRelationships parameters: - name: projectId in: path description: The Project ID. required: true schema: type: string - name: workItemId in: path description: The Work Item ID. required: true schema: type: string - name: relationshipId in: path description: The Relationship ID. required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RelationshipsRequestBody' description: The Relationship body. required: true responses: '204': description: No Content '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '406': description: Not Acceptable '413': description: Request Entity Too Large '415': description: Unsupported Media Type 4XX-5XX: content: application/json: schema: $ref: '#/components/schemas/errors' description: 'Error responses have the following structure:' '500': description: Internal Server Error '503': description: Service Unavailable summary: Creates a list of Work Item Relationships. tags: - Work Items /projects/{projectId}/workitems/{workItemId}/testparameterdefinitions: get: operationId: getWorkItemTestParameterDefinitions parameters: - name: projectId in: path description: The Project ID. required: true schema: type: string - name: workItemId in: path description: The Work Item ID. required: true schema: type: string - name: page[size] in: query description: Limit the number of entities returned in a single response. See REST API User Guide for details. schema: type: integer format: int32 - name: page[number] in: query description: Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details. schema: type: integer format: int32 - name: fields in: query description: Filter returned resource fields. See REST API User Guide for details. style: deepObject schema: $ref: '#/components/schemas/sparseFields' - name: include in: query description: Include related entities. See REST API User Guide for details. schema: type: string - name: revision in: query description: The revision ID. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/testparameter_definitionsListGetResponse' description: OK '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '406': description: Not Acceptable 4XX-5XX: content: application/json: schema: $ref: '#/components/schemas/errors' description: 'Error responses have the following structure:' '500': description: Internal Server Error '503': description: Service Unavailable summary: Returns a list of Test Parameter Definitions for the specified Work Item. tags: - Work Items /projects/{projectId}/workitems/{workItemId}/testparameterdefinitions/{testParamId}: get: operationId: getWorkItemTestParameterDefinition parameters: - name: projectId in: path description: The Project ID. required: true schema: type: string - name: workItemId in: path description: The Work Item ID. required: true schema: type: string - name: testParamId in: path description: The Test Parameter. required: true schema: type: string - name: fields in: query description: Filter returned resource fields. See REST API User Guide for details. style: deepObject schema: $ref: '#/components/schemas/sparseFields' - name: include in: query description: Include related entities. See REST API User Guide for details. schema: type: string - name: revision in: query description: The revision ID. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/testparameter_definitionsSingleGetResponse' description: OK '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '406': description: Not Acceptable 4XX-5XX: content: application/json: schema: $ref: '#/components/schemas/errors' description: 'Error responses have the following structure:' '500': description: Internal Server Error '503': description: Service Unavailable summary: Returns the specified Test Parameter Definition for the specified Work Item. tags: - Work Items /projects/{projectId}/workitems/fields/{fieldId}/actions/getAvailableOptions: get: operationId: getAvailableEnumOptionsForWorkItemType parameters: - name: projectId in: path description: The Project ID. required: true schema: type: string - name: fieldId in: path description: The Field ID. required: true schema: type: string - name: page[size] in: query description: Limit the number of entities returned in a single response. See REST API User Guide for details. schema: type: integer format: int32 - name: page[number] in: query description: Specify the page number to be returned. Counting starts from 1. See REST API User Guide for details. schema: type: integer format: int32 - name: type in: query description: The Type of the object. Use '~' without quotes to represent no target Type. schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/enumOptionsActionResponseBody' description: OK '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found '406': description: Not Acceptable 4XX-5XX: content: application/json: schema: $ref: '#/components/schemas/errors' description: 'Error responses have the following structure:' '500': description: Internal Server Error '503': description: Service Unavailable summary: Returns a list of available options for the requested field for the specified Work Item Type. tags: - Work Items components: schemas: RelationshipDataBody: properties: id: example: MyProjectId/MyResourceId type: string type: enum: - collections - categories - documents - document_attachments - document_comments - document_parts - enumerations - globalroles - icons - jobs - linkedworkitems - externallylinkedworkitems - linkedoslcresources - pages - page_attachments - page_comments - plans - projectroles - projectgroups - projects - projecttemplates - spaces - testparameters - testparameter_definitions - testrecords - teststep_results - testruns - testrun_attachments - teststepresult_attachments - testrun_comments - usergroups - users - workitems - workitem_attachments - workitem_approvals - workitem_comments - featureselections - teststeps - workrecords - revisions - testrecord_attachments - license_slots - license_types - license - metadata - license_assignments - customfields type: string type: object workitemsListPatchRequest: properties: data: items: properties: type: enum: - workitems type: string id: example: MyProjectId/MyWorkItemId type: string attributes: properties: description: properties: type: enum: - text/html - text/plain type: string value: example: My text value type: string type: object dueDate: example: '1970-01-01' format: date type: string hyperlinks: items: properties: role: example: ref_ext type: string title: example: Title type: string uri: example: https://polarion.plm.automation.siemens.com type: string type: object type: array initialEstimate: example: 5 1/2d type: string priority: example: '90.0' type: string remainingEstimate: example: 5 1/2d type: string resolution: example: done type: string resolvedOn: example: '1970-01-01T00:00:00Z' format: date-time type: string severity: example: blocker type: string status: example: open type: string timeSpent: example: 5 1/2d type: string title: example: Title type: string type: object relationships: properties: assignee: properties: data: items: properties: id: example: MyUserId type: string type: enum: - users type: string type: object type: array type: object categories: properties: data: items: properties: id: example: MyProjectId/MyCategoryId type: string type: enum: - categories type: string type: object type: array type: object linkedRevisions: properties: data: items: properties: id: example: default/1234 type: string type: enum: - revisions type: string type: object type: array type: object votes: properties: data: items: properties: id: example: MyUserId type: string type: enum: - users type: string type: object type: array type: object watches: properties: data: items: properties: id: example: MyUserId type: string type: enum: - users type: string type: object type: array type: object type: object type: object type: array type: object RelationshipDataListRequest: properties: data: items: $ref: '#/components/schemas/RelationshipDataBody' type: array type: object RelationshipResponseBody: description: The Relationship's response body. Can return a single or a list of instances example: data: - type: MyResourceType id: MyProjectId/MyResourceId oneOf: - $ref: '#/components/schemas/RelationshipDataSingleResponse' - $ref: '#/components/schemas/RelationshipDataListResponse' type: object testparameter_definitionsSingleGetResponse: properties: data: properties: type: enum: - testparameter_definitions type: string id: example: MyProjectId/MyTestParamDefinition type: string revision: example: '1234' type: string attributes: properties: name: example: Test Parameter Definition example type: string type: object links: properties: self: example: server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition type: string type: object meta: properties: errors: items: properties: detail: description: Human-readable explanation specific to this occurrence of the problem. example: 'Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)' type: string source: properties: parameter: description: String indicating which URI query parameter caused the error. example: revision type: string pointer: description: JSON Pointer to the associated entity in the request document. example: $.data type: string resource: description: Resource causing the error. properties: id: example: MyProjectId/id type: string type: example: type type: string type: object type: object status: description: HTTP status code applicable to this problem. example: '400' type: string title: description: Short, human-readable summary of the problem. example: Bad Request type: string type: object type: array type: object type: object included: description: Related entities might be returned, see REST API User Guide. items: type: object type: array links: properties: self: example: server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition type: string type: object type: object workitemsListGetResponse: properties: data: items: properties: type: enum: - workitems type: string id: example: MyProjectId/MyWorkItemId type: string revision: example: '1234' type: string attributes: properties: created: example: '1970-01-01T00:00:00Z' format: date-time type: string description: properties: type: enum: - text/html - text/plain type: string value: example: My text value type: string type: object dueDate: example: '1970-01-01' format: date type: string hyperlinks: items: properties: role: example: ref_ext type: string title: example: Title type: string uri: example: https://polarion.plm.automation.siemens.com type: string type: object type: array id: example: MyWorkItemId type: string initialEstimate: example: 5 1/2d type: string outlineNumber: example: '1.11' type: string plannedEnd: example: '1970-01-01T00:00:00Z' format: date-time type: string plannedStart: example: '1970-01-01T00:00:00Z' format: date-time type: string priority: example: '90.0' type: string remainingEstimate: example: 5 1/2d type: string resolution: example: done type: string resolvedOn: example: '1970-01-01T00:00:00Z' format: date-time type: string severity: example: blocker type: string status: example: open type: string timeSpent: example: 5 1/2d type: string title: example: Title type: string type: example: task type: string updated: example: '1970-01-01T00:00:00Z' format: date-time type: string type: object relationships: properties: approvals: properties: data: items: properties: id: example: MyProjectId/MyWorkItemId/MyUserId type: string revision: example: '1234' type: string type: enum: - workitem_approvals type: string type: object type: array meta: properties: totalCount: format: int32 type: integer type: object type: object assignee: properties: data: items: properties: id: example: MyUserId type: string revision: example: '1234' type: string type: enum: - users type: string type: object type: array meta: properties: totalCount: format: int32 type: integer type: object type: object attachments: properties: data: items: properties: id: example: MyProjectId/MyWorkItemId/MyAttachmentId type: string revision: example: '1234' type: string type: enum: - workitem_attachments type: string type: object type: array links: properties: related: example: server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments?revision=1234 type: string type: object meta: properties: totalCount: format: int32 type: integer type: object type: object author: properties: data: properties: id: example: MyUserId type: string revision: example: '1234' type: string type: enum: - users type: string type: object type: object backlinkedWorkItems: properties: data: items: properties: id: example: MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId type: string revision: example: '1234' type: string type: enum: - linkedworkitems type: string type: object type: array meta: properties: totalCount: format: int32 type: integer type: object type: object categories: properties: data: items: properties: id: example: MyProjectId/MyCategoryId type: string revision: example: '1234' type: string type: enum: - categories type: string type: object type: array meta: properties: totalCount: format: int32 type: integer type: object type: object comments: properties: data: items: properties: id: example: MyProjectId/MyWorkItemId/MyCommentId type: string revision: example: '1234' type: string type: enum: - workitem_comments type: string type: object type: array links: properties: related: example: server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments?revision=1234 type: string type: object meta: properties: totalCount: format: int32 type: integer type: object type: object externallyLinkedWorkItems: properties: data: items: properties: id: example: MyProjectId/MyWorkItemId/parent/hostname/MyProjectId/MyLinkedWorkItemId type: string revision: example: '1234' type: string type: enum: - externallylinkedworkitems type: string type: object type: array meta: properties: totalCount: format: int32 type: integer type: object type: object linkedOslcResources: properties: data: items: properties: id: example: MyProjectId/MyWorkItemId/http://server-host-name/ns/cm#relatedChangeRequest/http://server-host-name/application-path/oslc/services/projects/MyProjectId/workitems/MyWorkItemId type: string revision: example: '1234' type: string type: enum: - linkedoslcresources type: string type: object type: array meta: properties: totalCount: format: int32 type: integer type: object type: object linkedRevisions: properties: data: items: properties: id: example: default/1234 type: string revision: example: '1234' type: string type: enum: - revisions type: string type: object type: array meta: properties: totalCount: format: int32 type: integer type: object type: object linkedWorkItems: properties: data: items: properties: id: example: MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId type: string revision: example: '1234' type: string type: enum: - linkedworkitems type: string type: object type: array links: properties: related: example: server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems?revision=1234 type: string type: object meta: properties: totalCount: format: int32 type: integer type: object type: object module: properties: data: properties: id: example: MyProjectId/MySpaceId/MyDocumentId type: string revision: example: '1234' type: string type: enum: - documents type: string type: object type: object plannedIn: properties: data: items: properties: id: example: MyProjectId/MyPlanId type: string revision: example: '1234' type: string type: enum: - plans type: string type: object type: array meta: properties: totalCount: format: int32 type: integer type: object type: object project: properties: data: properties: id: example: MyProjectId type: string revision: example: '1234' type: string type: enum: - projects type: string type: object type: object testSteps: properties: data: items: properties: id: example: MyProjectId/MyWorkItemId/MyTestStepIndex type: string revision: example: '1234' type: string type: enum: - teststeps type: string type: object type: array meta: properties: totalCount: format: int32 type: integer type: object type: object votes: properties: data: items: properties: id: example: MyUserId type: string revision: example: '1234' type: string type: enum: - users type: string type: object type: array meta: properties: totalCount: format: int32 type: integer type: object type: object watches: properties: data: items: properties: id: example: MyUserId type: string revision: example: '1234' type: string type: enum: - users type: string type: object type: array meta: properties: totalCount: format: int32 type: integer type: object type: object workRecords: properties: data: items: properties: id: example: MyProjectId/MyWorkItemId/MyWorkRecordId type: string revision: example: '1234' type: string type: enum: - workrecords type: string type: object type: array meta: properties: totalCount: format: int32 type: integer type: object type: object type: object links: properties: portal: example: server-host-name/application-path/polarion/redirect/project/MyProjectId/workitem?id=MyWorkItemId&revision=1234 type: string self: example: server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId?revision=1234 type: string type: object meta: properties: errors: items: properties: detail: description: Human-readable explanation specific to this occurrence of the problem. example: 'Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)' type: string source: properties: parameter: description: String indicating which URI query parameter caused the error. example: revision type: string pointer: description: JSON Pointer to the associated entity in the request document. example: $.data type: string resource: description: Resource causing the error. properties: id: example: MyProjectId/id type: string type: example: type type: string type: object type: object status: description: HTTP status code applicable to this problem. example: '400' type: string title: description: Short, human-readable summary of the problem. example: Bad Request type: string type: object type: array type: object type: object type: array included: description: Related entities might be returned, see REST API User Guide. items: type: object type: array links: properties: first: example: server-host-name/application-path/projects/MyProjectId/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=1 type: string last: example: server-host-name/application-path/projects/MyProjectId/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=9 type: string next: example: server-host-name/application-path/projects/MyProjectId/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=6 type: string portal: example: server-host-name/application-path/polarion/redirect/project/MyProjectId/workitems type: string prev: example: server-host-name/application-path/projects/MyProjectId/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=4 type: string self: example: server-host-name/application-path/projects/MyProjectId/workitems?page%5Bsize%5D=10&page%5Bnumber%5D=5 type: string type: object meta: properties: totalCount: format: int32 type: integer type: object type: object moveWorkItemToDocumentRequestBody: properties: nextPart: example: MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId type: string previousPart: example: MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId type: string targetDocument: example: MyProjectId/MySpaceId/MyDocumentId type: string type: object RelationshipDataSingleResponse: properties: data: $ref: '#/components/schemas/RelationshipDataBody' type: object RelationshipsRequestBody: description: List of generic contents example: data: - type: MyResourceType id: MyProjectId/MyResourceId oneOf: - $ref: '#/components/schemas/RelationshipDataSingleRequest' - $ref: '#/components/schemas/RelationshipDataListRequest' type: object workitemsListPostRequest: properties: data: items: properties: type: enum: - workitems type: string attributes: properties: description: properties: type: enum: - text/html - text/plain type: string value: example: My text value type: string type: object dueDate: example: '1970-01-01' format: date type: string hyperlinks: items: properties: role: example: ref_ext type: string title: example: Title type: string uri: example: https://polarion.plm.automation.siemens.com type: string type: object type: array initialEstimate: example: 5 1/2d type: string priority: example: '90.0' type: string remainingEstimate: example: 5 1/2d type: string resolution: example: done type: string resolvedOn: example: '1970-01-01T00:00:00Z' format: date-time type: string severity: example: blocker type: string status: example: open type: string timeSpent: example: 5 1/2d type: string title: example: Title type: string type: example: task type: string required: - type type: object relationships: properties: assignee: properties: data: items: properties: id: example: MyUserId type: string type: enum: - users type: string type: object type: array type: object author: properties: data: properties: id: example: MyUserId type: string type: enum: - users type: string type: object type: object categories: properties: data: items: properties: id: example: MyProjectId/MyCategoryId type: string type: enum: - categories type: string type: object type: array type: object linkedRevisions: properties: data: items: properties: id: example: default/1234 type: string type: enum: - revisions type: string type: object type: array type: object module: properties: data: properties: id: example: MyProjectId/MySpaceId/MyDocumentId type: string type: enum: - documents type: string type: object type: object type: object type: object type: array type: object sparseFields: properties: categories: description: Requested fields example: '@all' type: string collections: description: Requested fields example: '@all' type: string customfields: description: Requested fields example: '@all' type: string document_attachments: description: Requested fields example: '@all' type: string document_comments: description: Requested fields example: '@all' type: string document_parts: description: Requested fields example: '@all' type: string documents: description: Requested fields example: '@all' type: string enumerations: description: Requested fields example: '@all' type: string externallylinkedworkitems: description: Requested fields example: '@all' type: string featureselections: description: Requested fields example: '@all' type: string globalroles: description: Requested fields example: '@all' type: string icons: description: Requested fields example: '@all' type: string jobs: description: Requested fields example: '@all' type: string license: description: Requested fields example: '@all' type: string license_assignments: description: Requested fields example: '@all' type: string license_slots: description: Requested fields example: '@all' type: string license_types: description: Requested fields example: '@all' type: string linkedoslcresources: description: Requested fields example: '@all' type: string linkedworkitems: description: Requested fields example: '@all' type: string metadata: description: Requested fields example: '@all' type: string page_attachments: description: Requested fields example: '@all' type: string page_comments: description: Requested fields example: '@all' type: string pages: description: Requested fields example: '@all' type: string plans: description: Requested fields example: '@all' type: string projectroles: description: Requested fields example: '@all' type: string projects: description: Requested fields example: '@all' type: string projecttemplates: description: Requested fields example: '@all' type: string revisions: description: Requested fields example: '@all' type: string testparameter_definitions: description: Requested fields example: '@all' type: string testparameters: description: Requested fields example: '@all' type: string testrecord_attachments: description: Requested fields example: '@all' type: string testrecords: description: Requested fields example: '@all' type: string testrun_attachments: description: Requested fields example: '@all' type: string testrun_comments: description: Requested fields example: '@all' type: string testruns: description: Requested fields example: '@all' type: string teststep_results: description: Requested fields example: '@all' type: string teststepresult_attachments: description: Requested fields example: '@all' type: string teststeps: description: Requested fields example: '@all' type: string usergroups: description: Requested fields example: '@all' type: string users: description: Requested fields example: '@all' type: string workitem_approvals: description: Requested fields example: '@all' type: string workitem_attachments: description: Requested fields example: '@all' type: string workitem_comments: description: Requested fields example: '@all' type: string workitems: description: Requested fields example: '@all' type: string workrecords: description: Requested fields example: '@all' type: string type: object RelationshipDataSingleRequest: properties: data: $ref: '#/components/schemas/RelationshipDataBody' type: object workitemsSinglePatchRequest: properties: data: properties: type: enum: - workitems type: string id: example: MyProjectId/MyWorkItemId type: string attributes: properties: description: properties: type: enum: - text/html - text/plain type: string value: example: My text value type: string type: object dueDate: example: '1970-01-01' format: date type: string hyperlinks: items: properties: role: example: ref_ext type: string title: example: Title type: string uri: example: https://polarion.plm.automation.siemens.com type: string type: object type: array initialEstimate: example: 5 1/2d type: string priority: example: '90.0' type: string remainingEstimate: example: 5 1/2d type: string resolution: example: done type: string resolvedOn: example: '1970-01-01T00:00:00Z' format: date-time type: string severity: example: blocker type: string status: example: open type: string timeSpent: example: 5 1/2d type: string title: example: Title type: string type: object relationships: properties: assignee: properties: data: items: properties: id: example: MyUserId type: string type: enum: - users type: string type: object type: array type: object categories: properties: data: items: properties: id: example: MyProjectId/MyCategoryId type: string type: enum: - categories type: string type: object type: array type: object linkedRevisions: properties: data: items: properties: id: example: default/1234 type: string type: enum: - revisions type: string type: object type: array type: object votes: properties: data: items: properties: id: example: MyUserId type: string type: enum: - users type: string type: object type: array type: object watches: properties: data: items: properties: id: example: MyUserId type: string type: enum: - users type: string type: object type: array type: object type: object type: object type: object workitemsListDeleteRequest: properties: data: items: properties: type: enum: - workitems type: string id: example: MyProjectId/MyWorkItemId type: string type: object type: array type: object workitemsListPostResponse: properties: data: items: properties: type: enum: - workitems type: string id: example: MyProjectId/MyWorkItemId type: string links: properties: portal: example: server-host-name/application-path/polarion/redirect/project/MyProjectId/workitem?id=MyWorkItemId&revision=1234 type: string self: example: server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId?revision=1234 type: string type: object type: object type: array type: object errors: properties: errors: items: properties: status: description: HTTP status code applicable to this problem. example: '400' type: string title: description: Short, human-readable summary of the problem. example: Bad Request type: string detail: description: Human-readable explanation specific to this occurrence of the problem. example: 'Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)' type: string source: properties: parameter: description: String indicating which URI query parameter caused the error. example: revision type: string pointer: description: JSON Pointer to the associated entity in the request document. example: $.data type: string resource: description: Resource causing the error. properties: id: example: MyProjectId/id type: string type: example: type type: string type: object type: object type: object type: array type: object enumOptionsActionResponseBody: properties: data: items: properties: id: example: open type: string color: example: '#F9FF4D' type: string columnWidth: example: 90% type: string createDefect: example: true type: boolean default: example: true type: boolean description: example: Description type: string hidden: example: false type: boolean iconURL: example: /polarion/icons/default/enums/status_open.gif type: string limited: example: true type: boolean minValue: example: 30.0 type: number name: example: Open type: string oppositeName: example: Opposite Name type: string parent: example: true type: boolean requiresSignatureForTestCaseExecution: example: true type: boolean templateWorkItem: example: exampleTemplate type: string terminal: example: true type: boolean type: object type: array links: properties: first: example: server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=1 type: string last: example: server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=9 type: string next: example: server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=6 type: string prev: example: server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bnumber%5D=4 type: string self: example: server-host-name/application-path/projects/MyProjectId/.../fields/MyField/actions/actionName?page%5Bsize%5D=10&page%5Bnumber%5D=5 type: string type: object meta: properties: totalCount: format: int32 type: integer type: object type: object testparameter_definitionsListGetResponse: properties: data: items: properties: type: enum: - testparameter_definitions type: string id: example: MyProjectId/MyTestParamDefinition type: string revision: example: '1234' type: string attributes: properties: name: example: Test Parameter Definition example type: string type: object links: properties: self: example: server-host-name/application-path/projects/MyProjectId/testparameterdefinitions/MyTestParamDefinition type: string type: object meta: properties: errors: items: properties: detail: description: Human-readable explanation specific to this occurrence of the problem. example: 'Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)' type: string source: properties: parameter: description: String indicating which URI query parameter caused the error. example: revision type: string pointer: description: JSON Pointer to the associated entity in the request document. example: $.data type: string resource: description: Resource causing the error. properties: id: example: MyProjectId/id type: string type: example: type type: string type: object type: object status: description: HTTP status code applicable to this problem. example: '400' type: string title: description: Short, human-readable summary of the problem. example: Bad Request type: string type: object type: array type: object type: object type: array included: description: Related entities might be returned, see REST API User Guide. items: type: object type: array links: properties: first: example: server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=1 type: string last: example: server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=9 type: string next: example: server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=6 type: string prev: example: server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=4 type: string self: example: server-host-name/application-path/projects/MyProjectId/testparameterdefinitions?page%5Bsize%5D=10&page%5Bnumber%5D=5 type: string type: object meta: properties: totalCount: format: int32 type: integer type: object type: object workflowActionsActionResponseBody: properties: data: items: properties: id: example: '0' type: string available: type: boolean clearedFields: items: type: string type: array isAddingSignature: type: boolean isSignatureRequired: type: boolean name: example: actionName type: string nativeActionId: example: nativeActionId type: string requiredFields: items: type: string type: array requiredRoles: items: type: string type: array targetStatus: example: done type: string unavailableReason: type: string type: object type: array links: properties: first: example: server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=1 type: string last: example: server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=9 type: string next: example: server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=6 type: string prev: example: server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bnumber%5D=4 type: string self: example: server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/actions/getWorkflowActions?page%5Bsize%5D=10&page%5Bnumber%5D=5 type: string type: object meta: properties: totalCount: format: int32 type: integer type: object type: object RelationshipDataListResponse: properties: data: items: $ref: '#/components/schemas/RelationshipDataBody' type: array type: object relationshipsListDeleteRequest: properties: data: items: properties: type: enum: - collections - categories - documents - document_attachments - document_comments - document_parts - enumerations - globalroles - icons - jobs - linkedworkitems - externallylinkedworkitems - linkedoslcresources - pages - page_attachments - page_comments - plans - projectroles - projectgroups - projects - projecttemplates - spaces - testparameters - testparameter_definitions - testrecords - teststep_results - testruns - testrun_attachments - teststepresult_attachments - testrun_comments - usergroups - users - workitems - workitem_attachments - workitem_approvals - workitem_comments - featureselections - teststeps - workrecords - revisions - testrecord_attachments - license_slots - license_types - license - metadata - license_assignments - customfields type: string id: example: MyProjectId/MyResourceId type: string type: object type: array type: object workitemsSingleGetResponse: properties: data: properties: type: enum: - workitems type: string id: example: MyProjectId/MyWorkItemId type: string revision: example: '1234' type: string attributes: properties: created: example: '1970-01-01T00:00:00Z' format: date-time type: string description: properties: type: enum: - text/html - text/plain type: string value: example: My text value type: string type: object dueDate: example: '1970-01-01' format: date type: string hyperlinks: items: properties: role: example: ref_ext type: string title: example: Title type: string uri: example: https://polarion.plm.automation.siemens.com type: string type: object type: array id: example: MyWorkItemId type: string initialEstimate: example: 5 1/2d type: string outlineNumber: example: '1.11' type: string plannedEnd: example: '1970-01-01T00:00:00Z' format: date-time type: string plannedStart: example: '1970-01-01T00:00:00Z' format: date-time type: string priority: example: '90.0' type: string remainingEstimate: example: 5 1/2d type: string resolution: example: done type: string resolvedOn: example: '1970-01-01T00:00:00Z' format: date-time type: string severity: example: blocker type: string status: example: open type: string timeSpent: example: 5 1/2d type: string title: example: Title type: string type: example: task type: string updated: example: '1970-01-01T00:00:00Z' format: date-time type: string type: object relationships: properties: approvals: properties: data: items: properties: id: example: MyProjectId/MyWorkItemId/MyUserId type: string revision: example: '1234' type: string type: enum: - workitem_approvals type: string type: object type: array meta: properties: totalCount: format: int32 type: integer type: object type: object assignee: properties: data: items: properties: id: example: MyUserId type: string revision: example: '1234' type: string type: enum: - users type: string type: object type: array meta: properties: totalCount: format: int32 type: integer type: object type: object attachments: properties: data: items: properties: id: example: MyProjectId/MyWorkItemId/MyAttachmentId type: string revision: example: '1234' type: string type: enum: - workitem_attachments type: string type: object type: array links: properties: related: example: server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/attachments?revision=1234 type: string type: object meta: properties: totalCount: format: int32 type: integer type: object type: object author: properties: data: properties: id: example: MyUserId type: string revision: example: '1234' type: string type: enum: - users type: string type: object type: object backlinkedWorkItems: properties: data: items: properties: id: example: MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId type: string revision: example: '1234' type: string type: enum: - linkedworkitems type: string type: object type: array meta: properties: totalCount: format: int32 type: integer type: object type: object categories: properties: data: items: properties: id: example: MyProjectId/MyCategoryId type: string revision: example: '1234' type: string type: enum: - categories type: string type: object type: array meta: properties: totalCount: format: int32 type: integer type: object type: object comments: properties: data: items: properties: id: example: MyProjectId/MyWorkItemId/MyCommentId type: string revision: example: '1234' type: string type: enum: - workitem_comments type: string type: object type: array links: properties: related: example: server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/comments?revision=1234 type: string type: object meta: properties: totalCount: format: int32 type: integer type: object type: object externallyLinkedWorkItems: properties: data: items: properties: id: example: MyProjectId/MyWorkItemId/parent/hostname/MyProjectId/MyLinkedWorkItemId type: string revision: example: '1234' type: string type: enum: - externallylinkedworkitems type: string type: object type: array meta: properties: totalCount: format: int32 type: integer type: object type: object linkedOslcResources: properties: data: items: properties: id: example: MyProjectId/MyWorkItemId/http://server-host-name/ns/cm#relatedChangeRequest/http://server-host-name/application-path/oslc/services/projects/MyProjectId/workitems/MyWorkItemId type: string revision: example: '1234' type: string type: enum: - linkedoslcresources type: string type: object type: array meta: properties: totalCount: format: int32 type: integer type: object type: object linkedRevisions: properties: data: items: properties: id: example: default/1234 type: string revision: example: '1234' type: string type: enum: - revisions type: string type: object type: array meta: properties: totalCount: format: int32 type: integer type: object type: object linkedWorkItems: properties: data: items: properties: id: example: MyProjectId/MyWorkItemId/parent/MyProjectId/MyLinkedWorkItemId type: string revision: example: '1234' type: string type: enum: - linkedworkitems type: string type: object type: array links: properties: related: example: server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId/linkedworkitems?revision=1234 type: string type: object meta: properties: totalCount: format: int32 type: integer type: object type: object module: properties: data: properties: id: example: MyProjectId/MySpaceId/MyDocumentId type: string revision: example: '1234' type: string type: enum: - documents type: string type: object type: object plannedIn: properties: data: items: properties: id: example: MyProjectId/MyPlanId type: string revision: example: '1234' type: string type: enum: - plans type: string type: object type: array meta: properties: totalCount: format: int32 type: integer type: object type: object project: properties: data: properties: id: example: MyProjectId type: string revision: example: '1234' type: string type: enum: - projects type: string type: object type: object testSteps: properties: data: items: properties: id: example: MyProjectId/MyWorkItemId/MyTestStepIndex type: string revision: example: '1234' type: string type: enum: - teststeps type: string type: object type: array meta: properties: totalCount: format: int32 type: integer type: object type: object votes: properties: data: items: properties: id: example: MyUserId type: string revision: example: '1234' type: string type: enum: - users type: string type: object type: array meta: properties: totalCount: format: int32 type: integer type: object type: object watches: properties: data: items: properties: id: example: MyUserId type: string revision: example: '1234' type: string type: enum: - users type: string type: object type: array meta: properties: totalCount: format: int32 type: integer type: object type: object workRecords: properties: data: items: properties: id: example: MyProjectId/MyWorkItemId/MyWorkRecordId type: string revision: example: '1234' type: string type: enum: - workrecords type: string type: object type: array meta: properties: totalCount: format: int32 type: integer type: object type: object type: object links: properties: portal: example: server-host-name/application-path/polarion/redirect/project/MyProjectId/workitem?id=MyWorkItemId&revision=1234 type: string self: example: server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId?revision=1234 type: string type: object meta: properties: errors: items: properties: detail: description: Human-readable explanation specific to this occurrence of the problem. example: 'Unexpected token, BEGIN_ARRAY expected, but was : BEGIN_OBJECT (at $.data)' type: string source: properties: parameter: description: String indicating which URI query parameter caused the error. example: revision type: string pointer: description: JSON Pointer to the associated entity in the request document. example: $.data type: string resource: description: Resource causing the error. properties: id: example: MyProjectId/id type: string type: example: type type: string type: object type: object status: description: HTTP status code applicable to this problem. example: '400' type: string title: description: Short, human-readable summary of the problem. example: Bad Request type: string type: object type: array type: object type: object included: description: Related entities might be returned, see REST API User Guide. items: type: object type: array links: properties: self: example: server-host-name/application-path/projects/MyProjectId/workitems/MyWorkItemId?revision=1234 type: string type: object type: object securitySchemes: bearerAuth: bearerFormat: JWT scheme: bearer type: http