SAP Integration Suite Variables API

Manage global and local variables

OpenAPI Specification

sap-integration-suite-variables-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: SAP API Management API Products Variables API
  description: The SAP API Management API enables programmatic management of APIs, products, applications, and developer portals within SAP Integration Suite. It supports creating and publishing API proxies, managing rate plans, configuring policies, administering developer portals, and managing the full API lifecycle within SAP Business Technology Platform.
  version: 1.0.0
  contact:
    name: SAP Support
    url: https://support.sap.com
  license:
    name: SAP Developer License
    url: https://www.sap.com/about/agreements/product-use-and-support-terms.html
  x-logo:
    url: https://www.sap.com/dam/application/shared/logos/sap-logo.svg
servers:
- url: https://{api-portal-host}/apiportal/api/1.0
  description: SAP API Management API Portal
  variables:
    api-portal-host:
      default: my-tenant.apimanagement.sap.hana.ondemand.com
      description: SAP API Management host
security:
- oauth2: []
- basicAuth: []
tags:
- name: Variables
  description: Manage global and local variables
paths:
  /Variables:
    get:
      operationId: listVariables
      summary: List Variables
      description: Retrieve all integration variables defined in the tenant.
      tags:
      - Variables
      parameters:
      - name: $filter
        in: query
        schema:
          type: string
      - name: $top
        in: query
        schema:
          type: integer
      - name: $skip
        in: query
        schema:
          type: integer
      responses:
        '200':
          description: List of variables
          content:
            application/json:
              schema:
                type: object
                properties:
                  d:
                    type: object
                    properties:
                      results:
                        type: array
                        items:
                          $ref: '#/components/schemas/Variable'
        '401':
          description: Unauthorized
components:
  schemas:
    Variable:
      type: object
      properties:
        VariableName:
          type: string
          description: Name of the variable
        IntegrationFlow:
          type: string
          description: Associated integration flow name (empty for global variables)
        Visibility:
          type: string
          description: Variable scope
          enum:
          - Global
          - Local
        UpdatedAt:
          type: string
          description: Last updated timestamp
        RetainUntil:
          type: string
          description: Retention expiry timestamp
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{tenant}.authentication.sap.hana.ondemand.com/oauth/token
          scopes: {}
    basicAuth:
      type: http
      scheme: basic