Oracle Integration Tasks API

Manage user tasks and task actions.

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

oracle-integration-tasks-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Oracle Integration Developer Adapters Tasks 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: Tasks
  description: Manage user tasks and task actions.
paths:
  /ic/api/process/v1/tasks:
    get:
      operationId: listTasks
      summary: Oracle Integration List Tasks
      description: Retrieve a list of user tasks.
      tags:
      - Tasks
      parameters:
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          description: Tasks retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskList'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ic/api/process/v1/tasks/{id}:
    get:
      operationId: getTask
      summary: Oracle Integration Get Task
      description: Retrieve a specific task by identifier.
      tags:
      - Tasks
      parameters:
      - $ref: '#/components/parameters/taskIdParam'
      responses:
        '200':
          description: Task details retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      operationId: performTaskAction
      summary: Oracle Integration Perform Task Action
      description: Perform an action on a task such as approve, reject, or reassign.
      tags:
      - Tasks
      parameters:
      - $ref: '#/components/parameters/taskIdParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TaskAction'
      responses:
        '200':
          description: Task action performed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Task'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ic/api/process/v1/tasks/{id}/payload:
    get:
      operationId: getTaskPayload
      summary: Oracle Integration Get Task Payload
      description: Retrieve the payload data for a task.
      tags:
      - Tasks
      parameters:
      - $ref: '#/components/parameters/taskIdParam'
      responses:
        '200':
          description: Task payload retrieved.
          content:
            application/json:
              schema:
                type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ic/api/process/v1/tasks/{id}/history:
    get:
      operationId: getTaskHistory
      summary: Oracle Integration Get Task History
      description: Retrieve the history of a task.
      tags:
      - Tasks
      parameters:
      - $ref: '#/components/parameters/taskIdParam'
      responses:
        '200':
          description: Task history retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskHistoryList'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ic/api/process/v1/tasks/task-metrics:
    get:
      operationId: getTaskMetrics
      summary: Oracle Integration Get Task Metrics
      description: Retrieve task metrics.
      tags:
      - Tasks
      responses:
        '200':
          description: Task metrics retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskMetrics'
        '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
    TaskAction:
      type: object
      properties:
        action:
          type: string
          description: Action to perform.
          enum:
          - APPROVE
          - REJECT
          - REASSIGN
          - ESCALATE
          - WITHDRAW
          - SUSPEND
          - RESUME
          example: APPROVE
        comment:
          type: string
          description: Comment for the action.
          example: Approved as per policy.
        assignee:
          type: string
          description: New assignee for reassign action.
          example: manager@example.com
    TaskMetrics:
      type: object
      properties:
        totalTasks:
          type: integer
          example: 150
        assignedTasks:
          type: integer
          example: 25
        completedTasks:
          type: integer
          example: 120
        expiredTasks:
          type: integer
          example: 5
    Task:
      type: object
      properties:
        id:
          type: string
          description: Task identifier.
          example: '400789'
        title:
          type: string
          description: Task title.
          example: Review Order
        assignee:
          type: string
          description: Current assignee.
          example: jsmith@example.com
        state:
          type: string
          description: Task state.
          enum:
          - ASSIGNED
          - COMPLETED
          - EXPIRED
          - INFO_REQUESTED
          - SUSPENDED
          - WITHDRAWN
          example: ASSIGNED
        priority:
          type: integer
          description: Task priority.
          example: 3
        createdDate:
          type: string
          format: date-time
          description: Task creation timestamp.
          example: '2026-04-18T10:00:00Z'
        dueDate:
          type: string
          format: date-time
          description: Task due date.
          example: '2026-04-20T17:00:00Z'
        processId:
          type: string
          description: Parent process instance identifier.
          example: '300456'
        processName:
          type: string
          description: Parent process name.
          example: Order Approval
        outcome:
          type: string
          description: Task outcome.
          example: APPROVE
    TaskList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Task'
        totalResults:
          type: integer
          example: 25
        hasMore:
          type: boolean
          example: false
    TaskHistoryList:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              action:
                type: string
                example: ASSIGN
              user:
                type: string
                example: admin@example.com
              timestamp:
                type: string
                format: date-time
                example: '2026-04-18T10:00:00Z'
              comment:
                type: string
                example: Task assigned to reviewer.
  responses:
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication required.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  parameters:
    limitParam:
      name: limit
      in: query
      description: Maximum number of items to return.
      schema:
        type: integer
        default: 20
    taskIdParam:
      name: id
      in: path
      required: true
      description: Task identifier.
      schema:
        type: string
    offsetParam:
      name: offset
      in: query
      description: Number of items to skip.
      schema:
        type: integer
        default: 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.