Oracle Integration Dynamic Processes API

Manage dynamic process definitions and instances.

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

oracle-integration-dynamic-processes-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Oracle Integration Developer Adapters Dynamic Processes 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: Dynamic Processes
  description: Manage dynamic process definitions and instances.
paths:
  /ic/api/process/v1/dp-definitions:
    get:
      operationId: listDynamicProcessDefinitions
      summary: Oracle Integration List Dynamic Process Definitions
      description: Retrieve a list of dynamic process definitions.
      tags:
      - Dynamic Processes
      responses:
        '200':
          description: Dynamic process definitions retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DynamicProcessDefinitionList'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ic/api/process/v1/dp-instances:
    get:
      operationId: listDynamicProcessInstances
      summary: Oracle Integration List Dynamic Process Instances
      description: Retrieve a list of dynamic process instances.
      tags:
      - Dynamic Processes
      responses:
        '200':
          description: Dynamic process instances retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DynamicProcessInstanceList'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createDynamicProcessInstance
      summary: Oracle Integration Create Dynamic Process Instance
      description: Create a new dynamic process instance.
      tags:
      - Dynamic Processes
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DynamicProcessInstanceCreate'
      responses:
        '201':
          description: Dynamic process instance created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DynamicProcessInstance'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          example: https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
        title:
          type: string
          example: Not Found
        detail:
          type: string
          example: Process instance not found.
        status:
          type: integer
          example: 404
    DynamicProcessDefinitionList:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                example: DP_ORDER_PROCESSING
              name:
                type: string
                example: Order Processing
    DynamicProcessInstance:
      type: object
      properties:
        id:
          type: string
          example: DPI_001
        definitionId:
          type: string
          example: DP_ORDER_PROCESSING
        state:
          type: string
          example: OPEN
        createdDate:
          type: string
          format: date-time
          example: '2026-04-18T10:00:00Z'
    DynamicProcessInstanceList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DynamicProcessInstance'
    DynamicProcessInstanceCreate:
      type: object
      properties:
        definitionId:
          type: string
          example: DP_ORDER_PROCESSING
        title:
          type: string
          example: Order Processing Case
  responses:
    Unauthorized:
      description: Authentication required.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  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.