openapi: 3.1.0
info:
  title: HPE GreenLake APIs for Subscription Management
  description: >-
    With the HPE GreenLake APIs for Subscription Management you can add
    subscriptions, unclaim subscriptions, get subscription information, and
    update auto-subscription settings for your HPE GreenLake workspace.
  version: latest
servers:
  - url: https://global.api.greenlake.hpe.com
    description: Url hostname
security:
  - Bearer: []
paths:
  /subscriptions/v1/subscriptions:
    post:
      tags:
        - Subscriptions - v1
      summary: Add subscriptions
      description: >-
        Add one or more subscriptions to a workspace.<br><br> **NOTE:** You need
        to have the edit  permission for the **Devices and Subscription
        service** to invoke this API.<br><br>  This API provides an asynchronous
        response and will always  return `202 Accepted` if basic input
        validations are successful. The  location header in the response
        provides the URI to be invoked for  fetching progress of the
        subscription addition task. For details about  the status fetch URL,
        refer to the API [Get progress or status of async operations in
        subscriptions](#operation/getSubscriptionsAsyncOperationResource).<br><br>
        Rate limits are enforced on this API. Four requests per minute is
        supported per workspace, and the API returns a `429` status code if this
        threshold is breached.
      operationId: postSubscriptionsV1
      parameters:
        - name: dry-run
          in: query
          description: >-
            The `dry-run` query parameter is used to perform the resource update
            operation (`POST`, `PUT`, `PATCH`, `DELETE`) and return a response
            as if the operation had completed, but without actually creating,
            updating, or deleting the resource. This allows you to test if the
            request would succeed before making the change. If set to `true`,
            the request is validated but not executed.
          required: false
          schema:
            type: boolean
            default: false
      requestBody:
        description: Maximum five subscriptions per request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionsPostRequest'
        required: true
      responses:
        '202':
          description: Request accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncResponse'
          headers:
            Location:
              $ref: '#/components/headers/LocationHeaderV1'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeBadRequestError'
              examples:
                error_bad_request:
                  value:
                    errorCode: HPE_GL_ERROR_BAD_REQUEST
                    message: Bad Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 400
                    errorDetails:
                      - type: hpe.greenlake.bad_request
                        issues:
                          - source: field
                            subject: key
                            description: Parameter key is empty.
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unauthorized_request:
                  value:
                    errorCode: HPE_GL_ERROR_UNAUTHORIZED
                    message: Unauthorized Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 401
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Token provided is invalid
        '403':
          description: The operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_forbidden_request:
                  value:
                    errorCode: HPE_GL_ERROR_FORBIDDEN
                    message: Forbidden Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 403
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Permission is denied to perform requested operation.
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unprocessable_request:
                  value:
                    errorCode: HPE_GL_UNPROCESSABLE_CONTENT
                    message: Unprocessable Content
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 422
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          content: Could not process the content.
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_too_many_request:
                  value:
                    errorCode: HPE_GL_ERROR_TOO_MANY_REQUESTS
                    message: Too Many Requests
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 429
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          apiRateLimit: >-
                            Too Many Requests. Rate limit has exceeded a
                            predefined value.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeServerError'
              examples:
                error_internal_server_error:
                  value:
                    errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR
                    message: Internal Server Error
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 500
                    errorDetails:
                      - type: hpe.greenlake.retry_info
                        retryAfterSeconds: 30
    patch:
      tags:
        - Subscriptions - v1
      summary: Update subscriptions
      description: >-
        Update subscriptions by passing one or more subscription IDs. Currently,
        the API supports adding and removing the tags for subscriptions.

        For each tag provided in the request body:

          - Tags are created and inserted into the specified subscriptions if the provided tags do not map to `null` and are not already present.

          - Tags are updated with the provided if the provided tag key is already present in a subscription, but the provided value differs from the existing value.

          - Tags are removed from subscriptions when a tag key is mapped to a `null` tag value. The tags are removed from any subscription with a matching tag with the same key.

        This API provides an asynchronous response and returns `202 Accepted` if
        basic input validations are successful. The location header in the
        response provides the URI used to fetch the progress of the subscription
        update task. For details about the status fetch URL, see [Get progress
        or status of async operations in
        subscriptions](#operation/getSubscriptionsAsyncOperationResource).
        <br><br> Rate limits are enforced on this API. Five requests per minute
        are supported per workspace, and the API returns `429` if this threshold
        is breached. <br><br> **NOTE:** To call this API, you need edit
        permissions for the **Devices and Subscription service**.
      operationId: patchSubscriptionsV1
      parameters:
        - name: dry-run
          in: query
          description: >-
            The `dry-run` query parameter is used to perform the resource update
            operation (`POST`, `PUT`, `PATCH`, `DELETE`) and return a response
            as if the operation had completed, but without actually creating,
            updating, or deleting the resource. This allows you to test if the
            request would succeed before making the change. If set to `true`,
            the request is validated but not executed.
          required: false
          schema:
            type: boolean
            default: false
        - name: id
          explode: true
          in: query
          description: Subscription resourceIDs.
          required: true
          style: form
          schema:
            uniqueItems: true
            type: array
            items:
              type: string
              format: UUID
          examples:
            example:
              summary: A set of subscription resource IDs
              value:
                - 05fc0c47-e517-5709-976e-c0b726977477
                - 08a42d07-b144-5602-9a82-7927d6e44616
      requestBody:
        description: >-
          Provide a map of `tags` to create or delete for the given
          `subscriptionID` (or multiple `subscriptionID`'s). 

           Tags are saved with the character casing preserved (uppercase, lowercase, mixed, and so on). However, tag searching is not case-sensitive. For example, adding a new tag with the key `Location` will fail if the subscription already has a tag with the key `LOCATION` as they are considered the same key.

            Tag keys and tag values can comprise letters, numbers, spaces (represented in UTF-8), and only the characters: `_`, `.`, `:`, `=`, `+`, `-`, and  `@`.

          **NOTE:** Do not store sensitive data, such as personally identifiable
          information, in tags.
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/SubscriptionsPatchRequest'
            examples:
              CreateNewTags:
                $ref: '#/components/examples/CreateNewTags'
              UpdateExistingTagsWithNewTagValues:
                $ref: '#/components/examples/UpdateExistingTagsWithNewTagValues'
              DeleteExistingTags:
                $ref: '#/components/examples/DeleteExistingTags'
              UpdateAndDeleteExistingTags:
                $ref: '#/components/examples/UpdateAndDeleteExistingTags'
        required: true
      responses:
        '202':
          description: Request accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncResponse'
          headers:
            Location:
              $ref: '#/components/headers/LocationHeaderV1'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeBadRequestError'
              examples:
                error_bad_request:
                  value:
                    errorCode: HPE_GL_ERROR_BAD_REQUEST
                    message: Bad Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 400
                    errorDetails:
                      - type: hpe.greenlake.bad_request
                        issues:
                          - source: field
                            subject: key
                            description: Parameter key is empty.
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unauthorized_request:
                  value:
                    errorCode: HPE_GL_ERROR_UNAUTHORIZED
                    message: Unauthorized Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 401
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Token provided is invalid
        '403':
          description: The operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_forbidden_request:
                  value:
                    errorCode: HPE_GL_ERROR_FORBIDDEN
                    message: Forbidden Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 403
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Permission is denied to perform requested operation.
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unprocessable_request:
                  value:
                    errorCode: HPE_GL_UNPROCESSABLE_CONTENT
                    message: Unprocessable Content
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 422
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          content: Could not process the content.
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_too_many_request:
                  value:
                    errorCode: HPE_GL_ERROR_TOO_MANY_REQUESTS
                    message: Too Many Requests
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 429
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          apiRateLimit: >-
                            Too Many Requests. Rate limit has exceeded a
                            predefined value.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeServerError'
              examples:
                error_internal_server_error:
                  value:
                    errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR
                    message: Internal Server Error
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 500
                    errorDetails:
                      - type: hpe.greenlake.retry_info
                        retryAfterSeconds: 30
    get:
      tags:
        - Subscriptions - v1
      summary: Get subscriptions of a workspace
      description: >-
        Get subscriptions managed in a workspace. Filters can be passed to
        filter  the subscriptions based on conditional
        expressions.<br><br>**NOTE:** You need to have  view permission for the
        **Devices and subscription service** to invoke this API. <br><br> Rate
        limits are enforced on this API. 60 requests per minute is supported per
        workspace. API will result in `429` if this threshold is breached.
      operationId: getSubscriptionsV1
      parameters:
        - name: filter
          in: query
          description: >
            Filter expressions consisting of simple comparison operations
            joined 

            by logical operators.<br>

            | CLASS                |  
            EXAMPLES                                         |

            |----------------------|----------------------------------------------------|

            | Types                | integer, decimal, timestamp, string,
            boolean, null |

            | Comparison           | eq, ne, gt, ge, lt, le,
            in                         |

            | Logical Expressions  | and, or,
            not                                       |


            Subscriptions can be filtered based on the following properties:

            - `id`

            - `subscriptionType`

            - `subscriptionStatus`

            - `key`

            - `quantity`

            - `availableQuantity`

            - `sku`

            - `skuDescription`

            - `contract`

            - `startTime`

            - `endTime`

            - `productType`

            - `tier`

            - `tierDescription`

            - `quote`

            - `po`

            - `resellerPo`

            - `createdAt`

            - `updatedAt`


            The following is a non-exhaustive list of possible filtering
            options.
          required: false
          schema:
            type: string
          examples:
            equals:
              summary: Filter with equality check
              description: >
                Return subscriptions where a property equals a value. Example
                syntax, 

                \<property> eq \<value>.
              value: key eq 'STIAPL6404'
            ne:
              summary: Filter with not-equality check
              description: >
                Return subscriptions where a property does not equate to a
                value. Example syntax, 

                \<property> ne \<value>.
              value: tier ne 'BRIDGE'
            not:
              summary: Filter on an inverted query
              description: >
                Return subscriptions where a property does not equal a value.
                Example syntax, 

                not \<property> eq \<value>.
              value: not key eq 'STIAPL6404'
            ge:
              summary: Filter with greater or equal check
              description: >
                Return subscriptions where a property is greater or equal to a
                value. Example syntax,

                \<property> ge \<value>.
              value: createdAt ge '2024-01-18T19:53:51.480Z'
            le:
              summary: Filter with lesser or equal check
              description: >
                Return subscriptions where a property is less than or equal to a
                value. Example syntax,

                \<property> le \<value>.
              value: updatedAt le '2024-02-18T19:53:51.480Z'
            conjunction:
              summary: Filter on multiple properties using the AND operator
              description: >
                The AND operator returns results that meet all filter queries.
                In the example, the query only returns subscriptions with the
                exact key and with the specified subscription type. Example
                syntax,

                \<property> eq \<value> and \<property> eq \<value>.
              value: key eq 'STIQQ4L04' and subscriptionType eq 'CENTRAL_STORAGE'
            disjunction:
              summary: Filter on multiple properties using the OR operator
              description: >
                The OR operator returns results that meet any of the filter
                queries. In the example, the query returns subscriptions with
                the exact key or with the specified subscription type.
              value: key eq 'STIQQ4L04' or subscriptionType eq 'CENTRAL_STORAGE'
            alternatives:
              summary: Filter for a value to have one of multiple possibilities
              description: >
                Return subscriptions where the property is one of multiple
                values. Example syntax, 

                \<property> in \<value>,\<value>.
              value: subscriptionType in 'CENTRAL_STORAGE', 'CENTRAL_CONTROLLER'
            multiple-properties:
              summary: >-
                Filter on multiple properties using the AND, OR, and NOT
                operators.
              description: >
                The AND, OR, and NOT operators can be combined to return results
                that satisfy all specified filter criteria.
              value: >-
                startTime gt '2024-01-23T00:00:00.000Z' and endTime lt
                '2025-02-22T00:00:00.000Z' and not productType eq 'SERVICE'
        - name: filter-tags
          in: query
          description: |
            Filter expressions consisting of simple comparison operations joined
            by logical operators to be applied on the assigned tags or their
            values.<br>
            | CLASS               |   EXAMPLES      |
            |---------------------|-----------------|
            | Types               | string          |
            | Comparison          | eq, ne          |
            | Logical Expressions | and, or         |
          required: false
          schema:
            type: string
          examples:
            equals:
              summary: Filter with equality check
              description: >
                Return subscriptions that have a pair of tags with the exact
                same tag key and tag value. Example syntax, 

                \<tagKey> eq \<tagValue>.
              value: '''city'' eq ''London'''
            not-equals:
              summary: Filter with inequality check
              description: >
                Return subscriptions that have a pair of tags with the exact
                same tag key and the exact different tag value. Example syntax, 

                \<tagKey> ne \<tagValue>.
              value: '''city'' ne ''London'''
            conjunction:
              summary: Filter on multiple strict conditionals
              description: >
                Return subscriptions containing the tag key and the
                corresponding value that satisfy all conditionals. Example
                syntax, 

                \<property> eq \<value> and \<property> eq \<value>.
              value: '''city'' eq ''London'' and ''street'' eq ''Piccadilly'''
            disjunction:
              summary: Filter on multiple non strict conditionals
              description: >
                Return subscriptions containing the tag key and the
                corresponding value that satisfy at least one of the
                conditionals. Example syntax, 

                \<property> eq \<value> or \<property> eq \<value>.
              value: '''street'' eq ''Oxford Street'' or ''street'' eq ''Piccadilly'''
        - name: sort
          in: query
          description: >-
            A comma separated list of sort expressions. A sort expression is a 
            property name optionally followed by a direction indicator `asc` or 
            `desc`. The default is ascending order.
          required: false
          schema:
            type: string
          example: key, quote desc
        - name: select
          explode: false
          in: query
          description: >-
            A comma separated list of select properties to display in the
            response.  The default is that all properties are returned.
          required: false
          style: form
          schema:
            uniqueItems: true
            type: array
            items:
              type: string
          example: id,key
        - name: limit
          in: query
          description: >-
            Specifies the number of results to be returned. The default value 
            is 50.
          required: false
          schema:
            maximum: 50
            minimum: 1
            type: integer
            format: int64
            default: 50
        - name: offset
          in: query
          description: >-
            Specifies the zero-based resource offset to start the response from.
            The default value is 0.
          required: false
          schema:
            type: integer
            format: int64
            default: 0
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1Beta1SubscriptionsGetResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeBadRequestError'
              examples:
                error_bad_request:
                  value:
                    errorCode: HPE_GL_ERROR_BAD_REQUEST
                    message: Bad Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 400
                    errorDetails:
                      - type: hpe.greenlake.bad_request
                        issues:
                          - source: query.parameter
                            subject: limit
                            description: Must be a numeric value which is 0 or greater.
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unauthorized_request:
                  value:
                    errorCode: HPE_GL_ERROR_UNAUTHORIZED
                    message: Unauthorized Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 401
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Token provided is invalid
        '403':
          description: The operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_forbidden_request:
                  value:
                    errorCode: HPE_GL_ERROR_FORBIDDEN
                    message: Forbidden Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 403
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Permission is denied to perform requested operation.
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unprocessable_request:
                  value:
                    errorCode: HPE_GL_UNPROCESSABLE_CONTENT
                    message: Unprocessable Content
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 422
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          content: Could not process the content.
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_too_many_request:
                  value:
                    errorCode: HPE_GL_ERROR_TOO_MANY_REQUESTS
                    message: Too Many Requests
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 429
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          apiRateLimit: >-
                            Too Many Requests. Rate limit has exceeded a
                            predefined value.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeServerError'
              examples:
                error_internal_server_error:
                  value:
                    errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR
                    message: Internal Server Error
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 500
                    errorDetails:
                      - type: hpe.greenlake.retry_info
                        retryAfterSeconds: 30
  /subscriptions/v1/subscriptions/{id}:
    get:
      tags:
        - Subscriptions - v1
      summary: Get information on a subscription
      description: >-
        Get detailed information for a single subscription by `id`.
        <br><br>**NOTE:** You need to have the view permission of device
        management to invoke this API. <br><br> Rate limits are enforced on this
        API. 20 requests per minute is supported per workspace. The API returns
        `429` if this threshold is breached.
      operationId: getSubscriptionDetailsByIDV1
      parameters:
        - name: id
          in: path
          description: The unique identifier of the subscription.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1Beta1SubscriptionDetail'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeBadRequestError'
              examples:
                error_bad_request:
                  value:
                    errorCode: HPE_GL_ERROR_BAD_REQUEST
                    message: Bad Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 400
                    errorDetails:
                      - type: hpe.greenlake.bad_request
                        issues:
                          - source: query.parameter
                            subject: Id
                            description: Id is not a valid UUID.
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unauthorized_request:
                  value:
                    errorCode: HPE_GL_ERROR_UNAUTHORIZED
                    message: Unauthorized Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 401
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Token provided is invalid
        '403':
          description: The operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_forbidden_request:
                  value:
                    errorCode: HPE_GL_ERROR_FORBIDDEN
                    message: Forbidden Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 403
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Permission is denied to perform requested operation.
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unprocessable_request:
                  value:
                    errorCode: HPE_GL_UNPROCESSABLE_CONTENT
                    message: Unprocessable Content
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 422
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          content: Could not process the content.
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_too_many_request:
                  value:
                    errorCode: HPE_GL_ERROR_TOO_MANY_REQUESTS
                    message: Too Many Requests
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 429
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          apiRateLimit: >-
                            Too Many Requests. Rate limit has exceeded a
                            predefined value.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeServerError'
              examples:
                error_internal_server_error:
                  value:
                    errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR
                    message: Internal Server Error
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 500
                    errorDetails:
                      - type: hpe.greenlake.retry_info
                        retryAfterSeconds: 30
  /subscriptions/v2beta1/subscriptions/bulk:
    delete:
      tags:
        - Subscriptions - v2beta1
      summary: Unclaim subscriptions in bulk
      description: >-
        Unclaim subscriptions in bulk by passing one or more subscription
        IDs.<br><br> **Note:** You must have edit permission for the Devices and
        Subscription service to use this API.<br><br> You can unclaim up to 10
        subscriptions in a single request. This endpoint provides an
        asynchronous response and always returns 202 Accepted if basic input
        validation is successful. The Location header in the response contains
        the URI to check the progress of the unclaim task. For details about the
        status fetch URL, see [Get progress or status of async operations in
        subscriptions](#operation/getSubscriptionsAsyncOperationResource)<br><br>
        Rate limits apply to this endpoint. If the threshold is exceeded, the
        API returns a 429 Too Many Requests response.
      operationId: deleteSubscriptionsBulkV2Beta1
      requestBody:
        description: >-
          Provide a list of subscription IDs to unclaim. The API endpoint
          supports unclaiming up to 10 subscriptions in a single request.<br>
          You can fetch the subscription IDs using the [Get subscriptions of a
          workspace](#operation/getSubscriptionsV1) API.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionsBulkUnclaimRequest'
            examples:
              SubscriptionsBulkUnclaimExample:
                $ref: '#/components/examples/UnclaimSubscriptions'
        required: true
      responses:
        '202':
          description: Request accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncResponse'
              examples:
                async_response:
                  value:
                    code: 202
                    status: 202 ACCEPTED
                    transactionId: 5652cd26-d577-47cd-b075-8e94885a63ab
          headers:
            Location:
              $ref: '#/components/headers/LocationHeaderV1'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeBadRequestError'
              examples:
                error_bad_request:
                  value:
                    errorCode: HPE_GL_ERROR_BAD_REQUEST
                    message: Bad Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 400
                    errorDetails:
                      - type: hpe.greenlake.subscriptionmanagement.bad_request
                        issues:
                          - source: Invalid input provided
                            subject: items
                            description: Items must be between 1 and 10.
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unauthorized_request:
                  value:
                    errorCode: HPE_GL_ERROR_UNAUTHORIZED
                    message: Unauthorized Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 401
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Token provided is invalid
        '403':
          description: The operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_forbidden_request:
                  value:
                    errorCode: HPE_GL_ERROR_FORBIDDEN
                    message: Forbidden Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 403
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Permission is denied to perform requested operation.
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_too_many_request:
                  value:
                    errorCode: HPE_GL_ERROR_TOO_MANY_REQUESTS
                    message: Too Many Requests
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 429
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          apiRateLimit: >-
                            Too Many Requests. Rate limit has exceeded a
                            predefined value.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeServerError'
              examples:
                error_internal_server_error:
                  value:
                    errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR
                    message: Internal Server Error
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 500
                    errorDetails:
                      - type: hpe.greenlake.retry_info
                        retryAfterSeconds: 30
  /subscriptions/v1/async-operations/{id}:
    get:
      tags:
        - Subscriptions - v1
      summary: Get progress or status of async operations in subscriptions
      description: >-
        Use this API to find the status of the asynchronous Add and update
        subscriptions API. <br><br> An asynchronous resource is  generated to
        track the status of an asynchronous operation. An asynchronous  resource
        that has reached a terminal state (`SUCCEEDED`, `FAILED`, `TIMEOUT`) 
        will no longer be accessible 24 hours after reaching the terminal
        state.<br><br> An  asynchronous resource is set to the `TIMEOUT` state
        if the resource  has been in an `INITIALIZED` or `RUNNING` state for a
        period greater than the  timeout set. If an asynchronous operation
        resource coming from an asynchronous  request consists of multiple
        subscriptions, a breakdown of succeeded  subscriptions and failed
        subscriptions, if there are any, is returned  as the response. In this
        case, the subscription key identifies each
        subscription.<br><br>**Note:** You need view permissions for the Devices
        and  Subscription service to invoke this API. <br><br> Rate limits are
        enforced on this API. 30 requests per minute is supported per workspace.
        The API returns `429` if this threshold is breached.
      operationId: getSubscriptionsAsyncOperationResourceV1
      parameters:
        - name: id
          in: path
          required: true
          description: The unique identifier returned by an asynchronous API operation.
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncOperationResource'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeBadRequestError'
              examples:
                error_bad_request:
                  value:
                    errorCode: HPE_GL_ERROR_BAD_REQUEST
                    message: Bad Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 400
                    errorDetails:
                      - type: hpe.greenlake.bad_request
                        issues:
                          - source: query.parameter
                            subject: Id
                            description: Id is not a valid UUID.
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unauthorized_request:
                  value:
                    errorCode: HPE_GL_ERROR_UNAUTHORIZED
                    message: Unauthorized Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 401
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Token provided is invalid
        '403':
          description: The operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_forbidden_request:
                  value:
                    errorCode: HPE_GL_ERROR_FORBIDDEN
                    message: Forbidden Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 403
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Permission is denied to perform requested operation.
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unprocessable_request:
                  value:
                    errorCode: HPE_GL_UNPROCESSABLE_CONTENT
                    message: Unprocessable Content
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 422
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          content: Could not process the content.
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_too_many_request:
                  value:
                    errorCode: HPE_GL_ERROR_TOO_MANY_REQUESTS
                    message: Too Many Requests
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 429
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          apiRateLimit: >-
                            Too Many Requests. Rate limit has exceeded a
                            predefined value.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeServerError'
              examples:
                error_internal_server_error:
                  value:
                    errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR
                    message: Internal Server Error
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 500
                    errorDetails:
                      - type: hpe.greenlake.retry_info
                        retryAfterSeconds: 30
  /subscriptions/v1alpha1/subscriptions:
    get:
      deprecated: true
      tags:
        - Subscriptions - v1alpha1
      summary: Get subscriptions of a workspace
      description: >-
        Get subscriptions managed in a workspace. Pass filters to limit results
        based on conditional expressions. <br><br>**NOTE:** You need to have the
        view permission for the **Devices and subscription service** to invoke
        this API. <br><br> Rate limits are enforced on this API. 40 requests per
        minute is supported per workspace. API will result in `429` if this
        threshold is breached.
      operationId: getSubscriptionsV1alpha1
      parameters:
        - name: filter
          in: query
          description: >-
            Filter expressions consisting of simple comparison operations joined
            by logical operators.
          required: false
          schema:
            type: string
          example: key eq 'MHNBAP0001' and key in 'PAYHAH3YJE6THY, E91A7FDFE04D44C339'
        - name: sort
          in: query
          description: >-
            A comma separated list of sort expressions. A sort expression is a
            property name optionally followed by a direction indicator `asc` or
            `desc`. Default is ascending order.
          required: false
          schema:
            type: string
          example: key, quote desc
        - name: select
          explode: false
          in: query
          description: >-
            A comma separated list of select properties to return in the
            response. By default, all properties are returned.
          required: false
          style: form
          schema:
            uniqueItems: true
            type: array
            items:
              type: string
          example: id,key
        - name: limit
          in: query
          description: >-
            Specifies the number of results to be returned. The default value is
            2000.
          required: false
          schema:
            maximum: 2000
            minimum: 1
            type: integer
            format: int64
            default: 2000
        - name: offset
          in: query
          description: >-
            Specifies the zero-based resource offset to start the response from.
            Default value is 0.
          required: false
          schema:
            type: integer
            format: int64
            default: 0
      responses:
        '200':
          description: Successful response
          headers:
            Deprecation:
              description: |
                Wed, 15 Jan 2025 23:59:59 GMT
              schema:
                type: string
            Sunset:
              description: |
                Tue, 15 Apr 2025 23:59:59 GMT
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionsGetResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeBadRequestError'
              examples:
                error_bad_request:
                  value:
                    errorCode: HPE_GL_ERROR_BAD_REQUEST
                    message: Bad Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 400
                    errorDetails:
                      - type: hpe.greenlake.bad_request
                        issues:
                          - source: query.parameter
                            subject: limit
                            description: Must be a numeric value which is 0 or greater.
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unauthorized_request:
                  value:
                    errorCode: HPE_GL_ERROR_UNAUTHORIZED
                    message: Unauthorized Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 401
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Token provided is invalid
        '403':
          description: The operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_forbidden_request:
                  value:
                    errorCode: HPE_GL_ERROR_FORBIDDEN
                    message: Forbidden Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 403
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Permission is denied to perform requested operation.
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unprocessable_request:
                  value:
                    errorCode: HPE_GL_UNPROCESSABLE_CONTENT
                    message: Unprocessable Content
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 422
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          content: Could not process the content.
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_too_many_request:
                  value:
                    errorCode: HPE_GL_ERROR_TOO_MANY_REQUESTS
                    message: Too Many Requests
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 429
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          apiRateLimit: >-
                            Too Many Requests. Rate limit has exceeded a
                            predefined value.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeServerError'
              examples:
                error_internal_server_error:
                  value:
                    errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR
                    message: Internal Server Error
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 500
                    errorDetails:
                      - type: hpe.greenlake.retry_info
                        retryAfterSeconds: 30
  /subscriptions/v1beta1/subscriptions:
    post:
      deprecated: true
      tags:
        - Subscriptions - v1beta1
      summary: Add subscriptions
      description: >-
        Add one or more subscriptions to a workspace.<br><br> **NOTE:** You need
        to have the edit  permission for the **Devices and Subscription
        service** to invoke this API.<br><br>  This API provides an asynchronous
        response and will always  return `202 Accepted` if basic input
        validations are successful. The  location header in the response
        provides the URI to be invoked for  fetching progress of the
        subscription addition task. For details about  the status fetch URL,
        refer to the API [Get progress or status of async operations in
        subscriptions](#operation/getSubscriptionsAsyncOperationResource).<br><br>
        Rate limits are enforced on this API. Four requests per minute is
        supported per workspace, and the API returns a `429` status code if this
        threshold is breached.
      operationId: postSubscriptions
      requestBody:
        description: Maximum five subscriptions per request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionsPostRequest'
        required: true
      responses:
        '202':
          description: Request accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncResponse'
          headers:
            Deprecation:
              description: |
                Wed, 15 Jan 2025 23:59:59 GMT
              schema:
                type: string
            Sunset:
              description: |
                Tue, 15 Apr 2025 23:59:59 GMT
              schema:
                type: string
            Location:
              $ref: '#/components/headers/LocationHeader'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeBadRequestError'
              examples:
                error_bad_request:
                  value:
                    errorCode: HPE_GL_ERROR_BAD_REQUEST
                    message: Bad Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 400
                    errorDetails:
                      - type: hpe.greenlake.bad_request
                        issues:
                          - source: field
                            subject: key
                            description: Parameter key is empty.
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unauthorized_request:
                  value:
                    errorCode: HPE_GL_ERROR_UNAUTHORIZED
                    message: Unauthorized Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 401
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Token provided is invalid
        '403':
          description: The operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_forbidden_request:
                  value:
                    errorCode: HPE_GL_ERROR_FORBIDDEN
                    message: Forbidden Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 403
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Permission is denied to perform requested operation.
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unprocessable_request:
                  value:
                    errorCode: HPE_GL_UNPROCESSABLE_CONTENT
                    message: Unprocessable Content
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 422
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          content: Could not process the content.
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_too_many_request:
                  value:
                    errorCode: HPE_GL_ERROR_TOO_MANY_REQUESTS
                    message: Too Many Requests
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 429
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          apiRateLimit: >-
                            Too Many Requests. Rate limit has exceeded a
                            predefined value.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeServerError'
              examples:
                error_internal_server_error:
                  value:
                    errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR
                    message: Internal Server Error
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 500
                    errorDetails:
                      - type: hpe.greenlake.retry_info
                        retryAfterSeconds: 30
    patch:
      deprecated: true
      tags:
        - Subscriptions - v1beta1
      summary: Update subscriptions
      description: >-
        Update subscriptions by passing one or more subscription IDs. Currently,
        the API supports adding and removing the tags for subscriptions.

          For each tag provided in the request body:

          - Tags are created and inserted into the specified subscriptions if the provided tags do not map to `null` and are not already present.

          - Tags are updated with the provided if the provided tag key is already present in a subscription, but the provided value differs from the existing value.

          - Tags are removed from subscriptions when a tag key is mapped to a `null` tag value. The tags are removed from any subscription with a matching tag with the same key.

            This API provides an asynchronous response and returns `202 Accepted` if basic input validations are successful. The location header in the response provides the URI used to fetch the progress of the subscription update task. For details about the status fetch URL, see [Get progress or status of async operations in subscriptions](#operation/getSubscriptionsAsyncOperationResource).

          Rate limits are enforced on this API. Five requests per minute are supported per workspace, and the API returns '429` if this threshold is breached.

          **NOTE:** To call this API, you need edit permissions for the **Devices and Subscription service**.
      operationId: patchSubscriptions
      parameters:
        - name: id
          explode: true
          in: query
          description: Subscription resourceIDs.
          required: true
          style: form
          schema:
            uniqueItems: true
            type: array
            items:
              type: string
              format: UUID
          examples:
            example:
              summary: A set of subscription resource IDs
              value:
                - 05fc0c47-e517-5709-976e-c0b726977477
                - 08a42d07-b144-5602-9a82-7927d6e44616
      requestBody:
        description: >-
          Provide a map of `tags` to create or delete for the given
          `subscriptionID` (or multiple `subscriptionID`'s). 

           Tags are saved with the character casing preserved (uppercase, lowercase, mixed, and so on). However, tag searching is not case-sensitive. For example, adding a new tag with the key `Location` will fail if the subscription already has a tag with the key `LOCATION` as they are considered the same key.

            Tag keys and tag values can comprise letters, numbers, spaces (represented in UTF-8), and only the characters: `_`, `.`, `:`, `=`, `+`, `-`, and  `@`.

          **NOTE:** Do not store sensitive data, such as personally identifiable
          information, in tags.
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/SubscriptionsPatchRequest'
            examples:
              CreateNewTags:
                $ref: '#/components/examples/CreateNewTags'
              UpdateExistingTagsWithNewTagValues:
                $ref: '#/components/examples/UpdateExistingTagsWithNewTagValues'
              DeleteExistingTags:
                $ref: '#/components/examples/DeleteExistingTags'
              UpdateAndDeleteExistingTags:
                $ref: '#/components/examples/UpdateAndDeleteExistingTags'
        required: true
      responses:
        '202':
          description: Request accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncResponse'
          headers:
            Deprecation:
              description: |
                Wed, 15 Jan 2025 23:59:59 GMT
              schema:
                type: string
            Sunset:
              description: |
                Tue, 15 Apr 2025 23:59:59 GMT
              schema:
                type: string
            Location:
              $ref: '#/components/headers/LocationHeader'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeBadRequestError'
              examples:
                error_bad_request:
                  value:
                    errorCode: HPE_GL_ERROR_BAD_REQUEST
                    message: Bad Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 400
                    errorDetails:
                      - type: hpe.greenlake.bad_request
                        issues:
                          - source: field
                            subject: key
                            description: Parameter key is empty.
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unauthorized_request:
                  value:
                    errorCode: HPE_GL_ERROR_UNAUTHORIZED
                    message: Unauthorized Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 401
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Token provided is invalid
        '403':
          description: The operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_forbidden_request:
                  value:
                    errorCode: HPE_GL_ERROR_FORBIDDEN
                    message: Forbidden Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 403
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Permission is denied to perform requested operation.
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unprocessable_request:
                  value:
                    errorCode: HPE_GL_UNPROCESSABLE_CONTENT
                    message: Unprocessable Content
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 422
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          content: Could not process the content.
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_too_many_request:
                  value:
                    errorCode: HPE_GL_ERROR_TOO_MANY_REQUESTS
                    message: Too Many Requests
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 429
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          apiRateLimit: >-
                            Too Many Requests. Rate limit has exceeded a
                            predefined value.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeServerError'
              examples:
                error_internal_server_error:
                  value:
                    errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR
                    message: Internal Server Error
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 500
                    errorDetails:
                      - type: hpe.greenlake.retry_info
                        retryAfterSeconds: 30
    get:
      deprecated: true
      tags:
        - Subscriptions - v1beta1
      summary: Get subscriptions of a workspace
      description: >-
        Get subscriptions managed in a workspace. Filters can be passed to
        filter  the subscriptions based on conditional
        expressions.<br><br>**NOTE:** You need to have  view permission for the
        **Devices and subscription service** to invoke this API. <br><br> Rate
        limits are enforced on this API. 60 requests per minute is supported per
        workspace. API will result in `429` if this threshold is breached.
      operationId: getSubscriptionsBeta
      parameters:
        - name: filter
          in: query
          description: >
            Filter expressions consisting of simple comparison operations
            joined 

            by logical operators.<br>

            | CLASS                |  
            EXAMPLES                                         |

            |----------------------|----------------------------------------------------|

            | Types                | integer, decimal, timestamp, string,
            boolean, null |

            | Comparison           | eq, ne, gt, ge, lt, le,
            in                         |

            | Logical Expressions  | and, or,
            not                                       |


            The following is a non-exhaustive list of possible filtering
            options.
          required: false
          schema:
            type: string
          examples:
            equals:
              summary: Filter with equality check
              description: |
                Return subscriptions with where a property equals a value.
                \<property> eq \<value>
              value: key eq 'STIAPL6404'
            not:
              summary: Filter on an inverted query
              description: |
                Return subscriptions where a property does not equal a value
                not \<property> eq \<value>
              value: not key eq 'STIAPL6404'
            ge:
              summary: Filter with greater or equal check
              description: >
                Return subscriptions with where a property greater or equal a
                value.

                \<property> ge \<value>
              value: createdAt ge '2024-01-18T19:53:51.480Z'
            le:
              summary: Filter with lesser or equal check
              description: >
                Return subscriptions when a property is lesser or equal to a
                value.

                \<property> le \<value>
              value: updatedAt le '2024-02-18T19:53:51.480Z'
            conjunction:
              summary: Filter on multiple properties using the AND operator
              description: >
                The `and` operator returns results that meet both filter
                queries. In the example, the query only returns subscriptions
                with the exact key and with the specified subscription type.

                \<property> eq \<value> and \<property> eq \<value>
              value: key eq 'STIQQ4L04' and subscriptionType eq 'CENTRAL_STORAGE'
            disjunction:
              summary: Filter on multiple properties using the OR operator
              description: >
                The `or` operator returns results that meet either of the filter
                queries. In the example, the query returns subscriptions with
                the exact key or with the specified subscription type.

                value: key eq 'STIQQ4L04' or subscriptionType eq
                'CENTRAL_STORAGE'
            alternatives:
              summary: Filter for a value to have one of multiple possibilities
              description: >
                Return subscriptions where the property is one of multiple
                values.

                \<property> in \<value>,\<value>
              value: subscriptionType in 'CENTRAL_STORAGE', 'CENTRAL_CONTROLLER'
        - name: filter-tags
          in: query
          description: |
            Filter expressions consisting of simple comparison operations joined
            by logical operators to be applied on the assigned tags or their
            values.<br>
            | CLASS               |   EXAMPLES      |
            |---------------------|-----------------|
            | Types               | string          |
            | Comparison          | eq, ne          |
            | Logical Expressions | and, or         |
          required: false
          schema:
            type: string
          examples:
            equals:
              summary: Filter with equality check
              description: >
                Return subscriptions that have a pair of tags with the exact
                same tag key and tag value.

                \<tagKey> eq \<tagValue>
              value: '''city'' eq ''London'''
            not-equals:
              summary: Filter with inequality check
              description: >
                Return subscriptions that have a pair of tags with the exact
                same tag key and the exact different tag value.

                \<tagKey> ne \<tagValue>
              value: '''city'' ne ''London'''
            conjunction:
              summary: Filter on multiple strict conditionals
              description: >
                Return subscriptions containing the tag key and the
                corresponding value that satisfy all conditionals.

                \<property> eq \<value> and \<property> eq \<value>
              value: '''city'' eq ''London'' and ''street'' eq ''Piccadilly'''
            disjunction:
              summary: Filter on multiple non strict conditionals
              description: >
                Return subscriptions containing the tag key and the
                corresponding value that satisfy at least one of the
                conditionals.

                \<property> eq \<value> or \<property> eq \<value>
              value: '''street'' eq ''Oxford Street'' or ''street'' eq ''Piccadilly'''
        - name: sort
          in: query
          description: >-
            A comma separated list of sort expressions. A sort expression is a 
            property name optionally followed by a direction indicator `asc` or 
            `desc`. The default is ascending order.
          required: false
          schema:
            type: string
          example: key, quote desc
        - name: select
          explode: false
          in: query
          description: >-
            A comma separated list of select properties to display in the
            response.  The default is that all properties are returned.
          required: false
          style: form
          schema:
            uniqueItems: true
            type: array
            items:
              type: string
          example: id,key
        - name: limit
          in: query
          description: >-
            Specifies the number of results to be returned. The default value 
            is 50.
          required: false
          schema:
            maximum: 50
            minimum: 1
            type: integer
            format: int64
            default: 50
        - name: offset
          in: query
          description: >-
            Specifies the zero-based resource offset to start the response from.
            The default value is 0.
          required: false
          schema:
            type: integer
            format: int64
            default: 0
      responses:
        '200':
          description: Successful response
          headers:
            Deprecation:
              description: |
                Wed, 15 Jan 2025 23:59:59 GMT
              schema:
                type: string
            Sunset:
              description: |
                Tue, 15 Apr 2025 23:59:59 GMT
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1Beta1SubscriptionsGetResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeBadRequestError'
              examples:
                error_bad_request:
                  value:
                    errorCode: HPE_GL_ERROR_BAD_REQUEST
                    message: Bad Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 400
                    errorDetails:
                      - type: hpe.greenlake.bad_request
                        issues:
                          - source: query.parameter
                            subject: limit
                            description: Must be a numeric value which is 0 or greater.
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unauthorized_request:
                  value:
                    errorCode: HPE_GL_ERROR_UNAUTHORIZED
                    message: Unauthorized Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 401
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Token provided is invalid
        '403':
          description: The operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_forbidden_request:
                  value:
                    errorCode: HPE_GL_ERROR_FORBIDDEN
                    message: Forbidden Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 403
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Permission is denied to perform requested operation.
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unprocessable_request:
                  value:
                    errorCode: HPE_GL_UNPROCESSABLE_CONTENT
                    message: Unprocessable Content
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 422
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          content: Could not process the content.
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_too_many_request:
                  value:
                    errorCode: HPE_GL_ERROR_TOO_MANY_REQUESTS
                    message: Too Many Requests
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 429
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          apiRateLimit: >-
                            Too Many Requests. Rate limit has exceeded a
                            predefined value.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeServerError'
              examples:
                error_internal_server_error:
                  value:
                    errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR
                    message: Internal Server Error
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 500
                    errorDetails:
                      - type: hpe.greenlake.retry_info
                        retryAfterSeconds: 30
  /subscriptions/v1beta1/subscriptions/{id}:
    get:
      deprecated: true
      tags:
        - Subscriptions - v1beta1
      summary: Get information on a subscription
      description: >-
        Get detailed information for a single subscription by `id`.
        <br><br>**NOTE:** You need to have the view permission of device
        management to invoke this API. <br><br> Rate limits are enforced on this
        API. 20 requests per minute is supported per workspace. API will result
        in `429` if this threshold is breached.
      operationId: getSubscriptionDetailsByID
      parameters:
        - name: id
          in: path
          description: The unique identifier of the subscription.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          headers:
            Deprecation:
              description: |
                Wed, 15 Jan 2025 23:59:59 GMT
              schema:
                type: string
            Sunset:
              description: |
                Tue, 15 Apr 2025 23:59:59 GMT
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1Beta1SubscriptionDetail'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeBadRequestError'
              examples:
                error_bad_request:
                  value:
                    errorCode: HPE_GL_ERROR_BAD_REQUEST
                    message: Bad Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 400
                    errorDetails:
                      - type: hpe.greenlake.bad_request
                        issues:
                          - source: query.parameter
                            subject: Id
                            description: Id is not a valid UUID.
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unauthorized_request:
                  value:
                    errorCode: HPE_GL_ERROR_UNAUTHORIZED
                    message: Unauthorized Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 401
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Token provided is invalid
        '403':
          description: The operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_forbidden_request:
                  value:
                    errorCode: HPE_GL_ERROR_FORBIDDEN
                    message: Forbidden Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 403
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Permission is denied to perform requested operation.
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unprocessable_request:
                  value:
                    errorCode: HPE_GL_UNPROCESSABLE_CONTENT
                    message: Unprocessable Content
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 422
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          content: Could not process the content.
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_too_many_request:
                  value:
                    errorCode: HPE_GL_ERROR_TOO_MANY_REQUESTS
                    message: Too Many Requests
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 429
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          apiRateLimit: >-
                            Too Many Requests. Rate limit has exceeded a
                            predefined value.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeServerError'
              examples:
                error_internal_server_error:
                  value:
                    errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR
                    message: Internal Server Error
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 500
                    errorDetails:
                      - type: hpe.greenlake.retry_info
                        retryAfterSeconds: 30
  /subscriptions/v1beta1/async-operations/{id}:
    get:
      deprecated: true
      tags:
        - Subscriptions - v1beta1
      summary: Get progress or status of async operations in subscriptions
      description: >-
        Use this API to find the status of the asynchronous Add and update
        subscriptions API. <br><br> An asynchronous resource is  generated to
        track the status of an asynchronous operation. An asynchronous  resource
        that has reached a terminal state (`SUCCEEDED`, `FAILED`, `TIMEOUT`) 
        will no longer be accessible 24 hours after reaching the terminal
        state.<br><br> An  asynchronous resource is set to the `TIMEOUT` state
        if the resource  has been in an `INITIALIZED` or `RUNNING` state for a
        period greater than the  timeout set. If an asynchronous operation
        resource coming from an asynchronous  request consists of multiple
        subscriptions, a breakdown of succeeded  subscriptions and failed
        subscriptions, if there are any, is returned  as the response. In this
        case, the subscription key identifies each
        subscription.<br><br>**Note:** You need view permissions for the Devices
        and  Subscription service to invoke this API. <br><br> Rate limits are
        enforced on this API. 30 requests per minute is supported per workspace.
        API will result in `429` if this threshold is breached.
      operationId: getSubscriptionsAsyncOperationResource
      parameters:
        - name: id
          in: path
          required: true
          description: The unique identifier returned by an asynchronous API operation.
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          headers:
            Deprecation:
              description: |
                Wed, 15 Jan 2025 23:59:59 GMT
              schema:
                type: string
            Sunset:
              description: |
                Tue, 15 Apr 2025 23:59:59 GMT
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncOperationResource'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeBadRequestError'
              examples:
                error_bad_request:
                  value:
                    errorCode: HPE_GL_ERROR_BAD_REQUEST
                    message: Bad Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 400
                    errorDetails:
                      - type: hpe.greenlake.bad_request
                        issues:
                          - source: query.parameter
                            subject: Id
                            description: Id is not a valid UUID.
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unauthorized_request:
                  value:
                    errorCode: HPE_GL_ERROR_UNAUTHORIZED
                    message: Unauthorized Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 401
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Token provided is invalid
        '403':
          description: The operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_forbidden_request:
                  value:
                    errorCode: HPE_GL_ERROR_FORBIDDEN
                    message: Forbidden Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 403
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Permission is denied to perform requested operation.
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unprocessable_request:
                  value:
                    errorCode: HPE_GL_UNPROCESSABLE_CONTENT
                    message: Unprocessable Content
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 422
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          content: Could not process the content.
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_too_many_request:
                  value:
                    errorCode: HPE_GL_ERROR_TOO_MANY_REQUESTS
                    message: Too Many Requests
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 429
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          apiRateLimit: >-
                            Too Many Requests. Rate limit has exceeded a
                            predefined value.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeServerError'
              examples:
                error_internal_server_error:
                  value:
                    errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR
                    message: Internal Server Error
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 500
                    errorDetails:
                      - type: hpe.greenlake.retry_info
                        retryAfterSeconds: 30
  /subscriptions/v1alpha1/auto-subscription-settings:
    get:
      deprecated: true
      tags:
        - Auto Subscriptions settings - v1alpha1
      summary: Get all configured auto-subscriptions settings
      description: >-
        Get all configured auto-subscriptions settings in a workspace. 
        <br><br>**NOTE:** You need to have the view permission for the **Devices
        and subscription service** to invoke this API. <br><br> Rate limits are
        enforced on this API. 25 requests per minute is supported per workspace.
        API will result in `429` if this threshold is breached.
      operationId: getAutoSubscriptionsV1alpha1
      responses:
        '200':
          description: Successful response
          headers:
            Deprecation:
              description: |
                Wed, 15 Jan 2025 23:59:59 GMT
              schema:
                type: string
            Sunset:
              description: |
                Tue, 15 Apr 2025 23:59:59 GMT
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutoSubscriptionsResponsePaginatedDto'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeBadRequestError'
              examples:
                error_bad_request:
                  value:
                    errorCode: HPE_GL_ERROR_BAD_REQUEST
                    message: Bad Request.
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 400
                    errorDetails:
                      - type: hpe.greenlake.bad_request
                        issues:
                          - source: hpe.greenlake.devicemanagement
                            subject: Input validation failed
                            description: Required fields missing.
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unauthorized_request:
                  value:
                    errorCode: HPE_GL_ERROR_UNAUTHORIZED
                    message: Unauthorized Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 401
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Token provided is invalid
        '403':
          description: The operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_forbidden_request:
                  value:
                    errorCode: HPE_GL_ERROR_FORBIDDEN
                    message: Forbidden Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 403
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Permission is denied to perform requested operation.
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unprocessable_request:
                  value:
                    errorCode: HPE_GL_UNPROCESSABLE_CONTENT
                    message: Unprocessable Content
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 422
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          content: Could not process the content.
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_too_many_request:
                  value:
                    errorCode: HPE_GL_ERROR_TOO_MANY_REQUESTS
                    message: Too Many Requests
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 429
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          apiRateLimit: >-
                            Too Many Requests. Rate limit has exceeded a
                            predefined value.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeServerError'
              examples:
                error_internal_server_error:
                  value:
                    errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR
                    message: Internal Server Error
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 500
                    errorDetails:
                      - type: hpe.greenlake.retry_info
                        retryAfterSeconds: 30
  /subscriptions/v1alpha1/auto-subscription-settings/{id}:
    get:
      deprecated: true
      tags:
        - Auto Subscriptions settings - v1alpha1
      summary: Get configured auto-subscriptions settings per workspace
      description: >-
        Retrieve the configured auto-subscriptions settings in a workspace.
        <br><br> **NOTE:** You need to have view permission for the **Devices
        and subscription service** to invoke this API. <br><br> Rate limits are
        enforced on this API. 25 requests per minute is supported per workspace.
        API will result in `429` if this threshold is breached.
      operationId: getAutoSubscriptionByIdV1alpha1
      parameters:
        - name: id
          in: path
          description: The unique identifier of the workspace.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          headers:
            Deprecation:
              description: |
                Wed, 15 Jan 2025 23:59:59 GMT
              schema:
                type: string
            Sunset:
              description: |
                Tue, 15 Apr 2025 23:59:59 GMT
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutoSubscriptionsResponseDto'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeBadRequestError'
              examples:
                error_bad_request:
                  value:
                    errorCode: HPE_GL_ERROR_BAD_REQUEST
                    message: Bad Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 400
                    errorDetails:
                      - type: hpe.greenlake.bad_request
                        issues:
                          - source: query.parameter
                            subject: id
                            description: Parameter ID is missing.
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unauthorized_request:
                  value:
                    errorCode: HPE_GL_ERROR_UNAUTHORIZED
                    message: Unauthorized Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 401
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Token provided is invalid
        '403':
          description: The operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_forbidden_request:
                  value:
                    errorCode: HPE_GL_ERROR_FORBIDDEN
                    message: Forbidden Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 403
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Permission is denied to perform requested operation.
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_too_many_request:
                  value:
                    errorCode: HPE_GL_ERROR_TOO_MANY_REQUESTS
                    message: Too Many Requests
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 429
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          apiRateLimit: >-
                            Too Many Requests. Rate limit has exceeded a
                            predefined value.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeServerError'
              examples:
                error_internal_server_error:
                  value:
                    errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR
                    message: Internal Server Error
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 500
                    errorDetails:
                      - type: hpe.greenlake.retry_info
                        retryAfterSeconds: 30
    patch:
      deprecated: true
      tags:
        - Auto Subscriptions settings - v1alpha1
      summary: Update the configured auto-subscriptions settings of a workspace
      description: >-
        Update the configured auto-subscriptions managed in a workspace.
        <br><br> In the payload, you can pass a list of `deviceType` and `tier`
        combinations to be updated or created. If the combination of
        `deviceType` and `tier` is already configured, it is updated. Otherwise,
        the combination is created. If you need to remove settings for one or
        more combination of `deviceType` and `tier`, pass `tier` as null for the
        required `deviceType`. <br><br>**NOTE:** You need to have the edit
        permission for the **Devices and subscription service** to invoke this
        API. <br><br> Rate limits are enforced on this API. 25 requests per
        minute is supported per workspace. API will result in `429` if this
        threshold is breached.
      operationId: updateAutoSubscriptionsV1alpha1
      parameters:
        - name: id
          in: path
          description: The unique identifier of the auto subscription settings.
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/AutoSubscriptionsPostRequest'
        required: true
      responses:
        '200':
          description: Successful response
          headers:
            Deprecation:
              description: |
                Wed, 15 Jan 2025 23:59:59 GMT
              schema:
                type: string
            Sunset:
              description: |
                Tue, 15 Apr 2025 23:59:59 GMT
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutoSubscriptionsResponseDto'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeBadRequestError'
              examples:
                error_bad_request:
                  value:
                    errorCode: HPE_GL_ERROR_BAD_REQUEST
                    message: Bad Request.
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 400
                    errorDetails:
                      - type: hpe.greenlake.bad_request
                        issues:
                          - source: query.parameter
                            subject: id
                            description: Parameter ID is missing.
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unauthorized_request:
                  value:
                    errorCode: HPE_GL_ERROR_UNAUTHORIZED
                    message: Unauthorized Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 401
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Token provided is invalid
        '403':
          description: The operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_forbidden_request:
                  value:
                    errorCode: HPE_GL_ERROR_FORBIDDEN
                    message: Forbidden Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 403
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Permission is denied to perform requested operation.
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unprocessable_request:
                  value:
                    errorCode: HPE_GL_UNPROCESSABLE_CONTENT
                    message: Unprocessable Content
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 422
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          content: Could not process the content.
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_too_many_request:
                  value:
                    errorCode: HPE_GL_ERROR_TOO_MANY_REQUESTS
                    message: Too Many Requests
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 429
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          apiRateLimit: >-
                            Too Many Requests. Rate limit has exceeded a
                            predefined value.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeServerError'
              examples:
                error_internal_server_error:
                  value:
                    errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR
                    message: Internal Server Error
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 500
                    errorDetails:
                      - type: hpe.greenlake.retry_info
                        retryAfterSeconds: 30
  /subscriptions/v1/auto-subscription-settings:
    get:
      tags:
        - Auto Subscriptions settings - v1
      summary: Get all configured auto-subscriptions settings
      description: >-
        Get all configured auto-subscriptions settings in a workspace. 
        <br><br>**NOTE:** You need to have the view permission for the **Devices
        and subscription service** to invoke this API. <br><br> Rate limits are
        enforced on this API. 25 requests per minute is supported per workspace.
        The API returns `429` if this threshold is breached.
      operationId: getAutoSubscriptionsV1
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutoSubscriptionsResponsePaginatedDto'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeBadRequestError'
              examples:
                error_bad_request:
                  value:
                    errorCode: HPE_GL_ERROR_BAD_REQUEST
                    message: Bad Request.
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 400
                    errorDetails:
                      - type: hpe.greenlake.bad_request
                        issues:
                          - source: hpe.greenlake.devicemanagement
                            subject: Input validation failed
                            description: Required fields missing.
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unauthorized_request:
                  value:
                    errorCode: HPE_GL_ERROR_UNAUTHORIZED
                    message: Unauthorized Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 401
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Token provided is invalid
        '403':
          description: The operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_forbidden_request:
                  value:
                    errorCode: HPE_GL_ERROR_FORBIDDEN
                    message: Forbidden Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 403
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Permission is denied to perform requested operation.
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unprocessable_request:
                  value:
                    errorCode: HPE_GL_UNPROCESSABLE_CONTENT
                    message: Unprocessable Content
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 422
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          content: Could not process the content.
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_too_many_request:
                  value:
                    errorCode: HPE_GL_ERROR_TOO_MANY_REQUESTS
                    message: Too Many Requests
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 429
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          apiRateLimit: >-
                            Too Many Requests. Rate limit has exceeded a
                            predefined value.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeServerError'
              examples:
                error_internal_server_error:
                  value:
                    errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR
                    message: Internal Server Error
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 500
                    errorDetails:
                      - type: hpe.greenlake.retry_info
                        retryAfterSeconds: 30
  /subscriptions/v1/auto-subscription-settings/{id}:
    get:
      tags:
        - Auto Subscriptions settings - v1
      summary: Get configured auto-subscriptions settings per workspace
      description: >-
        Retrieve the configured auto-subscriptions settings in a workspace.
        <br><br> **NOTE:** You need to have view permission for the **Devices
        and subscription service** to invoke this API. <br><br> Rate limits are
        enforced on this API. 25 requests per minute is supported per workspace.
        The API returns `429` if this threshold is breached.
      operationId: getAutoSubscriptionByIdV1
      parameters:
        - name: id
          in: path
          description: The unique identifier of the workspace.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutoSubscriptionsResponseDto'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeBadRequestError'
              examples:
                error_bad_request:
                  value:
                    errorCode: HPE_GL_ERROR_BAD_REQUEST
                    message: Bad Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 400
                    errorDetails:
                      - type: hpe.greenlake.bad_request
                        issues:
                          - source: query.parameter
                            subject: id
                            description: Parameter ID is missing.
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unauthorized_request:
                  value:
                    errorCode: HPE_GL_ERROR_UNAUTHORIZED
                    message: Unauthorized Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 401
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Token provided is invalid
        '403':
          description: The operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_forbidden_request:
                  value:
                    errorCode: HPE_GL_ERROR_FORBIDDEN
                    message: Forbidden Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 403
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Permission is denied to perform requested operation.
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_too_many_request:
                  value:
                    errorCode: HPE_GL_ERROR_TOO_MANY_REQUESTS
                    message: Too Many Requests
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 429
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          apiRateLimit: >-
                            Too Many Requests. Rate limit has exceeded a
                            predefined value.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeServerError'
              examples:
                error_internal_server_error:
                  value:
                    errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR
                    message: Internal Server Error
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 500
                    errorDetails:
                      - type: hpe.greenlake.retry_info
                        retryAfterSeconds: 30
    patch:
      tags:
        - Auto Subscriptions settings - v1
      summary: Update the configured auto-subscriptions settings of a workspace
      description: >-
        Update the configured auto-subscriptions managed in a workspace.
        <br><br> In the payload, you can pass a list of `deviceType` and `tier`
        combinations to be updated or created. If the combination of
        `deviceType` and `tier` is already configured, it is updated. Otherwise,
        the combination is created. If you need to remove settings for one or
        more combination of `deviceType` and `tier`, pass `tier` as null for the
        required `deviceType`. <br><br>**NOTE:** You need to have the edit
        permission for the **Devices and subscription service** to invoke this
        API. <br><br> Rate limits are enforced on this API. 25 requests per
        minute is supported per workspace. The API returns `429` if this
        threshold is breached.
      operationId: updateAutoSubscriptionsV1
      parameters:
        - name: id
          in: path
          description: The unique identifier of the auto subscription settings.
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/merge-patch+json:
            schema:
              $ref: '#/components/schemas/AutoSubscriptionsPostRequest'
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutoSubscriptionsResponseDto'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeBadRequestError'
              examples:
                error_bad_request:
                  value:
                    errorCode: HPE_GL_ERROR_BAD_REQUEST
                    message: Bad Request.
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 400
                    errorDetails:
                      - type: hpe.greenlake.bad_request
                        issues:
                          - source: query.parameter
                            subject: id
                            description: Parameter ID is missing.
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unauthorized_request:
                  value:
                    errorCode: HPE_GL_ERROR_UNAUTHORIZED
                    message: Unauthorized Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 401
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Token provided is invalid
        '403':
          description: The operation is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_forbidden_request:
                  value:
                    errorCode: HPE_GL_ERROR_FORBIDDEN
                    message: Forbidden Request
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 403
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          access_token: Permission is denied to perform requested operation.
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_unprocessable_request:
                  value:
                    errorCode: HPE_GL_UNPROCESSABLE_CONTENT
                    message: Unprocessable Content
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 422
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          content: Could not process the content.
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeGeneralError'
              examples:
                error_too_many_request:
                  value:
                    errorCode: HPE_GL_ERROR_TOO_MANY_REQUESTS
                    message: Too Many Requests
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 429
                    errorDetails:
                      - type: hpe.greenlake.metadata
                        source: hpe.greenlake.subscriptionmanagement
                        metadata:
                          apiRateLimit: >-
                            Too Many Requests. Rate limit has exceeded a
                            predefined value.
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HpeGreenLakeServerError'
              examples:
                error_internal_server_error:
                  value:
                    errorCode: HPE_GL_ERROR_INTERNAL_SERVER_ERROR
                    message: Internal Server Error
                    debugId: abbeeb59-12cb-49a3-9ce5-55edba12213f
                    httpStatusCode: 500
                    errorDetails:
                      - type: hpe.greenlake.retry_info
                        retryAfterSeconds: 30
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
  headers:
    LocationHeader:
      schema:
        type: string
        example: >-
          /subscriptions/v1beta1/async-operations/22d6fbfb-d253-4455-984a-356da827e5fc
      description: The URI of the accepted asynchronous operation resource.
    LocationHeaderV1:
      schema:
        type: string
        example: >-
          /subscriptions/v1/async-operations/22d6fbfb-d253-4455-984a-356da827e5fc
      description: The URI of the accepted asynchronous operation resource.
  schemas:
    SubscriptionsPatchRequest:
      required:
        - tags
      properties:
        tags:
          type: object
          additionalProperties:
            type: object
            minProperties: 1
            maxProperties: 50
            properties:
              key:
                type: string
                minLength: 1
                maxLength: 128
                description: A tag key is the name used to refer to the tag.
              value:
                oneOf:
                  - type: string
                    minLength: 0
                    maxLength: 256
                    description: A tag value is a value applied to the tag key.
                  - type: 'null'
                    description: A tag value of null indicates a tag is to be deleted.
    RequestPostSubscription:
      required:
        - key
      type: object
      properties:
        key:
          type: string
          description: A subscription key.
        tags:
          type: object
          additionalProperties:
            type: object
            minProperties: 1
            maxProperties: 50
            properties:
              key:
                type: string
                minLength: 1
                maxLength: 128
                description: A tag key is the name used to refer to the tag.
              value:
                oneOf:
                  - type: string
                    minLength: 0
                    maxLength: 256
                    description: A tag value is a value applied to the tag key.
                  - type: 'null'
                    description: >-
                      A tag value of null indicates the the tag is to be
                      deleted.
    SubscriptionsPostRequest:
      required:
        - subscriptions
      type: object
      properties:
        subscriptions:
          type: array
          description: An array of subscription keys.
          items:
            $ref: '#/components/schemas/RequestPostSubscription'
    AsyncResponse:
      required:
        - code
        - status
        - transactionId
      type: object
      properties:
        code:
          type: integer
          format: int32
          description: Three digit HTTP status code.
        status:
          type: string
          enum:
            - 100 CONTINUE
            - 101 SWITCHING_PROTOCOLS
            - 102 PROCESSING
            - 103 CHECKPOINT
            - 200 OK
            - 201 CREATED
            - 202 ACCEPTED
            - 203 NON_AUTHORITATIVE_INFORMATION
            - 204 NO_CONTENT
            - 205 RESET_CONTENT
            - 206 PARTIAL_CONTENT
            - 207 MULTI_STATUS
            - 208 ALREADY_REPORTED
            - 226 IM_USED
            - 300 MULTIPLE_CHOICES
            - 301 MOVED_PERMANENTLY
            - 302 FOUND
            - 302 MOVED_TEMPORARILY
            - 303 SEE_OTHER
            - 304 NOT_MODIFIED
            - 305 USE_PROXY
            - 307 TEMPORARY_REDIRECT
            - 308 PERMANENT_REDIRECT
            - 400 BAD_REQUEST
            - 401 UNAUTHORIZED
            - 402 PAYMENT_REQUIRED
            - 403 FORBIDDEN
            - 404 NOT_FOUND
            - 405 METHOD_NOT_ALLOWED
            - 406 NOT_ACCEPTABLE
            - 407 PROXY_AUTHENTICATION_REQUIRED
            - 408 REQUEST_TIMEOUT
            - 409 CONFLICT
            - 410 GONE
            - 411 LENGTH_REQUIRED
            - 412 PRECONDITION_FAILED
            - 413 PAYLOAD_TOO_LARGE
            - 413 REQUEST_ENTITY_TOO_LARGE
            - 414 URI_TOO_LONG
            - 414 REQUEST_URI_TOO_LONG
            - 415 UNSUPPORTED_MEDIA_TYPE
            - 416 REQUESTED_RANGE_NOT_SATISFIABLE
            - 417 EXPECTATION_FAILED
            - 418 I_AM_A_TEAPOT
            - 419 INSUFFICIENT_SPACE_ON_RESOURCE
            - 420 METHOD_FAILURE
            - 421 DESTINATION_LOCKED
            - 422 UNPROCESSABLE_ENTITY
            - 423 LOCKED
            - 424 FAILED_DEPENDENCY
            - 425 TOO_EARLY
            - 426 UPGRADE_REQUIRED
            - 428 PRECONDITION_REQUIRED
            - 429 TOO_MANY_REQUESTS
            - 431 REQUEST_HEADER_FIELDS_TOO_LARGE
            - 451 UNAVAILABLE_FOR_LEGAL_REASONS
            - 500 INTERNAL_SERVER_ERROR
            - 501 NOT_IMPLEMENTED
            - 502 BAD_GATEWAY
            - 503 SERVICE_UNAVAILABLE
            - 504 GATEWAY_TIMEOUT
            - 505 HTTP_VERSION_NOT_SUPPORTED
            - 506 VARIANT_ALSO_NEGOTIATES
            - 507 INSUFFICIENT_STORAGE
            - 508 LOOP_DETECTED
            - 509 BANDWIDTH_LIMIT_EXCEEDED
            - 510 NOT_EXTENDED
            - 511 NETWORK_AUTHENTICATION_REQUIRED
          description: Three digit HTTPS status code and message.
        transactionId:
          type: string
    AsyncOperationResource:
      type: object
      required:
        - id
        - type
      properties:
        status:
          type: string
          enum:
            - INITIALIZED
            - RUNNING
            - FAILED
            - SUCCEEDED
            - TIMEDOUT
            - PAUSED
          description: The current status of the asynchronous operation.
        startedAt:
          type: string
          format: date-time
          description: Time the asynchronous operation started.
        endedAt:
          type: string
          format: date-time
          description: Time the asynchronous operation ended.
        progressPercent:
          type: integer
          format: int32
          description: Percentage completion of the asynchronous operation.
        suggestedPollingIntervalSeconds:
          type: integer
          format: int32
          description: >-
            The suggested time to wait (in minutes) before calling the operation
            again.
        timeoutMinutes:
          type: integer
          format: int32
          description: The number of minutes before the operation will time out.
        result:
          type: object
          description: >-
            An array that provides information on successful or unsuccessful
            operations.
        resultType:
          type: string
          description: >-
            Relates individual subscriptions to a result category that indicates
            successfull or unsuccessful operations
        id:
          type: string
          example: 3292c36d-30ef-4£26-823b-76b5d213b670
          description: The unique identifier of the asynchronous operation.
        type:
          type: string
          example: subscriptions/asyncOperation
          description: The type of the resource.
        error:
          $ref: '#/components/schemas/HpeGreenLakeGeneralError'
    Appointment:
      type: object
      properties:
        subscriptionStart:
          type: string
          example: '2023-02-10T00:00:00.000Z'
          description: Start date of the subscription.
        subscriptionEnd:
          type: string
          example: '2023-02-10T00:00:00.000Z'
          description: End date of the subscription.
        delayedActivation:
          type: string
          example: '2023-02-10T00:00:00.000Z'
          description: Delayed activation date of the subscription.
    SubscriptionDetail:
      required:
        - id
      type: object
      properties:
        id:
          maxLength: 36
          minLength: 0
          type: string
          example: b49bf6d2-02b4-4735-9ae5-f88834af9b7e
          description: The unique identifier for the subscription.
        key:
          type: string
          example: BAASOAAg95
          description: The subscription key.
        quantity:
          type: string
          example: 10
          description: Total quantity of the subscription.
        evaluationType:
          type: string
          enum:
            - EVAL
            - ALPHA
            - NONE
          description: The type of license.
        productSku:
          type: string
          example: ROTO1AAE
          description: The product stock keeping unit (SKU).
        productDescription:
          type: string
          example: HPE GreenLake for Block Storage 3 Year(s)
          description: A description of the product stock keeping unit.
        quote:
          type: string
          example: quote1
          description: >-
            A unique number that identifies an order and all its attached
            subscriptions.
        po:
          type: string
          example: POAQE451
          description: The purchase order number.
        contract:
          type: string
          example: V16BMAAS
        endUserName:
          type: string
          example: ACCUTECH DATA SUPPLIES, INC.
          description: The customer name to which the subscription belongs.
        orderClass:
          type: string
          example: class1
          description: The ordering system source.
        aasType:
          type: string
          enum:
            - IAAS
          description: >-
            Defines the as a service (aaS) type. For example, infrastructure as
            a service (IAAS).
        appointment:
          $ref: '#/components/schemas/Appointment'
    SubscriptionsGetResponse:
      type: object
      required:
        - items
        - count
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionDetail'
        count:
          type: integer
          format: int32
          example: 20
          description: Number of items returned.
        offset:
          type: integer
          format: int32
          example: 0
          description: Zero-based resource offset.
        total:
          type: integer
          format: int32
          example: 100
          description: >-
            Total number of items in the collection that match the filter query,
            if one was provided in the request otherwise total number of items
            for a given resource.
    AutoSubscriptionsPostRequest:
      required:
        - autoSubscriptions
      type: object
      properties:
        autoSubscriptionSettings:
          type: array
          items:
            $ref: '#/components/schemas/RequestPostAutoSubscription'
    RequestPostAutoSubscription:
      required:
        - deviceType
        - tier
      type: object
      properties:
        deviceType:
          type: string
          enum:
            - AP
            - SWITCH
            - GATEWAY
            - STORAGE
            - DHCI_STORAGE
            - COMPUTE
            - DHCI_COMPUTE
            - NW_THIRD_PARTY
            - PCE
            - SD_WAN_GW
            - OPSRAMP_SAAS
            - SD_SAAS
            - SENSOR
            - BRIDGES
        tier:
          type: string
          enum:
            - FOUNDATION_AP
            - ADVANCED_AP
            - FOUNDATION_SWITCH
            - ADVANCED_SWITCH
            - FOUNDATION_GW
            - ADVANCED_GW
            - STANDARD_COMPUTE
            - FOUNDATION_NW_THIRD_PARTY
            - ADVANCED_NW_THIRD_PARTY
            - ENHANCED_COMPUTE
            - FOUNDATION_SENSOR
            - FOUNDATION_SD_WAN
            - ADVANCED_SD_WAN
    AutoSubscriptionSettings:
      required:
        - deviceType
        - tier
      type: object
      properties:
        deviceType:
          type: string
          enum:
            - AP
            - SWITCH
            - GATEWAY
            - STORAGE
            - DHCI_STORAGE
            - COMPUTE
            - DHCI_COMPUTE
            - NW_THIRD_PARTY
            - PCE
            - SD_WAN_GW
            - OPSRAMP_SAAS
            - SD_SAAS
            - SENSOR
            - BRIDGES
            - BRIDGE
        tier:
          type: string
          enum:
            - FOUNDATION_AP
            - ADVANCED_AP
            - FOUNDATION_SWITCH
            - ADVANCED_SWITCH
            - FOUNDATION_GW
            - ADVANCED_GW
            - STANDARD_COMPUTE
            - FOUNDATION_NW_THIRD_PARTY
            - ADVANCED_NW_THIRD_PARTY
            - ENHANCED_COMPUTE
            - FOUNDATION_SENSOR
            - FOUNDATION_SD_WAN
            - ADVANCED_SD_WAN
    AutoSubscriptionsResponsePaginatedDto:
      type: object
      required:
        - count
        - items
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/AutoSubscriptionsResponseDtoWithTenant'
        count:
          type: integer
          format: int32
          example: 10
          description: Number of items returned.
        offset:
          type: integer
          format: int32
          example: 0
          description: Zero-based resource offset.
        total:
          type: integer
          format: int32
          example: 50
          description: >-
            Total number of items in the collection that match the filter query,
            if one was provided in the request otherwise total number of items
            for a given resource.
    AutoSubscriptionsResponseDtoWithTenant:
      required:
        - createdAt
        - id
        - resourceUri
        - updatedAt
        - type
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the tenant.
          example: 64343c3c-3016-4234-baee-765651aa4bb3
        createdAt:
          type: string
          description: Time of auto-subscription creation.
          example: '2024-02-07T11:20:35.290Z'
        updatedAt:
          type: string
          description: Time of last auto-subscription update.
          example: '2024-02-07T11:22:35.800Z'
        generation:
          type: integer
          format: int32
          example: 0
          description: Monotonically increasing update counter.
        type:
          type: string
          example: subscriptions/auto-subscription-settings.
          description: Type of the resource
        resourceUri:
          type: string
          description: URI to the auto-subscription.
        autoSubscriptionSettings:
          type: array
          items:
            $ref: '#/components/schemas/AutoSubscriptionSettings'
        tenantWorkspaceId:
          type: string
          description: The unique identifier of a tenant workspace.
    AutoSubscriptionsResponseDto:
      required:
        - createdAt
        - id
        - resourceUri
        - updatedAt
        - type
      type: object
      properties:
        id:
          type: string
          example: 64343c3c-3016-4234-baee-765651aa4bb3
          description: The unique identifier of the auto-subscription.
        createdAt:
          type: string
          example: '2024-02-07T11:20:35.290Z'
          description: The time of auto-subscription creation.
        updatedAt:
          type: string
          example: '2024-02-07T11:22:35.800Z'
          description: The time of last auto-subscription update.
        generation:
          type: integer
          format: int32
          example: 0
          description: Monotonically increasing update counter.
        type:
          type: string
          example: subscriptions/auto-subscription-settings
          description: The type of the resource.
        resourceUri:
          type: string
          description: URI to the auto-subscription.
        autoSubscriptionSettings:
          type: array
          items:
            $ref: '#/components/schemas/AutoSubscriptionSettings'
    V1Beta1SubscriptionsGetResponse:
      type: object
      required:
        - items
        - count
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/V1Beta1SubscriptionDetail'
        count:
          type: integer
          format: int32
          example: 30
          description: The number of items returned.
        offset:
          type: integer
          format: int32
          example: 0
          description: Zero-based resource offset.
        total:
          type: integer
          format: int32
          example: 100
          description: >-
            Total number of items in the collection that match the filter query,
            if one was provided in the request otherwise total number of items
            for a given resource.
    V1Beta1SubscriptionDetail:
      required:
        - id
        - type
      type: object
      properties:
        id:
          maxLength: 36
          minLength: 0
          type: string
          example: 64343c3c-3016-4234-baee-765651aa4bb3
          description: The primary unique identifier of the subscription.
        type:
          type: string
          description: The type of the resource.
          example: subscriptions/subscription
        subscriptionType:
          type: string
          enum:
            - CENTRAL_AP
            - CENTRAL_SWITCH
            - CENTRAL_CONTROLLER
            - CENTRAL_GW
            - SERVICE
            - CENTRAL_STORAGE
            - CENTRAL_COMPUTE
            - SUPPORT
            - CENTRAL_NW_THIRD_PARTY
            - PRIVATE_CLOUD_ENTERPRISE
            - OPSRAMP
            - UXI_SENSOR_CLOUD
            - UXI_SENSOR_LTE
            - UXI_AGENT_CLOUD
            - UXI_AGENT_ANDROID
            - UNKNOWN
          example:
            - CENTRAL_STORAGE
          description: Type of the subscription.
        subscriptionStatus:
          type: string
          enum:
            - STARTED
            - ENDED
            - SUSPENDED
            - CANCELLED
            - LOCKED
            - NONE
          description: >-
            The status of the subscription. This property indicates if the
            subscription is started, ended, suspended, cancelled, or locked.
        createdAt:
          type: string
          example: '2024-02-07T11:20:35.290Z'
          description: Time of subscription creation.
        updatedAt:
          type: string
          example: '2024-02-07T11:22:35.290Z'
          description: Time when subscription was last updated.
        key:
          type: string
          description: The subscription key.
        quantity:
          type: string
          example: 20
          description: Total quantity of the subscription
        availableQuantity:
          type: string
          example: 10
          description: Available quantity of the subscription.
        isEval:
          type: boolean
          description: >-
            A boolean that states if the subscription is an evaluation
            subscription or not.
        sku:
          type: string
          description: The stock keeping unit (SKU).
        skuDescription:
          type: string
          description: A description of the stock keeping unit.
        contract:
          type: string
        startTime:
          type: string
          example: '2024-04-01T00:00:00.000Z'
          description: Start time of the subscription.
        endTime:
          type: string
          example: '2024-04-30T00:00:00.000Z'
          description: End time of the subscription.
        tags:
          type: object
          additionalProperties:
            type: string
            description: >-
              A tag is a form of metadata applied to any resource and primarily
              used to categorize resources.
        productType:
          type: string
          enum:
            - DEVICE
            - SERVICE
            - MANDATORY_ATTACHED
            - ON_PREM
            - SUPPORT
          description: Product type of the subscription.
        tier:
          type: string
          enum:
            - BASIC_AP
            - BASIC_SWITCH
            - SPECIAL
            - FOUNDATION_70XX
            - ADVANCE_70XX
            - FOUNDATION_7005
            - ADVANCE_7005
            - FOUNDATION_72XX
            - ADVANCE_72XX
            - ADVANCE_90XX_SEC
            - FOUNDATION_BASE_90XX_SEC
            - FOUNDATION_90XX_SEC
            - SDWAN_SECURITY
            - DEVICE_PROFILING
            - VGW_500M
            - VGW_2G
            - VGW_4G
            - ANALYTICS
            - NETWORK_ACCESS_CONTROL
            - FOUNDATION_AP
            - ADVANCED_AP
            - BRIDGE
            - FOUNDATION_BRIDGE
            - FOUNDATION_WLAN_GW
            - FOUNDATION_SWITCH_6100
            - FOUNDATION_SWITCH_6200
            - FOUNDATION_SWITCH_6300
            - FOUNDATION_SWITCH_6400
            - FOUNDATION_SWITCH_8400
            - FOUNDATION_SWITCH_8XXX_9XXX_10XXX
            - ADVANCED_SWITCH_6100
            - ADVANCED_SWITCH_6200
            - ADVANCED_SWITCH_6300
            - ADVANCED_SWITCH_6400
            - ADVANCED_SWITCH_8400
            - ADVANCED_SWITCH_8XXX_9XXX_10XXX
            - ADVANCED_PROLIANT
            - FOUNDATION_PROLIANT
            - STANDARD_PROLIANT
            - ENHANCED_PROLIANT
            - FOUNDATION_SDFLEX
            - STANDARD_SDFLEX
            - ENHANCED_SDFLEX
            - FOUNDATION_EDGELINE
            - STANDARD_EDGELINE
            - ENHANCED_EDGELINE
            - FOUNDATION_VM_BACKUP
            - STANDARD_VM_BACKUP
            - ENHANCED_VM_BACKUP
            - FOUNDATION_ZERTO
            - FOUNDATION_ZERTO_LEGACY
            - NO_TIER_ZERTO
            - FOUNDATION_SFM
            - STANDARD_OVOPSMGMT
            - ENHANCED_OVOPSMGMT
            - FOUNDATION_ALLETRA
            - STANDARD_ALLETRA
            - ENHANCED_ALLETRA
            - ADVANCED_ALLETRA_4K
            - STANDARD_ALLETRA_4K
            - ENHANCED_ALLETRA_4K
            - MCP_BAAS
            - MCV_BAAS
            - MCB_BAAS
            - BCP_BAAS
            - BCV_BAAS
            - BCB_BAAS
            - GPP_BAAS
            - GPV_BAAS
            - GPB_BAAS
            - GPP_HCIAAS
            - GPB_HCIAAS
            - GPV_HCIAAS
            - EVP_HCIAAS
            - EVB_HCIAAS
            - EPP_HCIAAS
            - EPB_HCIAAS
            - BCP_HCIAAS
            - BCV_HCIAAS
            - BCB_HCIAAS
            - AFP_HCIAAS
            - AFB_HCIAAS
            - AFV_HCIAAS
            - HFP_HCIAAS
            - HFB_HCIAAS
            - HFV_HCIAAS
            - FOUNDATION_BLOCK_STORAGE
            - FOUNDATION_HCI_MANAGER
            - FOUNDATION_CARE_EMBEDDED
            - FOUNDATION_CARE_PLUS_EMBEDDED
            - FOUNDATION_NW_THIRD_PARTY
            - ADVANCED_NW_THIRD_PARTY
            - WLAN_ADVANCED_90XX_SEC
            - WLAN_ADVANCED_92XX_SEC
            - FOUNDATION_92XX_SEC
            - ADVANCED_92XX_SEC
            - WLAN_ADVANCED_90XX_70XX
            - WLAN_ADVANCED_92XX_72XX
            - WLAN_ADVANCED_91XX
            - WLAN_ADVANCED_91XX_SEC
            - FOUNDATION_91XX
            - FOUNDATION_91XX_SEC
            - ADVANCED_91XX
            - ADVANCED_91XX_SEC
            - SMALL_VM_BACKUP
            - MEDIUM_VM_BACKUP
            - LARGE_VM_BACKUP
            - XLARGE_VM_BACKUP
            - PRIVATE_CLOUD_ENTERPRISE
            - STA
            - STB
            - STC
            - ES
            - PR
            - ET
            - ST
            - FOUNDATION_MLDE
            - FOUNDATION_SENSOR_CLOUD
            - FOUNDATION_SENSOR_LTE
            - FOUNDATION_ZEBRA_AGENT_CLOUD
            - FOUNDATION_AGENT_CLOUD
            - SDWAN_FO_EC_HUB
            - SDWAN_AD_EC_HUB
            - FOUNDATION_STORAGE
            - FOUNDATION_EZMERAL_K8S
            - ONPREM_SERVICE
            - FOUNDATION_SUPER_COMPUTING
            - HPE_ALLETRA_STORAGE_MP_B10000_SOFTWARE_AND_SUPPORT_SAAS
            - CENTRAL_OPSRAMP_EXTENSION
            - UNKNOWN
          description: Tier of the subscription.
          example: SMALL_VM_BACKUP
        tierDescription:
          type: string
          description: Description of the subscription tier.
          example: Small Back-Up & Recovery Service
        quote:
          type: string
          description: The unique identifier for an order and all associated subscriptions.
        po:
          type: string
          description: The purchase order (PO) that is associated with the subscription.
        resellerPo:
          type: string
          description: >-
            The reseller purchase order (PO) that is associated with the
            subscription. Used for indirect orders.
    GeneralErrorDetail:
      type: object
      required:
        - type
        - source
        - metadata
      properties:
        type:
          type: string
          description: The type of error.
        source:
          type: string
          description: The source of the error.
        metadata:
          type: object
          description: Additional key pairs.
          additionalProperties:
            type: object
    HpeGreenLakeGeneralError:
      type: object
      required:
        - httpStatusCode
        - errorCode
        - message
        - debugId
      properties:
        httpStatusCode:
          type: integer
          format: int32
          description: The HTTP equivalent status code.
        errorCode:
          type: string
          description: >-
            A unique machine-friendly, but human-readable identifier for the
            error.
        message:
          type: string
          description: A user-friendly error message.
        debugId:
          type: string
          example: 64343c3c-3016-4234-baee-765651aa4bb3
          description: A unique identifier for the instance of this error.
        errorDetails:
          type: array
          items:
            $ref: '#/components/schemas/GeneralErrorDetail'
    BadRequestErrorDetail:
      type: object
      required:
        - type
        - issues
      properties:
        type:
          type: string
          description: The type of error details.
        issues:
          type: array
          description: An array of bad request issues.
          items:
            $ref: '#/components/schemas/ErrorIssue'
    ErrorIssue:
      type: object
      properties:
        source:
          type: string
          description: The source of the error.
        subject:
          type: string
          description: The specific issue key.
        description:
          type: string
          description: A brief explanation of the error.
    HpeGreenLakeBadRequestError:
      type: object
      required:
        - httpStatusCode
        - errorCode
        - message
        - debugId
      properties:
        httpStatusCode:
          type: integer
          format: int32
          description: The HTTP equivalent status code.
        errorCode:
          type: string
          description: >-
            A unique machine-friendly, but human-readable identifier for the
            error.
        message:
          type: string
          description: A user-friendly error message.
        debugId:
          type: string
          example: 64343c3c-3016-4234-baee-765651aa4bb3
          description: A unique identifier for the instance of this error.
        errorDetails:
          type: array
          items:
            $ref: '#/components/schemas/BadRequestErrorDetail'
    HpeGreenLakeServerError:
      type: object
      required:
        - httpStatusCode
        - errorCode
        - message
        - debugId
      properties:
        httpStatusCode:
          type: integer
          format: int32
          description: The HTTP equivalent status code.
        errorCode:
          type: string
          description: >-
            A unique machine-friendly, but human-readable identifier for the
            error.
        message:
          type: string
          description: A user-friendly error message.
        debugId:
          type: string
          example: 64343c3c-3016-4234-baee-765651aa4bb3
          description: A unique identifier for the instance of this error.
        errorDetails:
          type: array
          items:
            $ref: '#/components/schemas/ServerErrorDetail'
    ServerErrorDetail:
      type: object
      required:
        - type
        - retryAfterSeconds
      properties:
        type:
          type: string
        retryAfterSeconds:
          type: integer
          format: int32
    SubscriptionsBulkUnclaimRequest:
      required:
        - items
      type: object
      properties:
        items:
          type: array
          description: An array of subscription IDs.
          items:
            $ref: '#/components/schemas/BulkUnclaimId'
    BulkUnclaimId:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          description: Subscription ID.
  examples:
    CreateNewTags:
      summary: Create new tag(s) for a subscription
      description: >-
        The `location` tag is created with `San Jose`, the `purchase month` tag
        is created with `April 2023` , and the `Setup Option` tag is created
        with `Default`.
      value:
        tags:
          location: San Jose
          purchase month: April 2023
          Setup Option: Default
    UpdateExistingTagsWithNewTagValues:
      summary: Update existing tag(s) with new values
      description: >-
        The `location` tag is updated with `Los Angeles` and the `Setup Option`
        tag is updated with `Simplified`.
      value:
        tags:
          location: Los Angeles
          Setup Option: Simplified
    DeleteExistingTags:
      summary: Remove existing tag(s) from a subscription
      description: The `purchase month` tag is removed.
      value:
        tags:
          purchase month: null
    UpdateAndDeleteExistingTags:
      summary: Update existing tag(s) with new values and remove existing tag(s)
      description: >-
        The `location` tag is updated with `San Francisco` and the `Setup
        Option` tag is removed.
      value:
        tags:
          location: San Francisco
          Setup Option: null
    UnclaimSubscriptions:
      summary: Unclaim subscriptions in bulk
      description: Subscriptions are unclaimed from the workspaces
      value:
        items:
          - id: 64343c3c-3016-4234-baee-765651aa4bb3
          - id: 64343c3c-3016-4234-baee-765651aa4bb4
