Send Requests
Use the following guidelines when sending requests using the Oracle GoldenGate REST API.
URL Structure
Each Oracle GoldenGate Service runs on a separate port. Access the Oracle GoldenGate REST resources using the following URL structure:
The Service Manager runs on
https://localhost:port/or
https://localhost:port/
where host:port localhost and port are
where Oracle GoldenGate is running.
Supported Methods
You can perform basic CRUD operations (create, read, update, and delete) on Oracle GoldenGate using standard HTTP method requests, as summarized in the following table.
| HTTP Method | Description |
GET |
Retrieve information about the object. |
HEAD |
Retrieve header information about the object. |
POST |
Update the object. |
PUT |
Update the object. |
PATCH |
Patch the object. |
OPTIONS |
Retrieve information about the options and requirements for the object. |
DELETE |
Delete the object. |
Media Types
The following media types are supported by the Oracle GoldenGate REST API:
-
application/json -
application/schema+json -
text/plain -
text/html -
application/xml
Supported Headers
The Oracle GoldenGate REST API supports the following headers that may be passed in the header section of the HTTP request or response.
| Header | Description | Example |
Accept-Encoding |
List of acceptable encodings to support compression. | Accept-Encoding: gzip |
Content-Encoding |
List of acceptable encodings to support compression. | Content-Encoding: deflate |
Content-Type |
Media type of the body of the request. Required for
POST and PUT
requests.
|
Content-Type: application/json |
X-ID-TENANT-NAME |
Identity domain name of Oracle GoldenGate, used for authentication. | X-ID-TENANT-NAME:ExampleIdentityDomain |