STACKIT Marketing API

openapi: 3.2.0
info:
  title: Stackit Marketing API
  version: 2.0.0
  x-refined-note:
  - x-source differs across the merged source definitions and was not carried
  description: 'Operations tagged Marketing across 2 of this provider''s published API definitions: stackit-pim-v2.json, stackit-pim-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://pim.api.stackit.cloud
  variables:
    region:
      default: global
tags:
- name: Marketing
paths:
  /v2/marketing:
    get:
      description: Retrieves a list of all marketing materials for all products, available for general public.
      operationId: listMarketingData
      parameters:
      - $ref: '#/components/parameters/pageSize'
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/language'
      - $ref: '#/components/parameters/productName'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/PublicMarketingData'
                    type: array
                  meta:
                    $ref: '#/components/schemas/MetaInformation'
                type: object
          description: Successful response
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: List all marketing materials
      x-stackit-authorization:
        disabled: true
      tags:
      - Marketing
    servers:
    - url: https://pim.api.stackit.cloud
      variables:
        region:
          default: global
components:
  responses:
    Forbidden:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: The authenticated user lacks permission to access this resource
    Unauthorized:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Authentication credentials are required
    BadRequest:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: The request was invalid or malformed
    InternalServerError:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: An unexpected server common occurred
  schemas:
    Error:
      properties:
        code:
          description: HTTP status code
          format: int64
          type: integer
        details:
          description: Additional common information
          items:
            additionalProperties: true
            type: object
          type: array
        message:
          description: Error description
          type: string
      required:
      - code
      - message
      type: object
    MarketingFunction:
      properties:
        function:
          description: Name of the function
          example: API Explorer
          type: string
        position:
          description: Position of the function
          example: '10'
          format: int64
          type: integer
      type: object
    MarketingAdvantage:
      properties:
        advantage:
          description: Name of the advantage
          example: API Explorer
          type: string
        position:
          description: Description of the advantage
          example: '10'
          format: int64
          type: integer
      type: object
    PublicMarketingData:
      properties:
        advantages:
          description: List of advantages of the product
          items:
            $ref: '#/components/schemas/MarketingAdvantage'
          type: array
        applications:
          description: List of applications provided by the product
          items:
            $ref: '#/components/schemas/MarketingApplication'
          type: array
        functions:
          description: List of functions provided by the product
          items:
            $ref: '#/components/schemas/MarketingFunction'
          type: array
        headline:
          description: Short description of what the product delivers
          example: API Explorer
          type: string
        id:
          description: Unique identifier of the marketing product, which is object id from the DB
          example: 5099803df3f4948bd2f98392
          type:
          - string
          - 'null'
        introductoryText:
          description: Basic information of the product
          example: All services that provide cloud server solutions are grouped under this category
          type: string
        language:
          description: Language of the marketing data
          example: en
          type: string
        longName:
          description: Extended name of the product
          example: STACKIT API Explorer
          type: string
        shortName:
          description: An abbreviated name of the product
          example: API Explorer
          type: string
        stId:
          description: Internal ID of the product in PIM
          example: STA_API_EXPLORER
          type: string
        validStart:
          description: Date when the current version was approved and became valid in PIM
          example: '2023-01-15T10:30:00'
          format: date-time
          type: string
        version:
          description: Number of the revision from PIM
          example: 10
          type: string
      type: object
    MetaInformation:
      properties:
        nextCursor:
          description: The cursor base64 encoded is used to retrieve the next page of results
          example: eyJ1dWlkIjoiZGU3NjllMzYtM2RlOS00Y2M4hjdsbhdsiuwbnLRDl9fZ29vZ2xlLmV4YW1wbGU6InJlYWx0IiwgImNvbnNlcnZlciI6eyJhYmNk
          type: string
        pageSize:
          description: The number of items per page
          example: 10
          format: int64
          type: integer
      type: object
    MarketingApplication:
      properties:
        application:
          description: Description of the application
          example: API Explorer
          type: string
        applicationTitle:
          description: Title of the application
          example: API Explorer
          type: string
        position:
          description: Position of the application
          example: '10'
          format: int64
          type: integer
      type: object
  parameters:
    language:
      description: The language to retrieve the data in, available for en and de
      in: query
      name: language
      schema:
        enum:
        - en
        - de
        type: string
    productName:
      description: The product's name to retrieve the data for
      in: query
      name: productName
      schema:
        type: string
    cursor:
      description: The cursor base64 encoded is used to retrieve the next page of results
      in: query
      name: cursor
      schema:
        type: string
    pageSize:
      description: The number of items to retrieve per page
      in: query
      name: pageSize
      schema:
        default: 10
        format: int64
        maximum: 100
        minimum: 1
        type: integer
x-refined-from:
- stackit-pim-v2.json
- stackit-pim-openapi.yml