REST API for Oracle WebCenter Portal

URL Structure

Access the Oracle WebCenter Portal REST API resources using the following URL structure:

https://hostname:port.com:/rest/api/

Where:

hostname - name of the host where the WebCenter Portal is running.
port - IP Port where the WebCenter Portal is running.
/rest/api/ - Fixed prefix for WebCenter Portal REST resources. For a complete list of resources, see Using the WebCenter Portal REST APIs.

Request Data Format

Request body parameters have the following format:

{"name1":"value1", "name2":"value2", "name3":"value3" }

If a parameter has subparameters, the parameters are enclosed in square brackets:

{"name1":[{"subname1":"subvalue1"},{"subname2":"subvalue2"}] }

Common Query Parameters

Use the query parameters listed in the following table with GET operations that retrieve lists.

HTTP Method	Description
`limit`	Maximum number of list items per page, between 1 and 100. Default is 25. For example, this sets the items per page to 15: `?limit=15`
`offset`	Index for the first item on a page of list items. Default is 1. For example, if the items per page is 15, this starts on the second page: `?offset=16`
`utoken`	API token received from the Oracle WebCenter Portal. API token will be received when the resource index page (`http://hostname:port/rest/api`) is accessed with authentication.

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.

Supported Headers

The Oracle WebCenter Portal REST API supports the following headers that may be passed in the header section of the HTTP request or response.

Header	Description	Example
`Content-Type`	Media type of the body of the request. Required for POST requests.	`Content-Type: application/json`
`Accept`	Media type of the body of the response.	`Accept: application/json`

Send Requests