Request Structure
Use the following guidelines when sending requests using the WebCenter Sites Aggregate REST API.
URL Structure
https://hostname:port.com:/rest/api/
-
<host>:<port>
is the host and port where WebCenter Sites is running. -
<context>
is a WebCenter Sites context. -
<resource-path>
is the relative path that defines the resource. To see all the resource paths, go to "REST Endpoints" in the Table of Contents.
Supported Methods
You can perform basic CRUD operations (create, read, update, and delete) on Oracle WebCenter Portal using standard HTTP method requests, as summarized in the following table.
HTTP Method | Description |
GET |
Retrieve information about a resource. |
POST |
Create or update a resource. |
DELETE |
Delete a resource. |
PUT |
Update a resource. |
Media Types
The only media type supported by the WebCenter Portal REST API is application/json
.
Etag
The WebCenter Sites Aggregate REST API uses ETag, an HTTP mechanism for web cache validation. Every resource request, which can be cached, contains ETag in the response header. The ETag mechanism allows caches to be more efficient, and it saves bandwidth because the web server does not need to send a full response if the content has not changed on subsequent requests. For more information about ETag, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.19