1. Oracle Integration REST APIREST API for Oracle Integration
  2. What's New

What's New

Learn about new and changed endpoints for the Oracle Integration REST API.

May 2023

REST API Category Changes in REST API
Environment OIC applications do not allow authenticated access from arbitrary origins. All domains belonging to arbitrary origins need to be registered in the allowed list of sites for cross-origin resource sharing (CORS) processing. The following new API functions have been added to create and update a list of allowed sites for (CORS) processing:

Note:

If your OIC application is consuming authenticated cross-origin requests, then ensure that the domains are registered in the allowed list.
Process/Process Instances New processDefIdLike query parameter in the Retrieve the Process Instance List API function. Set this query parameter to true if you want to retrieve process instances using the processDefId wildcard patterns.
Process/Process Definitions In the Retrieve Process Definitions API function, the response payload now includes the creationDate value that indicates the deployment date of the process definition.

November 2022

REST API Category Changes in REST API
Process/Process Definitions The Update the Interface Type for Process Definitions function is now deprecated.

May 2022

REST API Category Changes in REST API
Process/Designtime Projects New REST APIs in Designtime Projects for Generate and Export a Report for a Process and Generate and Export a Report for All Processes in an application.

November 2021

REST API Category Changes in REST API
Process/Dynamic Process Instances New abortType action to control which instances of a flow ID are aborted: the current instance only, current instance and child instances, or current instance and parent and child instances. See Control a Dynamic Process Instance.
Process/Process Instances New abortType parameter to control which instances of a flow ID are aborted: the current instance only, current instance and child instances, or current instance and parent and child instances. See Update the Process State.

August 2021

REST API Category Changes in REST API
Integrations/Integrations New parameter stopScheduleForDeactivation in Update(Activate/Deactivate) an Integration to deactivate an integration and stop its schedule.
Integrations/Monitoring Deprecated functions:
Process/Deployed Projects New function Retrieve Endpoint Configuration for a Deployed Project Revision.
Process/Identities New Identities functions for working with identities and roles.
Process/Tasks

May 2021

REST API Category Changes in REST API
B2B New REST APIs for B2B for Document Customization, Monitoring, and Trading Partner Management.
Integrations

New parameter stopScheduleForDeactivation to stop the schedule of an integration when deactivating it Update(Activate/Deactivate) an Integration.

November 2020

REST API Category Changes in REST API
Integrations/Monitoring

New monitoring functions:

New parameters:

  • In Retrieve Audit Records, new parameters code, version, and timewindow to filter audit records for integrations by integration name, version, and time period.
  • In Retrieve Errored Instances, new filter parameters startdate, enddate, recoverable.
  • In Retrieve Integration Instances, new filter parameters to retrieve integration instances with the status ABORTED, by date range with startdate and enddate, and by recovery job. identifier with jobid. You can also retrieve information about child instances with the new parameter parentInstanceId.
  • In Download a Log File, new filter parameter by date range with startdate and enddate.

Deprecated:
Integrations/Libraries

New function to update integration library jar files: Update a Library
Integrations/Packages New functions for packages:
Process/Process Analytics New functions for tracking and monitoring Process-related items: Process Analytics.

January 2020

REST API Category Changes in REST API
Process/Preferences New functions to set and manage user and application preferences: Preferences
Process/Revisions New function to get the compatibility report between two revisions of a deployed application: Retrieve Compatibility Report for Revisions
Process/Process Definitions New function to improve the performance of the process definition API: Update Interface Type for Process Definitions
Process/Process Instances
Process/Dynamic Process The success status code of the following APIs has changed from 204 to 200:
Decision Modeling Service Enhanced examples for Import a Decision Model Snapshot.
Integrations/Monitoring
  • In Retrieve Activated Integrations, the new field flowStatus in the response displays the integration status.
  • For scheduled integrations, use the new query parameter requestId to only retrieve information about instances that were triggered with the specified request ID. See Retrieve Integration Instances.

October 2019

REST API Category Changes in REST API
Integrations/Integrations New and updated examples for all endpoints in Integrations.
Integrations/Libraries New and updated examples for all endpoints in Libraries.
Integrations/Monitoring New and updated examples for all endpoints in Monitoring.

July 2019

REST API Category Changes in REST API
Integrations/Connections New and updated examples for all endpoints in Connections.
Integrations/Lookups New and updated examples for all endpoints in Lookups.
Integrations/Packages New and updated examples for all endpoints in Packages.

May 2019

REST API Category Changes in REST API
Process/Process Instances

Changes in Retrieve Activities Flow for a Process Instance:

  • Use the new activityType query parameter to return only a subset of activities that match the specified type.
Process/Process Instances
Changes in Update the Process State:
  • New actions:
    • Use the new suspend and resume actions to alter the flow of a process by passing activityChanges in the JSON body.
  • New examples:
    • Example: Resume the Workflow from Source Activity to Target Activity with Data Object Changes
    • Example: Suspend the Workflow from Source Activity to Target Activity
    • Examples: Recover Faulted Process Instances
Process/Process Instances

Create a Process Instance new examples:

  • Example: Create a New Process Instance for a Message-based Process
  • Example: Create a New Process Instance from the Latest Activated Version
  • Examples: Create a New Process Instance from a Web form (Form-based Process Start)
    • Example 1: Create a new process instance from a web form and populate form data with the "payload" attribute in the request body
    • Example 2: Create a new process instance from a web form and pass parameters with the "params" attribute in the request body
    • Example 3: Create a new process instance from a web form and pass query parameters in the request
Process/Process Instances Changes in Retrieve the Audit Diagram of a Process Instance:
Decision Modeling Service

The Decision Modeling Service APIs are now displayed in their own section, no longer within the Process section.

January 2019

November 2018

August 2018

  • Endpoints have been added and updated for the following categories:

    REST API Category Changes in REST API

    New security, authentication, and authorization for Oracle Integration REST APIs using OAuth.

    Authentication and authorization in Oracle Integration is managed by Oracle Identity Cloud Service. Oracle Integration REST APIs as well as REST endpoints exposed in integrations are protected using OAuth token-based authentication. See Security, Authentication and Authorization.

    Process/Deployed Projects

    Added API functions for Deployed Projects:

    Integrations/Libraries
    Added API functions for Integrations/Libraries:

    Integrations/Monitoring
    Added API functions for Integrations/Monitoring:

    Integrations/Packages

    		 Added API functions for Integrations/Monitoring:

April 2018