Snow Software Periods API

openapi: 3.2.0
info:
  title: 'SAM: Licenses Periods API'
  contact:
    name: Flexera
    url: https://www.flexera.com
  version: 1.7.0
servers:
- url: https://{region}.snowsoftware.io
  description: You can find your **Data region** in the **Snow Atlas settings** menu, in **License details**. Your **Data region** is on the **General information** tab. For further information, see [General information](https://docs.snowsoftware.com/snow-atlas/en/UUID-2d4ce22b-e2a9-b7b0-44b8-0ecc55c2959f.html#UUID-2d4ce22b-e2a9-b7b0-44b8-0ecc55c2959f_section-idm4543865842761633102149279789 "https://docs.snowsoftware.com/snow-atlas/en/UUID-2d4ce22b-e2a9-b7b0-44b8-0ecc55c2959f.html#UUID-2d4ce22b-e2a9-b7b0-44b8-0ecc55c2959f_section-idm4543865842761633102149279789").
  variables:
    region:
      enum:
      - westeurope
      - australiasoutheast
      - eastus2
      - uksouth
      default: westeurope
tags:
- name: Periods
paths:
  /api/sam/v1/licenses/maintenance-periods:
    get:
      tags:
      - Periods
      summary: Get Maintenance and Support Periods
      description: Returns a collection of maintenance and support periods.
      operationId: getLicenseMaintenanceAndSupportPeriods
      parameters:
      - name: filter
        in: query
        description: For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).
        schema:
          type: string
        example: filter=status -eq "active"
      - name: page_number
        in: query
        description: The page number.
        schema:
          type: integer
          default: 1
          minimum: 1
      - name: page_size
        in: query
        description: The maximum number of items in the response.
        schema:
          type: integer
          default: 100
          minimum: 1
      responses:
        '200':
          description: 'OK: Your request succeeded.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HateoasCollectionOfMaintenancePeriodCollection'
        '400':
          description: 'Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 400
                  message: 'Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.'
        '500':
          description: 'Internal Server Error: Your request failed due to an internal error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 500
                  message: The service encountered an unexpected condition that prevented it from fulfilling the request.
      security:
      - BearerAuth:
        - sam.license.r
  /api/sam/v1/licenses/{id}/maintenance-periods:
    get:
      tags:
      - Periods
      summary: Get License's Maintenance and Support Periods
      description: Returns a collection of maintenance and support periods.
      operationId: getLicenseMaintenanceAndSupportPeriodsByLicenseId
      parameters:
      - name: id
        in: path
        required: true
        description: The unique ID of the license.
        schema:
          type: string
        example: 49cdd99f-bc16-40f9-ad40-48f12182fb30
      - name: filter
        in: query
        description: For more information on the available operators and which data types those operators work on, see [Filter API call results](https://docs.snowsoftware.io/snow-atlas-api/resources/get-started-with-apis/api-conventions#filter-api-call-results).
        schema:
          type: string
        example: filter=status -eq "active"
      - name: page_number
        in: query
        description: The page number.
        schema:
          type: integer
          default: 1
          minimum: 1
      - name: page_size
        in: query
        description: The maximum number of items in the response.
        schema:
          type: integer
          default: 100
          minimum: 1
      responses:
        '200':
          description: 'OK: Your request succeeded.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HateoasCollectionOfMaintenancePeriodCollection'
        '400':
          description: 'Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 400
                  message: 'Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.'
        '404':
          description: 'Not Found: The operation you requested failed because a resource associated with your request could not be found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 404
                  message: Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found.
        '500':
          description: 'Internal Server Error: Your request failed due to an internal error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 500
                  message: The service encountered an unexpected condition that prevented it from fulfilling the request.
      security:
      - BearerAuth:
        - sam.license.r
    post:
      tags:
      - Periods
      summary: Add Maintenance and Support Period
      description: Creates a maintenance and support period.
      operationId: addMaintenanceAndSupportPeriod
      parameters:
      - name: id
        in: path
        required: true
        description: The unique ID of the license.
        schema:
          type: string
        example: 49cdd99f-bc16-40f9-ad40-48f12182fb30
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MaintenancePeriodRequest'
      responses:
        '201':
          description: 'Created: Your request created something new. Usually, this is a call that used the POST method and will allow a GET method to retrieve it later.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatedHateoasResponse'
        '400':
          description: 'Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 400
                  message: 'Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.'
        '404':
          description: 'Not Found: The operation you requested failed because a resource associated with your request could not be found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 404
                  message: Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found.
        '500':
          description: 'Internal Server Error: Your request failed due to an internal error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 500
                  message: The service encountered an unexpected condition that prevented it from fulfilling the request.
      security:
      - BearerAuth:
        - sam.license.crud
    put:
      tags:
      - Periods
      summary: Replace Maintenance and Support Periods
      description: Replaces the given license’s maintenance and support periods.
      operationId: replaceMaintenanceAndSupportPeriods
      parameters:
      - name: id
        in: path
        required: true
        description: The unique ID of the license.
        schema:
          type: string
        example: 49cdd99f-bc16-40f9-ad40-48f12182fb30
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListOfMaintenancePeriodRequest'
      responses:
        '200':
          description: 'OK: Your request succeeded.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HateoasCollectionOfMaintenancePeriodCollection'
        '400':
          description: 'Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 400
                  message: 'Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.'
        '404':
          description: 'Not Found: The operation you requested failed because a resource associated with your request could not be found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 404
                  message: Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found.
        '500':
          description: 'Internal Server Error: Your request failed due to an internal error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 500
                  message: The service encountered an unexpected condition that prevented it from fulfilling the request.
      security:
      - BearerAuth:
        - sam.license.crud
    delete:
      tags:
      - Periods
      summary: Delete Maintenance and Support Periods
      description: Removes the given license’s maintenance and support periods.
      operationId: deleteMaintenanceAndSupportPeriods
      parameters:
      - name: id
        in: path
        required: true
        description: The unique ID of the license.
        schema:
          type: string
        example: 49cdd99f-bc16-40f9-ad40-48f12182fb30
      responses:
        '204':
          description: 'No Content: Your request succeeded, but the response message was empty.'
        '400':
          description: 'Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 400
                  message: 'Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.'
        '404':
          description: 'Not Found: The operation you requested failed because a resource associated with your request could not be found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 404
                  message: Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found.
        '500':
          description: 'Internal Server Error: Your request failed due to an internal error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 500
                  message: The service encountered an unexpected condition that prevented it from fulfilling the request.
      security:
      - BearerAuth:
        - sam.license.crud
  /api/sam/v1/licenses/{id}/maintenance-periods/{periodId}:
    put:
      tags:
      - Periods
      summary: Replace Maintenance and Support Period
      description: Replaces the given maintenance and support period.
      operationId: replaceMaintenanceAndSupportPeriod
      parameters:
      - name: id
        in: path
        required: true
        description: The unique ID of the license.
        schema:
          type: string
        example: 49cdd99f-bc16-40f9-ad40-48f12182fb30
      - name: periodId
        in: path
        required: true
        description: The unique ID of the maintenance and support period.
        schema:
          type: string
        example: 49cdd99f-bc16-40f9-ad40-48f12182fb30
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MaintenancePeriodRequest'
      responses:
        '200':
          description: 'OK: Your request succeeded.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaintenancePeriod'
        '400':
          description: 'Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 400
                  message: 'Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.'
        '404':
          description: 'Not Found: The operation you requested failed because a resource associated with your request could not be found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 404
                  message: Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found.
        '500':
          description: 'Internal Server Error: Your request failed due to an internal error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 500
                  message: The service encountered an unexpected condition that prevented it from fulfilling the request.
      security:
      - BearerAuth:
        - sam.license.crud
    delete:
      tags:
      - Periods
      summary: Delete Maintenance and Support Period
      description: Removes the given maintenance and support period.
      operationId: deleteMaintenancePeriod
      parameters:
      - name: id
        in: path
        required: true
        description: The unique ID of the license.
        schema:
          type: string
        example: 49cdd99f-bc16-40f9-ad40-48f12182fb30
      - name: periodId
        in: path
        required: true
        description: The unique ID of the maintenance and support period.
        schema:
          type: string
        example: 49cdd99f-bc16-40f9-ad40-48f12182fb30
      responses:
        '204':
          description: 'No Content: Your request succeeded, but the response message was empty.'
        '400':
          description: 'Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 400
                  message: 'Bad Request: Your request is invalid or improperly formed. Consequently, the API server could not understand your request.'
        '404':
          description: 'Not Found: The operation you requested failed because a resource associated with your request could not be found.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 404
                  message: Resource with ID '32aeda0a-80dc-475a-907f-2d250a3a8614' not found.
        '500':
          description: 'Internal Server Error: Your request failed due to an internal error.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: 500
                  message: The service encountered an unexpected condition that prevented it from fulfilling the request.
      security:
      - BearerAuth:
        - sam.license.crud
components:
  schemas:
    Link:
      type: object
      description: Represents a hypermedia link referenced from a IResource, according to HATEOAS.
      additionalProperties: false
      properties:
        href:
          type:
          - string
          - 'null'
          description: The associated relative URL.
          example: /api/custom-fields/v1/custom-fields
        rel:
          type:
          - string
          - 'null'
          description: Specifies the relationship between the current document and the linked document/resource.
          example: self
        method:
          type:
          - string
          - 'null'
          description: The method to access related resources.
          example: GET
    MaintenancePeriodRequest:
      type: object
      additionalProperties: false
      properties:
        agreementPeriodId:
          type:
          - string
          - 'null'
          description: The unique ID of the agreement period.
          format: guid
          example: 49cdd99f-bc16-40f9-ad40-48f12182fb30
        validFrom:
          type:
          - string
          - 'null'
          description: The valid form date.
          format: date-time
          example: '2024-01-01T00:00:00Z'
        validTo:
          type:
          - string
          - 'null'
          description: The valid to date.
          format: date-time
          example: '2025-01-01T00:00:00Z'
        hasUpgradeRights:
          type: boolean
          description: '```true``` if has upgrade rights; otherwise, ```false```.'
          example: true
        invoiceReference:
          type:
          - string
          - 'null'
          description: The invoice reference.
          example: INV12345
        notes:
          type:
          - string
          - 'null'
          description: The notes.
          example: Notes
        maintenanceCost:
          type:
          - number
          - 'null'
          description: The maintenance cost.
          format: decimal
          example: 1000
        supportCost:
          type:
          - number
          - 'null'
          description: The support cost.
          format: decimal
          example: 1000
    ErrorResponse:
      type: object
      required:
      - error
      properties:
        error:
          $ref: '#/components/schemas/Error'
    HateoasResponse:
      type: object
      description: Abstract class for IResource.
      x-abstract: true
      additionalProperties: false
      properties:
        _links:
          type: array
          description: A collection of links to related resources.
          items:
            $ref: '#/components/schemas/Link'
    CreatedHateoasResponse:
      allOf:
      - $ref: '#/components/schemas/HateoasResponse'
      - type: object
        additionalProperties: false
        properties:
          id:
            type: string
            description: The unique ID of the resource.
            format: guid
    ListOfMaintenancePeriodRequest:
      type: array
      items:
        $ref: '#/components/schemas/MaintenancePeriodRequest'
    HateoasCollectionOfMaintenancePeriodCollection:
      allOf:
      - $ref: '#/components/schemas/FilteredResponseOfMaintenancePeriodCollection'
      - type: object
        additionalProperties: false
        required:
        - _links
        properties:
          _links:
            type: array
            description: A collection of links to related resources.
            items:
              $ref: '#/components/schemas/Link'
    FilteredResponseOfMaintenancePeriodCollection:
      type: object
      description: Filtered response.
      additionalProperties: false
      required:
      - items
      - pagination
      properties:
        items:
          type: array
          description: A collection of items.
          items:
            $ref: '#/components/schemas/MaintenancePeriodCollection'
        pagination:
          description: The pagination details.
          oneOf:
          - $ref: '#/components/schemas/Pagination'
    MaintenancePeriod:
      allOf:
      - $ref: '#/components/schemas/CreatedHateoasResponse'
      - type: object
        additionalProperties: false
        properties:
          validFrom:
            type:
            - string
            - 'null'
            description: The valid form date.
            format: date-time
            example: '2024-01-01T00:00:00Z'
          validTo:
            type:
            - string
            - 'null'
            description: The valid to date.
            format: date-time
            example: '2025-01-01T00:00:00Z'
          hasUpgradeRights:
            type: boolean
            description: '```true``` if has upgrade rights; otherwise, ```false```.'
            example: true
          maintenanceCost:
            type:
            - number
            - 'null'
            description: The maintenance cost.
            format: decimal
            example: 1000
          supportCost:
            type:
            - number
            - 'null'
            description: The support cost.
            format: decimal
            example: 1000
          purchaseCurrency:
            type:
            - string
            - 'null'
            description: The purchase currency.
            example: USD
          invoiceReference:
            type:
            - string
            - 'null'
            description: The invoice reference.
            example: INV12345
          notes:
            type:
            - string
            - 'null'
            description: The notes.
            example: Notes
    MaintenancePeriodCollection:
      allOf:
      - $ref: '#/components/schemas/HateoasResource'
      - type: object
        additionalProperties: false
        properties:
          id:
            type: string
            description: The unique ID of the maintenance and support period.
            format: guid
            example: 49cdd99f-bc16-40f9-ad40-48f12182fb30
          agreementPeriodId:
            type:
            - string
            - 'null'
            description: The unique ID of the agreement period.
            format: guid
            example: 17597d2f-ae4b-4505-a85d-52a78421873c
          licenseId:
            type: string
            description: The unique ID of the license.
            format: guid
            example: 49cdd99f-bc16-40f9-ad40-48f12182fb30
          validFrom:
            type:
            - string
            - 'null'
            description: The valid form date.
            format: date-time
            example: '2024-01-01T00:00:00Z'
          validTo:
            type:
            - string
            - 'null'
            description: The valid to date.
            format: date-time
            example: '2025-01-01T00:00:00Z'
          hasUpgradeRights:
            type:
            - boolean
            - 'null'
            description: '```true``` if has upgrade rights; otherwise, ```false```.'
            example: true
          invoiceReference:
            type:
            - string
            - 'null'
            description: The invoice reference.
            example: INV12345
          notes:
            type:
            - string
            - 'null'
            description: The notes.
            example: Notes
          maintenanceCost:
            type:
            - number
            - 'null'
            description: The maintenance cost.
            format: decimal
            example: 1000
          supportCost:
            type:
            - number
            - 'null'
            description: The support cost.
            format: decimal
            example: 1000
          purchaseCurrency:
            type:
            - string
            - 'null'
            description: The purchase currency.
            example: USD
    Error:
      description: The error details.
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
          description: The HTTP status code.
        message:
          type: string
          description: The error message.
    HateoasResource:
      type: object
      additionalProperties: false
      required:
      - _links
      properties:
        _links:
          type: array
          description: A collection of links to related resources.
          items:
            $ref: '#/components/schemas/Link'
    Pagination:
      type: object
      description: The pagination details.
      additionalProperties: false
      required:
      - page_size
      - page_number
      properties:
        page_size:
          type: integer
          description: The page size you requested.
          format: int32
          example: 25
        page_number:
          type: integer
          description: The page number you requested.
          format: int32
          example: 1
        total_pages:
          type:
          - integer
          - 'null'
          description: The total number of pages.
          format: int32
          example: 5
        total_items:
          type:
          - integer
          - 'null'
          description: The total number of items.
          format: int32
          example: 100
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT