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/PASService/rest/services/v1/{resource}

Supported Methods

The user 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
POST Create a new resource in OIPA instance.
GET Retrieve data for an OIPA resource.
PUT Update data on an OIPA resource.
DELETE Delete an OIPA instance.

Request Media Types

Unless specified otherwise, the OIPA REST API supports application/json. Also, service layer accpets application/xml as well for REST Wrapper servcies.

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
  • Accept:application/xml
Content-Type Media type of the request body. Required for POST and PUT requests. application/x-www-form-urlencoded