Send Requests

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

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://server:port/ArchiveService/rest/ArchiveService/api/v1/archives/{resource}

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.

Table - Supported Methods

HTTP Method	Description
POST	Create a new resource in OIPA instance.
GET	Retrieve data for an OIPA resource.

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

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

Table - Headers

Header	Description	Example
Accept	Media type for the response body. Note that unless an operation specifies otherwise, the type is application/json.	Accept:application/json
Content-Type	Media type of the request body. Required for POST and PUT requests.	application/x-www-form-urlencoded