Send Requests

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

URI Structure

To perform operations on an OIPA resource by using REST API calls, you must specify the fully-qualified, unique URI of the resource.

The fully qualified URI of a resource is in the following format:

https://host:port/PASJava/service/caches/{resource}

Supported Methods

You can perform basic operations, such as create, read, and update on an OIPA resource by using standard HTTP methods, as summarized in the following table.

HTTP Method Description

DELETE

DELETE data on an OIPA resource.

Request Media Types

Unless specified otherwise, the OIPA REST API supports application/json.

Supported Headers

The OIPA REST API supports headers that may be passed in the header section of an HTTP request or response.

Header Description Example

Accept

Media type for the response body.

Accept:application/json

Content-Type

Media type of the request body. Required for POST and PUT requests.

application/x-www-form-urlencoded