Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• What's New
• Quick Start
• Send Requests
• Security, Authentication and Authorization
  • OAuth Authentication in Oracle Integration
  • Configure a Trusted Application to Authenticate with OAuth
  • Use OAuth with REST API Calls
  • Refresh an OAuth Access Token
• cURL Access
• Status Codes

Tasks

• B2B
  • Document Customization
    • Clone a B2B Document
    • Clone a B2B Schema
    • Create a B2B Document
    • Create a B2B Schema
    • Create a B2B schema from an SEF File
    • Delete a B2B Document
    • Delete a B2B Schema
    • Generate a Schema Implementation Guide
    • Retrieve a B2B Document
    • Retrieve a B2B Schema
    • Retrieve an Element's Code List
    • Retrieve B2B Document Standards
    • Retrieve B2B Document Types
    • Retrieve B2B Documents
    • Retrieve B2B Schemas
    • Retrieve Document Transactions
    • Retrieve Document Versions
    • Retrieve Documents for a B2B Schema
    • Retrieve Integrations Using a B2B Document
    • Retrieve Trading Partners using a B2B Document
    • Update a B2B Document
    • Update a B2B Schema
  • Monitoring
    • Download B2B Business Message Payload
    • Download B2B Wire Message Payload
    • Retrieve Business Message Details
    • Retrieve Business Messages
    • Retrieve Wire Message Details
    • Retrieve Wire Messages
  • Trading Partner
    • Create a Trading Partner
    • Create an Inbound Agreement
    • Create an Outbound Agreement
    • Create/Update B2B Identifiers
    • Create/Update Host Profile
    • Create/Update Trading Partner Contacts
    • Delete a B2B Identifier
    • Delete a Host Identifier
    • Delete a Trading Partner
    • Delete an Inbound Agreement
    • Delete an Outbound Agreement
    • Deploy an Inbound Agreement
    • Deploy an Outbound Agreement
    • Export a Trading Partner
    • Import a Trading Partner
    • Retrieve a Trading Partner
    • Retrieve an Inbound Agreement
    • Retrieve an Outbound Agreement
    • Retrieve B2B Identifiers
    • Retrieve Inbound Agreements
    • Retrieve Outbound Agreements
    • Retrieve the Host Profile
    • Retrieve Trading Partner Contact Details
    • Retrieve Trading Partners
    • Undeploy an Inbound Agreement
    • Undeploy an Outbound Agreement
    • Update a Trading Partner
    • Update an Inbound Agreement
    • Update an Outbound Agreement
• Decision Modeling Service
  • Create an Empty Decision Model
  • Delete a Decision Model and Snapshots
  • Delete a Decision Model Snapshot
  • Deploy a Decision Model Snapshot
  • Get a Decision Model
  • Get a List of Decision Model Names in a Space
  • Get a List of Decision Model Snapshot Names
  • Get a List of Decision Services of a Decision Model Snapshot
  • Get a List of Runtime Version IDs of a Decision Model
  • Get a List of Space IDs
  • Get a New Access Token and Refresh Token
  • Get a Space by Space ID
  • Get Information about a Decision Service by Snapshot Name
  • Get Information of a Deployed Decision Service by the Runtime Version ID
  • Get the Snapshot Name Associated with a Runtime Version ID
  • Import a Decision Model Snapshot
  • Invoke a Decision Service by Snapshot Name
  • Invoke a Deployed Decision Service by the Runtime Version ID
  • Read or Export a Decision Model Snapshot
  • Refresh the Access Token
  • Undeploy a Runtime Version ID of a Decision Model
• Environment
  • Create a List of Domains Allowed for CORS Processing
  • Retrieve List of Domains Allowed for CORS Processing
  • Update the List of Allowed Domains for CORS Processing
• Integrations
  • Connections
    • Delete a Connection
    • Refresh Metadata for a Connection
    • Retrieve a Connection
    • Retrieve Connection Property Attachment
    • Retrieve Connections
    • Test a Connection
    • Update a Connection
    • Upload Connection Property Attachment
    • Validate a Connection
    • Validate and Test a Connection
  • Integrations
    • Clone an Integration
    • Delete an Integration Version
    • Export an Integration
    • Import(Add) an Integration
    • Import(Replace) an Integration
    • Retrieve an Integration
    • Retrieve Integration Activation Errors
    • Retrieve Integration Activation Status
    • Retrieve Integrations
    • Update(Activate/Deactivate) an Integration
    • Scheduled Integrations
      • Pause an Integration Schedule
      • Resume an Integration Schedule
      • Retrieve Scheduled Integration Run Status
      • Run a Scheduled Integration Now
      • Start an Integration Schedule
      • Stop an Integration Schedule
      • Update Scheduled Integration Parameters
  • Libraries
    • Delete a Library Version
    • Export a Library
    • Export Library Metadata
    • Import Library Metadata
    • Import(Register) a Library
    • Retrieve a Library
    • Retrieve Libraries
    • Update a Library
  • Lookups
    • Clone a Lookup
    • Create a Lookup
    • Delete a Lookup
    • Export a Lookup
    • Import(Add) a Lookup
    • Import(Replace) a Lookup
    • Retrieve a Lookup
    • Retrieve Lookups
    • Retrieve Usage of the Lookup
    • Update a Lookup
  • Monitoring
    • Abort an Integration Instance
    • Discard an Errored Integration Instance
    • Discard Errored Integration Instances
    • Download a Log File
    • Download an Incident (Deprecated)
    • Download Database Purge Logs
    • Report an Incident(Deprecated)
    • Resubmit a Failed Scheduled Integration Run
    • Resubmit an Errored Integration Instance
    • Resubmit Errored Integration Instances
    • Retrieve Activity Stream Messages (Deprecated)
    • Retrieve an Error Recovery Job
    • Retrieve an Errored Integration Instance
    • Retrieve an Integration Instance
    • Retrieve Audit Records
    • Retrieve Error Recovery Jobs
    • Retrieve Errored Instances
    • Retrieve Historical Tracking Metrics
    • Retrieve Integration Instance Activity Stream
    • Retrieve Integration Instances
    • Retrieve Message Count Summary
    • Retrieve Monitoring Data for an Integration
    • Retrieve Monitoring Data for Integrations
    • Retrieve Status of Agent Groups
    • Retrieve Status of Agents in an Agent Group
    • Retrieve Status of an Agent
    • Retrieve Status of an Agent Group
    • Retrieve the Activity Stream (Deprecated)
  • Packages
    • Clone a Package
    • Delete a Package
    • Export a Package
    • Import Sample Packages
    • Import(Add) a Package
    • Import(Replace) a Package
    • Retrieve a Package
    • Retrieve Packages
    • Update Package Dependencies
• Process
  • Deployed Projects
    • Deploy a Project
    • Retrieve a Deployed Project Revision
    • Retrieve Endpoint Configuration for Deployed Project Revision
    • Retrieve Revisions of a Project
    • Retrieve the Compatibility Report for Revisions
    • Undeploy a Project Revision
    • Update a Deployed Project Revision
  • Designtime Projects
    • Copy a Project
    • Create a DesignTime Process
    • Create a Snapshot
    • Create or Import a New Project into the Space
    • Delete a DesignTime Process
    • Delete a Project
    • Delete a Snapshot
    • Deploy the Latest Published Version of a Project
    • Deploy the Latest Version of a Project
    • Export a Snapshot
    • Exports a Project
    • Generate and Export a Report for a Process
    • Generate and Export a Report for All Processes
    • Retrieve a DesignTime Process by ID
    • Retrieve a Project by ID
    • Retrieve a Snapshot by ID
    • Retrieve Processes
    • Retrieve Projects
    • Retrieve the Snapshots for a Project
    • Update the Project Description
  • Dynamic Process Definitions
    • Get a Dynamic Process Definition by ID
    • Get a List of Dynamic Process Definitions
    • Get Dynamic Process Definition Interface
    • Get Dynamic Process Definition Metadata
  • Dynamic Process Executions
    • Control a Dynamic Process Execution
    • Get a List of Dynamic Process Executions
    • Get Dynamic Process Execution Details
    • Get the folder details
  • Dynamic Process Instances
    • Control a Dynamic Process Instance
    • Create a New Dynamic Process Instance
    • Get a Dynamic Process Instance by ID
    • Get a List of Dynamic Process Instances
    • Get list of folders associated with a dynamic-process instance
    • Get Variable Data
    • Get Variables for Dynamic Process Instance
  • Dynamic Process Resources
    • Get a Dynamic Process Resource
    • Get a List of Dynamic Process Resources
  • Dynamic Process Roles
    • Add, Update or Delete Permissions for a Role
    • Add, Update, or Delete Members for a Role
    • Create a New Dynamic Process Role
    • Delete a Dynamic Process Role
    • Get a Dynamic Process Role
    • Get Dynamic Process Role Permissions
    • Get Members for a Dynamic Process Role
    • List Dynamic Process Roles
    • Update a Dynamic Process Role
  • Identities
    • Add a Member to a Role/Remove a Member from a Role
    • Delete an Application Role
    • Retrieve a Group
    • Retrieve a Logged in User
    • Retrieve a Role
    • Retrieve a User
    • Retrieve All Users, Groups or Roles
    • Retrieve Identities
    • Retrieve Members in a Role
    • Retrieve users in a group
  • Preferences
    • Delete User and Application Preferences for the Logged in User
    • Delete User Preferences for Users
    • Get User and Application Preferences for the Logged in User
    • Grant or Revoke Preferences for the Logged in User
    • Grant or Revoke Preferences for Users
  • Process Analytics
    • Create or Execute an Analytics Query
    • Delete a Business Query
    • Retrieve Analytics Query Definition or Execution Result
    • Retrieve Available Columns for Data Source
    • Retrieve Data Sources
    • Retrieve DataObject names
    • Retrieve DataObject's data
    • Retrieve DataObject's Metadata
    • Retrieve Supported Aggregate Operations
    • Retrieve Supported Comparison Operators
    • Return Links of DataSource Columns
    • Returns OOTB and Business Queries
    • Update Business Query
  • Process Definitions
    • Retrieve a Form Instance for a Webform
    • Retrieve a Managed Folder Metadata
    • Retrieve an Incoming Folder Metadata
    • Retrieve Conversation Metadata
    • Retrieve Conversations
    • Retrieve Document Metadata
    • Retrieve Incoming Document Metadata
    • Retrieve Incoming Document Metadata for a Document
    • Retrieve Incoming Folders Metadata
    • Retrieve Process Definitions
    • Retrieve Process Metadata
    • Retrieve the Managed Folders Metadata
    • Retrieve the Startup Folder Name
    • Update the Interface Type for Process Definitions (Deprecated)
  • Process Instances
    • Add Attachments to a Process
    • Add Comments to a Process
    • Create a Process Instance
    • Delete Process Attachments
    • Get Faults for a Process Instance
    • Perform Actions on a List of Instances
    • Retrieve a Conversation for a Process Instance
    • Retrieve a Process Attachment as a Stream
    • Retrieve a Process Instance
    • Retrieve a Process Instance by case ID
    • Retrieve Activities Flow for a Process Instance
    • Retrieve Conversations for a Process Instance
    • Retrieve Data Objects by Open Activity ID
    • Retrieve Data Objects for a Process Instance
    • Retrieve Instance Metrics for the User
    • Retrieve Open activities for a Process Instance
    • Retrieve the Approval Outcome
    • Retrieve the Attachment List for a Process Instance
    • Retrieve the Audit Diagram of a Process Instance
    • Retrieve the Audit Instance Payload document for given audit query ID
    • Retrieve the Comment List for a Process Instance
    • Retrieve the DOCs folder Details for a Process Instance
    • Retrieve the List of DOCs Folders for a Process Instance
    • Retrieve the Process Instance List
    • Update the Process State
  • QuickStart Apps
    • Delete a QuickStart App
    • Retrieve a QuickStart App by ID
    • Retrieve QuickStart Apps
  • Spaces
    • Add a User to a Space
    • Create a Space
    • Delete a Space
    • List Permissions Assigned to a Space
    • Remove User from a Space
    • Retrieve a Space by ID
    • Retrieve Permission Details
    • Retrieve Spaces
  • Tasks
    • Add a Task Attachment
    • Add a Task Comment
    • Delete a Task Attachment
    • Perform an Action on a Task
    • Perform Bulk Action on Tasks
    • Retrieve a Custom Task List
    • Retrieve a List of Task Conversations
    • Retrieve a Task
    • Retrieve a Task Attachment as a Stream
    • Retrieve a Task Attachment by Name
    • Retrieve a Task Conversation by Conversation ID
    • Retrieve a Task List
    • Retrieve Custom Task Lists
    • Retrieve DOCs Folder Details by Folder ID for a Task
    • Retrieve DOCs Folder Details for a Task
    • Retrieve Task Attachments
    • Retrieve Task Comments
    • Retrieve Task History
    • Retrieve Task Metrics for the User
    • Retrieve the Task Payload
    • Update the Task Payload