Send Requests
Use these guidelines when sending requests using the Oracle Health Immunization Management Cloud Service REST API.
URL Structure
Here's the URL structure for the requests:
https://<domain_name>.ohms.oracle.com/ords/esi_api/<resource_path>
Where:
<domain_name>
is the fully qualified domain name of the host server for Oracle Health Immunization Management Cloud Service.-
<resource_path>
is the relative path that defines the resource. For example:/api/v1/groups
Supported Methods
You can perform basic CRUD operations (create, read, update, and delete) on a resource by using standard HTTP method requests, as summarized in the following table.
HTTP Method | Description |
GET |
Retrieve information about the Oracle Health Immunization Management Cloud Service resource. |
POST |
Create the Oracle Health Immunization Management Cloud Service resource. |
PUT |
Update the Oracle Health Immunization Management Cloud Service resource. |
Media Types
The following media types are supported by the Oracle Health Immunization Management Cloud Service REST API:
-
application/json
Supported Headers
The Oracle Health Immunization Management Cloud Service 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 |
Authorization |
The header for IDCS. To generate an authorization token, see Authenticate. | Authorization: Bearer <access_token> |
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 Health Immunization Management Cloud Service, used for authentication. | X-ID-TENANT-NAME:ExampleIdentityDomain |
Compression
Use compression on the Oracle Health Immunization Management Cloud Service REST resource request and response for improved performance. To use compression, include one of the following HTTP headers in the request: Accept-Encoding
or Content-Encoding
.