Oracle Integration Scheduled Integrations API

openapi: 3.0.3
info:
  title: Oracle Integration Developer Adapters Scheduled Integrations 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: Scheduled Integrations
  description: Manage scheduled integration execution.
paths:
  /ic/api/integration/v1/integrations/{id}/schedule/start:
    post:
      operationId: startIntegrationSchedule
      summary: Oracle Integration Start Schedule
      description: Start an integration schedule.
      tags:
      - Scheduled Integrations
      parameters:
      - $ref: '#/components/parameters/integrationIdParam'
      responses:
        '200':
          description: Schedule started.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ic/api/integration/v1/integrations/{id}/schedule/stop:
    post:
      operationId: stopIntegrationSchedule
      summary: Oracle Integration Stop Schedule
      description: Stop an integration schedule.
      tags:
      - Scheduled Integrations
      parameters:
      - $ref: '#/components/parameters/integrationIdParam'
      responses:
        '200':
          description: Schedule stopped.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ic/api/integration/v1/integrations/{id}/schedule/pause:
    post:
      operationId: pauseIntegrationSchedule
      summary: Oracle Integration Pause Schedule
      description: Pause an integration schedule.
      tags:
      - Scheduled Integrations
      parameters:
      - $ref: '#/components/parameters/integrationIdParam'
      responses:
        '200':
          description: Schedule paused.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ic/api/integration/v1/integrations/{id}/schedule/resume:
    post:
      operationId: resumeIntegrationSchedule
      summary: Oracle Integration Resume Schedule
      description: Resume a paused integration schedule.
      tags:
      - Scheduled Integrations
      parameters:
      - $ref: '#/components/parameters/integrationIdParam'
      responses:
        '200':
          description: Schedule resumed.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ic/api/integration/v1/integrations/{id}/schedule/jobs:
    post:
      operationId: runScheduledIntegrationNow
      summary: Oracle Integration Run Scheduled Integration Now
      description: Trigger an immediate run of a scheduled integration.
      tags:
      - Scheduled Integrations
      parameters:
      - $ref: '#/components/parameters/integrationIdParam'
      responses:
        '200':
          description: Scheduled run triggered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduledJob'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  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
    ScheduledJob:
      type: object
      properties:
        jobId:
          type: string
          description: Scheduled job identifier.
          example: '500123'
        status:
          type: string
          description: Job status.
          example: RUNNING
        startTime:
          type: string
          format: date-time
          description: Job start time.
          example: '2026-04-18T14:30:00Z'
  responses:
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication required or invalid credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  parameters:
    integrationIdParam:
      name: id
      in: path
      required: true
      description: Integration identifier in the format CODE|VERSION.
      schema:
        type: string
        example: HELLO_WORLD|01.00.0000
  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.