Send Requests
Use the following guidelines when sending requests using the Oracle Integration REST API.
URL Structure
Access the Oracle Integration REST resources using the following URL structure:
https://rest-server/resource-path
Where:
-
rest-server
can be obtained from your instance URL. For example, if your instance URL ishttps://example.integration.us.oraclecloud.com/ic/home/
, your REST server is:example.integration.us.oraclecloud.com
. -
resource-path
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 andversion
is the REST API version. -
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. |
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 |