Oracle GoldenGate Artifacts API

openapi: 3.2.0
info:
  title: Oracle GoldenGate Stream Analytics REST Artifacts API
  description: REST API for managing Oracle GoldenGate Stream Analytics (GGSA) pipelines and users. Enables CI/CD integration by providing programmatic access to export, import, publish, and unpublish stream processing pipelines, as well as manage user accounts and roles. Based on Oracle GoldenGate Stream Analytics 19.1 REST API documentation.
  version: 19.1.0
  contact:
    name: Oracle Support
    url: https://support.oracle.com
  license:
    name: Oracle Technology Network License
    url: https://www.oracle.com/legal/terms.html
  x-documentation:
  - url: https://docs.oracle.com/en/middleware/fusion-middleware/osa/19.1/ggsa-rest-api/rest-endpoints.html
    description: GoldenGate Stream Analytics REST API Reference
servers:
- url: https://{ggsa-host}:{port}/osa
  description: Oracle GoldenGate Stream Analytics server
  variables:
    ggsa-host:
      default: localhost
      description: GGSA server host
    port:
      default: '9080'
      description: GGSA HTTP/S port
security:
- basicAuth: []
tags:
- name: Artifacts
  description: Import and export GGSA artifacts
paths:
  /services/v1/artifacts/import:
    patch:
      operationId: importArtifacts
      summary: Oracle Goldengate Import Ggsa Artifacts
      description: Imports GGSA artifacts (pipelines, sources, targets, connections, etc.) from a previously exported JSON document. Supports CI/CD workflows by enabling promotion of pipelines across environments.
      tags:
      - Artifacts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ArtifactImport'
            examples:
              ImportartifactsRequestExample:
                summary: Default importArtifacts request
                x-microcks-default: true
                value:
                  pipeline: example_value
                  connections:
                  - {}
                  references:
                  - {}
      responses:
        '200':
          description: Artifacts imported
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImportResult'
              examples:
                Importartifacts200Example:
                  summary: Default importArtifacts 200 response
                  x-microcks-default: true
                  value:
                    success: true
                    importedArtifacts: 10
                    messages:
                    - example_value
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
          example: 10
        message:
          type: string
          example: example_value
    ImportResult:
      type: object
      properties:
        success:
          type: boolean
          example: true
        importedArtifacts:
          type: integer
          example: 10
        messages:
          type: array
          items:
            type: string
          example: []
    ArtifactImport:
      type: object
      description: JSON document containing exported GGSA artifacts
      properties:
        pipeline:
          type: object
          additionalProperties: true
          example: example_value
        connections:
          type: array
          items:
            type: object
            additionalProperties: true
          example: []
        references:
          type: array
          items:
            type: object
            additionalProperties: true
          example: []
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with GGSA credentials