Send Requests
Use the following guidelines when sending requests using the developer API for Oracle Cloud Infrastructure Process Automation.
URL Structure
Access the REST resources using the following URL structure:
https://rest-server/resource-path
Where:
-
rest-servercan be obtained from your instance URL. For example, if your instance URL ishttps://example.processautomation.us.oraclecloud.com/ic/home/, your REST server is:example.processautomation.us.oraclecloud.com. -
resource-pathis the relative path that defines the REST endpoint. For a complete list of REST endpoints, see All REST Endpoints.-
For feature API:
/process/api/v1
-
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 REST API are:
-
application/json
Supported Headers
The 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 |