openapi: 3.0.1
info:
  contact:
    name: Polarion REST API Support
    url: https://support.sw.siemens.com/
  description: <h5>About</h5>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. <br/><br/>For a detailed description of the REST API and how to use it, see the <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a> (available on Support Center).
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  title: Polarion REST Account Documents API
  version: v1
servers:
- url: https://example.com/polarion/rest/v1
security:
- bearerAuth: []
tags:
- name: Documents
paths:
  /all/documents:
    get:
      operationId: getAllDocuments
      parameters:
      - name: page[size]
        in: query
        description: Limit the number of entities returned in a single response. See <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a> 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 <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a> for details.
        schema:
          type: integer
          format: int32
      - name: fields
        in: query
        description: Filter returned resource fields. See <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a> for details.
        style: deepObject
        schema:
          $ref: '#/components/schemas/sparseFields'
      - name: include
        in: query
        description: Include related entities. See <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a> 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/documentsListGetResponse'
          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 Documents from all Projects.
      tags:
      - Documents
  /all/documents/actions/branch:
    post:
      operationId: branchDocuments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/branchDocumentsRequestBody'
        description: Branching parameters.
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/jobsSinglePostResponse'
          description: Accepted
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '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 Branches of Documents.
      tags:
      - Documents
  /projects/{projectId}/documents:
    get:
      operationId: getDocuments
      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 <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a> 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 <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a> for details.
        schema:
          type: integer
          format: int32
      - name: fields
        in: query
        description: Filter returned resource fields. See <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a> for details.
        style: deepObject
        schema:
          $ref: '#/components/schemas/sparseFields'
      - name: include
        in: query
        description: Include related entities. See <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a> 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/documentsListGetResponse'
          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 Documents from the Project context.
      tags:
      - Documents
  /projects/{projectId}/documents/fields/{fieldId}/actions/getAvailableOptions:
    get:
      operationId: getAvailableEnumOptionsForDocumentType
      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 <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a> 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 <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a> 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 Document type.
      tags:
      - Documents
  /projects/{projectId}/spaces/{spaceId}/documents:
    get:
      operationId: getSpaceDocuments
      parameters:
      - name: projectId
        in: path
        description: The Project ID.
        required: true
        schema:
          type: string
      - name: spaceId
        in: path
        description: The Space ID. (Use '_default' without quotes to address the default Space.)
        required: true
        schema:
          type: string
      - name: page[size]
        in: query
        description: Limit the number of entities returned in a single response. See <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a> 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 <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a> for details.
        schema:
          type: integer
          format: int32
      - name: fields
        in: query
        description: Filter returned resource fields. See <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a> for details.
        style: deepObject
        schema:
          $ref: '#/components/schemas/sparseFields'
      - name: include
        in: query
        description: Include related entities. See <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a> 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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documentsListGetResponse'
          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 Documents from a given Project Space.
      tags:
      - Documents
    post:
      operationId: postDocuments
      parameters:
      - name: projectId
        in: path
        description: The Project ID.
        required: true
        schema:
          type: string
      - name: spaceId
        in: path
        description: The Space ID. (Use '_default' without quotes to address the default Space.)
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documentsListPostRequest'
        description: The Document body.
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documentsListPostResponse'
          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 Documents.
      tags:
      - Documents
  /projects/{projectId}/spaces/{spaceId}/documents/{documentName}:
    get:
      operationId: getDocument
      parameters:
      - name: projectId
        in: path
        description: The Project ID.
        required: true
        schema:
          type: string
      - name: spaceId
        in: path
        description: The Space ID. (Use '_default' without quotes to address the default Space.)
        required: true
        schema:
          type: string
      - name: documentName
        in: path
        description: The Document name.
        required: true
        schema:
          type: string
      - name: fields
        in: query
        description: Filter returned resource fields. See <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a> for details.
        style: deepObject
        schema:
          $ref: '#/components/schemas/sparseFields'
      - name: include
        in: query
        description: Include related entities. See <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a> 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/documentsSingleGetResponse'
          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 Document.
      tags:
      - Documents
    patch:
      operationId: patchDocument
      parameters:
      - name: projectId
        in: path
        description: The Project ID.
        required: true
        schema:
          type: string
      - name: spaceId
        in: path
        description: The Space ID. (Use '_default' without quotes to address the default Space.)
        required: true
        schema:
          type: string
      - name: documentName
        in: path
        description: The Document name.
        required: true
        schema:
          type: string
      - name: workflowAction
        in: query
        description: The Workflow Action.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/documentsSinglePatchRequest'
        description: The Document 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 Document.
      tags:
      - Documents
  /projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/branch:
    post:
      operationId: branchDocument
      parameters:
      - name: projectId
        in: path
        description: The Project ID.
        required: true
        schema:
          type: string
      - name: spaceId
        in: path
        description: The Space ID. (Use '_default' without quotes to address the default Space.)
        required: true
        schema:
          type: string
      - name: documentName
        in: path
        description: The Document name.
        required: true
        schema:
          type: string
      - name: revision
        in: query
        description: The revision ID.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/branchDocumentRequestBody'
        description: Branching parameters.
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documentsSinglePostResponse'
          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 Branch of the Document.
      tags:
      - Documents
  /projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/copy:
    post:
      operationId: copyDocument
      parameters:
      - name: projectId
        in: path
        description: The Project ID.
        required: true
        schema:
          type: string
      - name: spaceId
        in: path
        description: The Space ID. (Use '_default' without quotes to address the default Space.)
        required: true
        schema:
          type: string
      - name: documentName
        in: path
        description: The Document name.
        required: true
        schema:
          type: string
      - name: revision
        in: query
        description: The revision ID.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/copyDocumentRequestBody'
        description: Copy Document parameters.
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/documentsSinglePostResponse'
          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 copy of the Document.
      tags:
      - Documents
  /projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/mergeFromMaster:
    post:
      operationId: mergeDocumentFromMaster
      parameters:
      - name: projectId
        in: path
        description: The Project ID.
        required: true
        schema:
          type: string
      - name: spaceId
        in: path
        description: The Space ID. (Use '_default' without quotes to address the default Space.)
        required: true
        schema:
          type: string
      - name: documentName
        in: path
        description: The Branch Document Name.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mergeDocumentRequestBody'
        description: Merge Document parameters.
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/jobsSinglePostResponse'
          description: Accepted
        '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: Merges Master Work Item changes to the specified Branched Document.
      tags:
      - Documents
  /projects/{projectId}/spaces/{spaceId}/documents/{documentName}/actions/mergeToMaster:
    post:
      operationId: mergeDocumentToMaster
      parameters:
      - name: projectId
        in: path
        description: The Project ID.
        required: true
        schema:
          type: string
      - name: spaceId
        in: path
        description: The Space ID. (Use '_default' without quotes to address the default Space.)
        required: true
        schema:
          type: string
      - name: documentName
        in: path
        description: The Branch Document Name.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mergeDocumentRequestBody'
        description: Merge Document parameters.
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/jobsSinglePostResponse'
          description: Accepted
        '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: Merges Work Item changes from specified Branched Document to Master.
      tags:
      - Documents
  /projects/{projectId}/spaces/{spaceId}/documents/{documentName}/fields/{fieldId}/actions/getAvailableOptions:
    get:
      operationId: getAvailableEnumOptionsForDocument
      parameters:
      - name: projectId
        in: path
        description: The Project ID.
        required: true
        schema:
          type: string
      - name: spaceId
        in: path
        description: The Space ID. (Use '_default' without quotes to address the default Space.)
        required: true
        schema:
          type: string
      - name: documentName
        in: path
        description: The Document name.
        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 <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a> 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 <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a> 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 in the specified Document.
      tags:
      - Documents
  /projects/{projectId}/spaces/{spaceId}/documents/{documentName}/fields/{fieldId}/actions/getCurrentOptions:
    get:
      operationId: getCurrentEnumerationOptionsForDocument
      parameters:
      - name: projectId
        in: path
        description: The Project ID.
        required: true
        schema:
          type: string
      - name: spaceId
        in: path
        description: The Space ID. (Use '_default' without quotes to address the default Space.)
        required: true
        schema:
          type: string
      - name: documentName
        in: path
        description: The Document name.
        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 <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a> 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 <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a> 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 in the specified Document.
      tags:
      - Documents
components:
  schemas:
    documentsListPostRequest:
      properties:
        data:
          items:
            properties:
              type:
                enum:
                - documents
                type: string
              attributes:
                properties:
                  autoSuspect:
                    type: boolean
                  homePageContent:
                    properties:
                      type:
                        enum:
                        - text/html
                        - text/plain
                        type: string
                      value:
                        example: My text value
                        type: string
                    type: object
                  moduleName:
                    example: MyDocumentId
                    type: string
                  outlineNumbering:
                    properties:
                      prefix:
                        example: ABC
                        type: string
                    type: object
                  renderingLayouts:
                    items:
                      properties:
                        label:
                          example: My label
                          type: string
                        layouter:
                          example: paragraph
                          type: string
                        properties:
                          items:
                            properties:
                              key:
                                example: fieldsAtStart
                                type: string
                              value:
                                example: id
                                type: string
                            type: object
                          type: array
                        type:
                          example: task
                          type: string
                      type: object
                    type: array
                  status:
                    example: draft
                    type: string
                  structureLinkRole:
                    example: relates_to
                    type: string
                  title:
                    example: Title
                    type: string
                  type:
                    example: req_specification
                    type: string
                  usesOutlineNumbering:
                    type: boolean
                type: object
            type: object
          type: array
      type: object
    mergeDocumentRequestBody:
      properties:
        createBaseline:
          description: Specifies whether the Baseline should be created.
          example: true
          type: boolean
        userFilter:
          description: Specifies the query to filter the source Work Items for the merge.
          example: status:open
          type: string
      type: object
    branchDocumentsRequestBody:
      properties:
        documentConfigurations:
          items:
            properties:
              copyWorkflowStatusAndSignatures:
                description: Specifies that workflow status and signatures should be copied to the branched document.
                example: false
                type: boolean
              initializedFields:
                description: Specifies fields of overwritten Work Items that should be initialized (instead of being copied from source Work Items).
                items:
                  example: severity
                  type: string
                type: array
              overwriteWorkItems:
                description: Specifies that Work Items in the branched Document should be overwritten (instead of being referenced).
                example: false
                type: boolean
              query:
                description: Specifies optional filtering query.
                example: status:open
                type: string
              sourceDocument:
                description: Reference path of the source Document.
                example: MyProjectId/MySpaceId/MyDocumentId
                type: string
              sourceRevision:
                description: Revision of the source Document.
                example: '1234'
                type: string
              targetDocumentName:
                description: Name for new Document.
                example: MyDocumentId
                type: string
              targetDocumentTitle:
                description: Title for new Document.
                example: My Document Title
                type: string
              targetProjectId:
                description: Project where new document will be created.
                example: MyProjectId
                type: string
              targetSpaceId:
                description: Space where new document will be created.
                example: MySpaceId
                type: string
              updateTitleHeading:
                description: Specifies that title heading of the target Document should be set to the new Document's title.
                example: false
                type: boolean
            required:
            - sourceDocument
            type: object
          minItems: 1
          type: array
      required:
      - documentConfigurations
      type: object
    documentsListGetResponse:
      properties:
        data:
          items:
            properties:
              type:
                enum:
                - documents
                type: string
              id:
                example: MyProjectId/MySpaceId/MyDocumentId
                type: string
              revision:
                example: '1234'
                type: string
              attributes:
                properties:
                  autoSuspect:
                    type: boolean
                  branchedWithInitializedFields:
                    items:
                      example: fieldId
                      type: string
                    type: array
                  branchedWithQuery:
                    example: Branched with Query
                    type: string
                  created:
                    example: '1970-01-01T00:00:00Z'
                    format: date-time
                    type: string
                  derivedFields:
                    items:
                      example: fieldId
                      type: string
                    type: array
                  derivedFromLinkRole:
                    example: relates_to
                    type: string
                  homePageContent:
                    properties:
                      type:
                        enum:
                        - text/html
                        - text/plain
                        type: string
                      value:
                        example: My text value
                        type: string
                    type: object
                  moduleFolder:
                    example: MySpaceId
                    type: string
                  moduleName:
                    example: MyDocumentId
                    type: string
                  outlineNumbering:
                    properties:
                      prefix:
                        example: ABC
                        type: string
                    type: object
                  renderingLayouts:
                    items:
                      properties:
                        label:
                          example: My label
                          type: string
                        layouter:
                          example: paragraph
                          type: string
                        properties:
                          items:
                            properties:
                              key:
                                example: fieldsAtStart
                                type: string
                              value:
                                example: id
                                type: string
                            type: object
                          type: array
                        type:
                          example: task
                          type: string
                      type: object
                    type: array
                  status:
                    example: draft
                    type: string
                  structureLinkRole:
                    example: relates_to
                    type: string
                  title:
                    example: Title
                    type: string
                  type:
                    example: req_specification
                    type: string
                  updated:
                    example: '1970-01-01T00:00:00Z'
                    format: date-time
                    type: string
                  usesOutlineNumbering:
                    type: boolean
                type: object
              relationships:
                properties:
                  attachments:
                    properties:
                      data:
                        items:
                          properties:
                            id:
                              example: MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId
                              type: string
                            revision:
                              example: '1234'
                              type: string
                            type:
                              enum:
                              - document_attachments
                              type: string
                          type: object
                        type: array
                      links:
                        properties:
                          related:
                            example: server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/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
                  branchedFrom:
                    properties:
                      data:
                        properties:
                          id:
                            example: MyProjectId/MySpaceId/MyDocumentId
                            type: string
                          revision:
                            example: '1234'
                            type: string
                          type:
                            enum:
                            - documents
                            type: string
                        type: object
                    type: object
                  comments:
                    properties:
                      data:
                        items:
                          properties:
                            id:
                              example: MyProjectId/MySpaceId/MyDocumentId/MyCommentId
                              type: string
                            revision:
                              example: '1234'
                              type: string
                            type:
                              enum:
                              - document_comments
                              type: string
                          type: object
                        type: array
                      links:
                        properties:
                          related:
                            example: server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?revision=1234
                            type: string
                        type: object
                      meta:
                        properties:
                          totalCount:
                            format: int32
                            type: integer
                        type: object
                    type: object
                  derivedFrom:
                    properties:
                      data:
                        properties:
                          id:
                            example: MyProjectId/MySpaceId/MyDocumentId
                            type: string
                          revision:
                            example: '1234'
                            type: string
                          type:
                            enum:
                            - documents
                            type: string
                        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
                  updatedBy:
                    properties:
                      data:
                        properties:
                          id:
                            example: MyUserId
                            type: string
                          revision:
                            example: '1234'
                            type: string
                          type:
                            enum:
                            - users
                            type: string
                        type: object
                    type: object
                  variant:
                    properties:
                      data:
                        properties:
                          id:
                            example: MyProjectId/MyWorkItemId
                            type: string
                          revision:
                            example: '1234'
                            type: string
                          type:
                            enum:
                            - workitems
                            type: string
                        type: object
                    type: object
                type: object
              links:
                properties:
                  self:
                    example: server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId?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 <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>.
          items:
            type: object
          type: array
        links:
          properties:
            first:
              example: server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=1
              type: string
            last:
              example: server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=9
              type: string
            next:
              example: server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=6
              type: string
            prev:
              example: server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=4
              type: string
            self:
              example: server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents?page%5Bsize%5D=10&page%5Bnumber%5D=5
              type: string
          type: object
        meta:
          properties:
            totalCount:
              format: int32
              type: integer
          type: object
      type: object
    jobsSinglePostResponse:
      properties:
        data:
          properties:
            type:
              enum:
              - jobs
              type: string
            id:
              example: MyJobId
              type: string
            attributes:
              properties:
                jobId:
                  example: example
                  type: string
                name:
                  example: example
                  type: string
                state:
                  example: example
                  type: string
                status:
                  properties:
                    message:
                      example: message
                      type: string
                    type:
                      enum:
                      - OK
                      - CANCELLED
                      - FAILED
                      - UNKNOWN
                      type: string
                  type: object
              type: object
            relationships:
              properties:
                document:
                  properties:
                    data:
                      properties:
                        id:
                          example: MyProjectId/MySpaceId/MyDocumentId
                          type: string
                        type:
                          enum:
                          - documents
                          type: string
                      type: object
                  type: object
                documents:
                  properties:
                    data:
                      items:
                        properties:
                          id:
                            example: MyProjectId/MySpaceId/MyDocumentId
                            type: string
                          type:
                            enum:
                            - documents
                            type: string
                        type: object
                      type: array
                  type: object
                project:
                  properties:
                    data:
                      properties:
                        id:
                          example: MyProjectId
                          type: string
                        type:
                          enum:
                          - projects
                          type: string
                      type: object
                  type: object
              type: object
            links:
              properties:
                downloads:
                  example:
                  - https://example.com/polarion/download/filename1
                  - https://example.com/polarion/download/filename2
                  type: array
                log:
                  example: server-host-name/application-path/polarion/job-report?jobId=MyJobId
                  type: string
                self:
                  example: server-host-name/application-path/jobs/MyJobId
                  type: string
              type: object
          type: object
      type: object
    documentsSingleGetResponse:
      properties:
        data:
          properties:
            type:
              enum:
              - documents
              type: string
            id:
              example: MyProjectId/MySpaceId/MyDocumentId
              type: string
            revision:
              example: '1234'
              type: string
            attributes:
              properties:
                autoSuspect:
                  type: boolean
                branchedWithInitializedFields:
                  items:
                    example: fieldId
                    type: string
                  type: array
                branchedWithQuery:
                  example: Branched with Query
                  type: string
                created:
                  example: '1970-01-01T00:00:00Z'
                  format: date-time
                  type: string
                derivedFields:
                  items:
                    example: fieldId
                    type: string
                  type: array
                derivedFromLinkRole:
                  example: relates_to
                  type: string
                homePageContent:
                  properties:
                    type:
                      enum:
                      - text/html
                      - text/plain
                      type: string
                    value:
                      example: My text value
                      type: string
                  type: object
                moduleFolder:
                  example: MySpaceId
                  type: string
                moduleName:
                  example: MyDocumentId
                  type: string
                outlineNumbering:
                  properties:
                    prefix:
                      example: ABC
                      type: string
                  type: object
                renderingLayouts:
                  items:
                    properties:
                      label:
                        example: My label
                        type: string
                      layouter:
                        example: paragraph
                        type: string
                      properties:
                        items:
                          properties:
                            key:
                              example: fieldsAtStart
                              type: string
                            value:
                              example: id
                              type: string
                          type: object
                        type: array
                      type:
                        example: task
                        type: string
                    type: object
                  type: array
                status:
                  example: draft
                  type: string
                structureLinkRole:
                  example: relates_to
                  type: string
                title:
                  example: Title
                  type: string
                type:
                  example: req_specification
                  type: string
                updated:
                  example: '1970-01-01T00:00:00Z'
                  format: date-time
                  type: string
                usesOutlineNumbering:
                  type: boolean
              type: object
            relationships:
              properties:
                attachments:
                  properties:
                    data:
                      items:
                        properties:
                          id:
                            example: MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId
                            type: string
                          revision:
                            example: '1234'
                            type: string
                          type:
                            enum:
                            - document_attachments
                            type: string
                        type: object
                      type: array
                    links:
                      properties:
                        related:
                          example: server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/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
                branchedFrom:
                  properties:
                    data:
                      properties:
                        id:
                          example: MyProjectId/MySpaceId/MyDocumentId
                          type: string
                        revision:
                          example: '1234'
                          type: string
                        type:
                          enum:
                          - documents
                          type: string
                      type: object
                  type: object
                comments:
                  properties:
                    data:
                      items:
                        properties:
                          id:
                            example: MyProjectId/MySpaceId/MyDocumentId/MyCommentId
                            type: string
                          revision:
                            example: '1234'
                            type: string
                          type:
                            enum:
                            - document_comments
                            type: string
                        type: object
                      type: array
                    links:
                      properties:
                        related:
                          example: server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?revision=1234
                          type: string
                      type: object
                    meta:
                      properties:
                        totalCount:
                          format: int32
                          type: integer
                      type: object
                  type: object
                derivedFrom:
                  properties:
                    data:
                      properties:
                        id:
                          example: MyProjectId/MySpaceId/MyDocumentId
                          type: string
                        revision:
                          example: '1234'
                          type: string
                        type:
                          enum:
                          - documents
                          type: string
                      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
                updatedBy:
                  properties:
                    data:
                      properties:
                        id:
                          example: MyUserId
                          type: string
                        revision:
                          example: '1234'
                          type: string
                        type:
                          enum:
                          - users
                          type: string
                      type: object
                  type: object
                variant:
                  properties:
                    data:
                      properties:
                        id:
                          example: MyProjectId/MyWorkItemId
                          type: string
                        revision:
                          example: '1234'
                          type: string
                        type:
                          enum:
                          - workitems
                          type: string
                      type: object
                  type: object
              type: object
            links:
              properties:
                self:
                  example: server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId?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 <a href="https://docs.sw.siemens.com/en-US/doc/230235217/PL20250606201928474.polarion_help_sc.xid2134849/xid2134871" target="_blank">REST API User Guide</a>.
          items:
            type: object
          type: array
        links:
          properties:
            self:
              example: server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId?revision=1234
              type: string
          type: object
      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
    documentsSinglePostResponse:
      properties:
        data:
          properties:
            type:
              enum:
              - documents
              type: string
            id:
              example: MyProjectId/MySpaceId/MyDocumentId
              type: string
            attributes:
              properties:
                autoSuspect:
                  type: boolean
                branchedWithInitializedFields:
                  items:
                    example: fieldId
                    type: string
                  type: array
                branchedWithQuery:
                  example: Branched with Query
                  type: string
                created:
                  example: '1970-01-01T00:00:00Z'
                  format: date-time
                  type: string
                derivedFields:
                  items:
                    example: fieldId
                    type: string
                  type: array
                derivedFromLinkRole:
                  example: relates_to
                  type: string
                homePageContent:
                  properties:
                    type:
                      enum:
                      - text/html
                      - text/plain
                      type: string
                    value:
                      example: My text value
                      type: string
                  type: object
                moduleFolder:
                  example: MySpaceId
                  type: string
                outlineNumbering:
                  properties:
                    prefix:
                      example: ABC
                      type: string
                  type: object
                renderingLayouts:
                  items:
                    properties:
                      label:
                        example: My label
                        type: string
                      layouter:
                        example: paragraph
                        type: string
                      properties:
                        items:
                          properties:
                            key:
                              example: fieldsAtStart
                              type: string
                            value:
                              example: id
                              type: string
                          type: object
                        type: array
                      type:
                        example: task
                        type: string
                    type: object
                  type: array
                status:
                  example: draft
                  type: string
                title:
                  example: Title
                  type: string
                type:
                  example: req_specification
                  type: string
                updated:
                  example: '1970-01-01T00:00:00Z'
                  format: date-time
                  type: string
                usesOutlineNumbering:
                  type: boolean
              type: object
            relationships:
              properties:
                attachments:
                  properties:
                    data:
                      items:
                        properties:
                          id:
                            example: MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId
                            type: string
                          type:
                            enum:
                            - document_attachments
                            type: string
                        type: object
                      type: array
                    links:
                      properties:
                        related:
                          example: server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments?revision=1234
                          type: string
                      type: object
                  type: object
                author:
                  properties:
                    data:
                      properties:
                        id:
                          example: MyUserId
                          type: string
                        type:
                          enum:
                          - users
                          type: string
                      type: object
                  type: object
                branchedFrom:
                  properties:
                    data:
                      properties:
                        id:
                          example: MyProjectId/MySpaceId/MyDocumentId
                          type: string
                        type:
                          enum:
                          - documents
                          type: string
                      type: object
                  type: object
                comments:
                  properties:
                    data:
                      items:
                        properties:
                          id:
                            example: MyProjectId/MySpaceId/MyDocumentId/MyCommentId
                            type: string
                          type:
                            enum:
                            - document_comments
                            type: string
                        type: object
                      type: array
                    links:
                      properties:
                        related:
                          example: server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?revision=1234
                          type: string
                      type: object
                  type: object
                derivedFrom:
                  properties:
                    data:
                      properties:
                        id:
                          example: MyProjectId/MySpaceId/MyDocumentId
                          type: string
                        type:
                          enum:
                          - documents
                          type: string
                      type: object
                  type: object
                project:
                  properties:
                    data:
                      properties:
                        id:
                          example: MyProjectId
                          type: string
                        type:
                          enum:
                          - projects
                          type: string
                      type: object
                  type: object
                updatedBy:
                  properties:
                    data:
                      properties:
                        id:
                          example: MyUserId
                          type: string
                        type:
                          enum:
                          - users
                          type: string
                      type: object
                  type: object
                variant:
                  properties:
                    data:
                      properties:
                        id:
                          example: MyProjectId/MyWorkItemId
                          type: string
                        type:
                          enum:
                          - workitems
                          type: string
                      type: object
                  type: object
              type: object
            links:
              properties:
                self:
                  example: server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId?revision=1234
                  type: string
              type: object
          type: object
      type: object
    documentsListPostResponse:
      properties:
        data:
          items:
            properties:
              type:
                enum:
                - documents
                type: string
              id:
                example: MyProjectId/MySpaceId/MyDocumentId
                type: string
              links:
                properties:
                  self:
                    example: server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId?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
    documentsSinglePatchRequest:
      properties:
        data:
          properties:
            type:
              enum:
              - documents
              type: string
            id:
              example: MyProjectId/MySpaceId/MyDocumentId
              type: string
            attributes:
              properties:
                autoSuspect:
                  type: boolean
                homePageContent:
                  properties:
                    type:
                      enum:
                      - text/html
                      - text/plain
                      type: string
                    value:
                      example: My text value
                      type: string
                  type: object
                outlineNumbering:
                  properties:
                    prefix:
                      example: ABC
                      type: string
                  type: object
                renderingLayouts:
                  items:
                    properties:
                      label:
                        example: My label
                        type: string
                      layouter:
                        example: paragraph
                        type: string
                      properties:
                        items:
                          properties:
                            key:
                              example: fieldsAtStart
                              type: string
                            value:
                              example: id
                              type: string
                          type: object
                        type: array
                      type:
                        example: task
                        type: string
                    type: object
                  type: array
                status:
                  example: draft
                  type: string
                title:
                  example: Title
                  type: string
                type:
                  example: req_specification
                  type: string
                usesOutlineNumbering:
                  type: boolean
              type: object
          type: object
      type: object
    branchDocumentRequestBody:
      properties:
        copyWorkflowStatusAndSignatures:
          description: Specifies that workflow status and signatures should be copied to the branched document.
          example: false
          type: boolean
        query:
          description: Specifies optional filtering query.
          example: status:open
          type: string
        targetDocumentName:
          description: Name for new Document.
          example: MyDocumentId
          type: string
        targetProjectId:
          description: Project where new document will be created.
          example: MyProjectId
          type: string
        targetSpaceId:
          description: Space where new document will be created.
          example: MySpaceId
          type: string
      type: object
    copyDocumentRequestBody:
      properties:
        linkOriginalItemsWithRole:
          description: Link a copy of the document to the original.
          example: duplicates
          type: string
        removeOutgoingLinks:
          description: Should outgoing links be removed?
          example: true
          type: boolean
        targetDocumentName:
          description: Name for new Document.
          example: MyDocumentId
          type: string
        targetProjectId:
          description: Project where new document will be created.
          example: MyProjectId
          type: string
        targetSpaceId:
          description: Space where new document will be created.
          example: MySpaceId
          type: string
      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
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http