Send Requests

Use the following guidelines when sending requests using the OID REST API.

URL Structure

Access the OID REST resources using the following URL structure:

https://<subdomain>.<domain>.com:<port>/<resource-path>

Where:

• <subdomain.domain>.com:<port> is the host and port where OID is running.

• <resource-path>is the relative path that defines the resource.

Supported Methods

You can perform HTTP read operation on an OID resource as summarized in the following table.

HTTP Method	Description
GET	Retrieve one or more complete or partial resources.

Media Types

The following media types are supported by the OID Service REST API:

• application/json

Supported Headers

The OID 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
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-Response-Time	The time in milliseconds to process the request.	X-Response-Time: 1000
Authorization	Authentication credentials for HTTP authentication.
Origin	Initiates a request for cross origin resource sharing (CORS)

Compression

Use compression on the OID 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.