Send Requests
Use the following guidelines when sending requests using the REST API for Oracle SOA Cloud Service on Oracle Public Cloud Machine.
URL Structure
Access the Oracle SOA Cloud Service REST resources using the following URL structure:
https://api-host/paas/service/soa/api/v1.1/resource-path
Where:
api-host: Host name. Get the host name (which may or may not include a port number) from your account administrator.
resource-path : Relative path that defines the REST endpoint. For a complete list of REST endpoints, see REST Endpoints.
Supported Methods
You can perform basic CRUD operations (create, read, update, and delete) on your Oracle SOA Cloud Service instances using standard HTTP method requests, as summarized in the following table.
This table describes HTTP methods supported in the Oracle SOA Cloud Service REST API.
| HTTP Method | Description |
|---|---|
| GET | Retrieve information about the Oracle SOA Cloud Service instance. |
| POST | Create, stop, start, scale, backup, restore, or patch an Oracle SOA Cloud Service instance. |
| PUT | Update or delete an Oracle SOA Cloud Service instance. |
| DELETE | Delete an Oracle SOA Cloud Service instance component. |
Supported Headers
The Oracle SOA Cloud Service REST API supports the following headers that may be passed in the header section of the HTTP request or response.
This table describes HTTP request and response headers supported in the Oracle SOA Cloud Service REST API.
| Header | Description | Example |
|---|---|---|
| Content-type | Media type of the request body. Required for POST and PUT requests. | Content-type: application/json |
| X-ID-TENANT-NAME | Identity domain name of the Oracle SOA Cloud Service instance, used for authentication. | X-ID-TENANT-NAME:ExampleIdentityDomain |