Chapter 2. REST

The management REST component is responsible for mapping RESTful requests to management requests. It does this by locating the managed resource, mapping the request URL to a management address, then invoking an operation on that managed resource. It defines an entry point for RESTful clients, and exposes the registered managed resources and operations over REST.

2.1. Entry Point

To gain access to management resources and operations over REST a RESTful client must know the entry point URL, which is defined as follows:

Example 2.1. URL Syntax

http(s)://<host>:<port>/<rest-context-name>/private/managed-components

Where the rest-context-name is the portal container's rest context name. So for the default portal, the rest context name is 'rest', and for a portal running on localhost and port 8080 the URL would be

Example 2.2. URL Example

http://localhost:8080/rest/private/managed-components/

Note

The REST URL is protected, and the authenticated user must belong to the 'administrators' group of the portal.