Oracle Integration Connections API

openapi: 3.0.3
info:
  title: Oracle Integration Developer Adapters Connections API
  description: Developer API for Oracle Integration 3 providing day-to-day management of integrations, connections, packages, libraries, lookups, certificates, scheduled integrations, monitoring, B2B trading partner operations, and rapid adapter building.
  version: 1.0.0
  contact:
    name: Oracle Integration Support
    email: oracle-integration-support@oracle.com
    url: https://www.oracle.com/support/
  license:
    name: Oracle Terms of Service
    url: https://www.oracle.com/legal/terms.html
  x-generated-from: documentation
  x-last-validated: '2026-04-18'
servers:
- url: https://{instance}.integration.ocp.oraclecloud.com
  description: Oracle Integration Cloud Instance
  variables:
    instance:
      default: myinstance
      description: Oracle Integration instance name
security:
- oauth2: []
- basicAuth: []
tags:
- name: Connections
  description: Manage connections that define integration endpoints.
paths:
  /ic/api/integration/v1/connections:
    get:
      operationId: listConnections
      summary: Oracle Integration List Connections
      description: Retrieve a list of all connections configured in the instance.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/offsetParam'
      - name: q
        in: query
        description: Filter query string.
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved connections.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionList'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ic/api/integration/v1/connections/{id}:
    get:
      operationId: getConnection
      summary: Oracle Integration Get Connection
      description: Retrieve a specific connection by its identifier.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionIdParam'
      responses:
        '200':
          description: Successfully retrieved the connection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: updateConnection
      summary: Oracle Integration Update Connection
      description: Update an existing connection's properties.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectionUpdate'
      responses:
        '200':
          description: Successfully updated the connection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteConnection
      summary: Oracle Integration Delete Connection
      description: Delete a connection by its identifier.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionIdParam'
      responses:
        '204':
          description: Successfully deleted the connection.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ic/api/integration/v1/connections/{id}/test:
    post:
      operationId: testConnection
      summary: Oracle Integration Test Connection
      description: Test a connection to verify connectivity.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionIdParam'
      responses:
        '200':
          description: Connection test result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionTestResult'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ic/api/integration/v1/connections/{id}/metadata:
    post:
      operationId: refreshConnectionMetadata
      summary: Oracle Integration Refresh Connection Metadata
      description: Refresh metadata for a connection.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/connectionIdParam'
      responses:
        '200':
          description: Metadata refreshed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    Forbidden:
      description: Insufficient permissions.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Bad request - invalid input.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication required or invalid credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          description: Error type URI.
          example: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
        title:
          type: string
          description: Short error title.
          example: Bad Request
        detail:
          type: string
          description: Detailed error message.
          example: Invalid connection identifier format.
        status:
          type: integer
          description: HTTP status code.
          example: 400
    ConnectionTestResult:
      type: object
      properties:
        status:
          type: string
          description: Test result status.
          enum:
          - SUCCESS
          - FAILURE
          example: SUCCESS
        message:
          type: string
          description: Test result message.
          example: Connection test was successful.
    ConnectionUpdate:
      type: object
      properties:
        connectionProperties:
          type: array
          description: Connection properties to update.
          items:
            type: object
            properties:
              propertyName:
                type: string
                description: Property name.
                example: securityPolicy
              propertyValue:
                type: string
                description: Property value.
                example: USERNAME_PASSWORD_TOKEN
        securityProperties:
          type: array
          description: Security properties to update.
          items:
            type: object
            properties:
              propertyName:
                type: string
                description: Security property name.
                example: username
              propertyValue:
                type: string
                description: Security property value.
                example: admin@salesforce.com
    Connection:
      type: object
      properties:
        id:
          type: string
          description: Connection identifier.
          example: SALESFORCE_CONNECTION
        name:
          type: string
          description: Connection display name.
          example: Salesforce Connection
        description:
          type: string
          description: Connection description.
          example: Connection to Salesforce CRM instance.
        status:
          type: string
          description: Connection status.
          enum:
          - CONFIGURED
          - DRAFT
          - ERROR
          example: CONFIGURED
        adapterType:
          type: string
          description: Type of adapter used by the connection.
          example: salesforce
        percentageComplete:
          type: integer
          description: Percentage of connection configuration completion.
          example: 100
        lockedFlag:
          type: boolean
          description: Whether the connection is locked.
          example: false
        testStatus:
          type: string
          description: Last test status.
          example: SUCCESS
        lastUpdatedBy:
          type: string
          description: User who last updated the connection.
          example: admin@example.com
        lastUpdated:
          type: string
          format: date-time
          description: Last update timestamp.
          example: '2026-04-15T10:30:00Z'
    ConnectionList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Connection'
        totalResults:
          type: integer
          description: Total number of connections.
          example: 15
        hasMore:
          type: boolean
          description: Whether more results are available.
          example: false
  parameters:
    limitParam:
      name: limit
      in: query
      description: Maximum number of items to return.
      schema:
        type: integer
        default: 20
        example: 20
    connectionIdParam:
      name: id
      in: path
      required: true
      description: Connection identifier.
      schema:
        type: string
        example: SALESFORCE_CONNECTION
    offsetParam:
      name: offset
      in: query
      description: Number of items to skip before returning results.
      schema:
        type: integer
        default: 0
        example: 0
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 authentication via Oracle Identity Cloud Service (IDCS).
      flows:
        authorizationCode:
          authorizationUrl: https://{idcs-url}/oauth2/v1/authorize
          tokenUrl: https://{idcs-url}/oauth2/v1/token
          scopes:
            urn:opc:resource:consumer::all: Full access to Oracle Integration APIs
    basicAuth:
      type: http
      scheme: basic
      description: Basic authentication with Oracle Integration credentials.