1. Oracle Integration REST APIREST API for Oracle Integration 3
  2. Send Requests

Send Requests

Use the following guidelines when sending requests using the Oracle Integration REST API.

To call Oracle Integration REST resources, you need to create the required URL using any one of the following URLs:

  • Service console URL

    To obtain this URL, sign in to your Oracle Cloud Infrastructure console and navigate to the required Oracle Integration instance. On the Integration instance details page, click the Copy link beside the Service console URL field to copy this URL. For more information about how to access this page, see View Instance Details.

  • Design time URL

    To obtain this URL, paste the service console URL in a new browser window. When the login page of the Integration instance displays, note that the URL changes to a design time URL. All design time URLs start with the word design as shown in the following example:

    Example: https://design.integration.region.ocp.oraclecloud.com/?integrationInstance=NameOfServiceInstance

    The first part of the URL https://design.integration.region.ocp.oraclecloud.com is your rest-server and the rest of the URL integrationInstance=NameOfServiceInstance contains the name of the service instance.

Creating a URL Using Design Time URL

Access the Oracle Integration REST resources using the following URL structure:

https://<rest-server>/<resource-path>?integrationInstance=<service-instance>

Where:

  • rest-server

    Get this from your instance's design time URL. For example, if your design time URL is https://design.integration.region.ocp.oraclecloud.com/?integrationInstance=NameOfServiceInstance, your REST server is: design.integration.region.ocp.oraclecloud.com.

  • resource-path

    This is the relative path that defines the REST endpoint. For a complete list of REST endpoints, see All REST Endpoints.

    • For feature API: /ic/api/<component>/<version>/

    Where component is the feature component and version is the REST API version.

  • service-instance

    This is the name of the integration instance.

Example of curl command:

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/integrations/HELLO_WORLD%7C01.02.0000?integrationInstance=service-instance-name

Creating a URL Using Service Console URL

To call Integration REST resources using the service console URL, use the following URL structure:

https://<Service-console-URL>/<resource-path>

Example:

https://testInstance-abcd-zx-ay.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/integrations/HELLO_WORLD%7C01.02.0000

Note:

The Service console URL does not contain the service instance query parameter.

Example of curl command:

curl -X GET -H 'Authorization: Bearer access_token' --location-trusted -H "Accept:application/json" https://testInstance-abcd-zx-ay.integration.region.ocp.oraclecloud.com//ic/api/integration/v1/integrations/HELLO_WORLD%7C01.02.0000

Note:

The curl command must contain the curl option --location-trusted.

Supported Methods

You can perform basic CRUD operations (create, read, update, and delete) on Oracle Integration Service resources using standard HTTP method requests, as summarized in the following table.

HTTP Method Description
GET Retrieve information about a resource.
POST Create a resource.
PUT Update a resource.
DELETE Delete a resource.

Supported Media Types

The media types supported by the Oracle Integration REST API are:

  • application/json

Supported Headers

The Oracle Integration REST API supports the following headers that may be passed in the header section of the HTTP request or response.

Header Description Example
Content-Type

Media type of the body of the request. Required for POST requests.

 Content-Type: application/json
Accept

Media type of the body of the response.

 Accept: application/json
X-ID-TENANT-NAME

Identity domain name of the service, used for authentication.

 X-ID-TENANT-NAME:ExampleIdentityDomain