Siemens PLM Enumerations API

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 Enumerations API
  version: v1
servers:
- url: https://example.com/polarion/rest/v1
security:
- bearerAuth: []
tags:
- name: Enumerations
paths:
  /enumerations:
    get:
      operationId: getGlobalEnumerations
      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'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/enumerationsListGetResponse'
          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 Enumerations from the Global context.
      tags:
      - Enumerations
    post:
      operationId: postGlobalEnumeration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/enumerationsListPostRequest'
        description: The Enumeration(s) body.
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/enumerationsListPostResponse'
          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 Enumerations in the Global context.
      tags:
      - Enumerations
  /enumerations/{enumContext}/{enumName}/{targetType}:
    delete:
      operationId: deleteGlobalEnumeration
      parameters:
      - name: enumContext
        in: path
        description: The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.)
        required: true
        schema:
          type: string
      - name: enumName
        in: path
        description: The Enumeration Name.
        required: true
        schema:
          type: string
      - name: targetType
        in: path
        description: The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '409':
          description: Conflict
        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 the specified Enumeration from the Global context.
      tags:
      - Enumerations
    get:
      operationId: getGlobalEnumeration
      parameters:
      - name: enumContext
        in: path
        description: The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.)
        required: true
        schema:
          type: string
      - name: enumName
        in: path
        description: The Enumeration Name.
        required: true
        schema:
          type: string
      - name: targetType
        in: path
        description: The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)
        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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/enumerationsSingleGetResponse'
          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 Enumeration from the Global context.
      tags:
      - Enumerations
    patch:
      operationId: patchGlobalEnumeration
      parameters:
      - name: enumContext
        in: path
        description: The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.)
        required: true
        schema:
          type: string
      - name: enumName
        in: path
        description: The Enumeration Name.
        required: true
        schema:
          type: string
      - name: targetType
        in: path
        description: The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/enumerationsSinglePatchRequest'
        description: The Enumeration(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 the specified Enumeration in the Global context.
      tags:
      - Enumerations
  /projects/{projectId}/enumerations:
    get:
      operationId: getProjectEnumerations
      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'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/enumerationsListGetResponse'
          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 Enumerations from the Project context.
      tags:
      - Enumerations
    post:
      operationId: postProjectEnumeration
      parameters:
      - name: projectId
        in: path
        description: The Project ID.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/enumerationsListPostRequest'
        description: The Enumeration(s) body.
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/enumerationsListPostResponse'
          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 Enumerations in the Project context.
      tags:
      - Enumerations
  /projects/{projectId}/enumerations/{enumContext}/{enumName}/{targetType}:
    delete:
      operationId: deleteProjectEnumeration
      parameters:
      - name: projectId
        in: path
        description: The Project ID.
        required: true
        schema:
          type: string
      - name: enumContext
        in: path
        description: The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.)
        required: true
        schema:
          type: string
      - name: enumName
        in: path
        description: The Enumeration Name.
        required: true
        schema:
          type: string
      - name: targetType
        in: path
        description: The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '409':
          description: Conflict
        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 the specified Enumeration from the Project context.
      tags:
      - Enumerations
    get:
      operationId: getProjectEnumeration
      parameters:
      - name: projectId
        in: path
        description: The Project ID.
        required: true
        schema:
          type: string
      - name: enumContext
        in: path
        description: The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.)
        required: true
        schema:
          type: string
      - name: enumName
        in: path
        description: The Enumeration Name.
        required: true
        schema:
          type: string
      - name: targetType
        in: path
        description: The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)
        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
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/enumerationsSingleGetResponse'
          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 Enumeration from the Project context.
      tags:
      - Enumerations
    patch:
      operationId: patchProjectEnumeration
      parameters:
      - name: projectId
        in: path
        description: The Project ID.
        required: true
        schema:
          type: string
      - name: enumContext
        in: path
        description: The Enumeration context. (Allowed values are '~', 'plans', 'testing' and 'documents'. Use '~' for Work Item or general enumerations.)
        required: true
        schema:
          type: string
      - name: enumName
        in: path
        description: The Enumeration Name.
        required: true
        schema:
          type: string
      - name: targetType
        in: path
        description: The Enumeration target type. (Use '~' when there is no specific type for the enumeration.)
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/enumerationsSinglePatchRequest'
        description: The Enumeration(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 the specified Enumeration in the Project context.
      tags:
      - Enumerations
components:
  schemas:
    enumerationsSingleGetResponse:
      properties:
        data:
          properties:
            type:
              enum:
              - enumerations
              type: string
            id:
              example: ~/status/~
              type: string
            attributes:
              properties:
                enumContext:
                  example: id
                  type: string
                enumName:
                  example: id
                  type: string
                options:
                  items:
                    properties:
                      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
                      id:
                        example: open
                        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
                targetType:
                  example: id
                  type: string
              type: object
            links:
              properties:
                self:
                  example: server-host-name/application-path/enumerations/%7E/status/%7E
                  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/enumerations/%7E/status/%7E
              type: string
          type: object
      type: object
    enumerationsSinglePatchRequest:
      properties:
        data:
          properties:
            type:
              enum:
              - enumerations
              type: string
            id:
              example: ~/status/~
              type: string
            attributes:
              properties:
                options:
                  items:
                    properties:
                      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
                      id:
                        example: open
                        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
              type: object
          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
    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 to

# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/siemens-plm/refs/heads/main/openapi/siemens-plm-enumerations-api-openapi.yml