Send Requests
Use the following guidelines when sending requests using Oracle WebCenter Portal REST API.
URL Structure
https://hostname:port/rest/api/v1/resource-path?utoken=sampletoken
-
hostname
- name of the host where the WebCenter Portal is running. -
port
- IP Port where the WebCenter Portal is running. -
/rest/api/v1
- Fixed prefix for WebCenter Portal REST resources. For a complete list of resources, see Using the WebCenter Portal REST APIs. -
resource-path
is the relative path that defines the REST endpoint. For example,/portal/portals. For a complete list of REST endpoints, see All REST Endpoints.
-
utoken
is the API token for accessing the portal APIs. See Authentication.
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:
|
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:
|
utoken |
API token received from the Oracle WebCenter Portal. API token will be received when the resource index page ( |
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 following are the supported media types by the WebCenter Portal REST API:
-
application/json
-
application/xml
-
text/xml
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
|