Structure of the remote REST service for PUMA | HCL Digital Experience
The interface provided by the remote REST service for PUMA defines single operations that are characterized by a particular URI path, the HTTP method, the expected input or output, and a list of query parameters. With regards to the input or output format, the interface only describes a common baseline for the payload, which can be wrapped or represented individually by different implementations of the service.
Remote REST service structure
All URI paths that the interface defines start with the prefix /um. This can be considered as the identifying part of the service. Implementations of the
service can add additional path elements before the /um element, for
example to represent the context root of a servlet. Therefore clients should not assume that the
complete servlet path always starts with /um.
URI paths that start with /um/secure will be served only within a
valid user context, that is only in an authenticated request. If the /secure path element is omitted, this means that the operation is performed in the context
of the anonymous user. For simplicity, the interface description denotes all URI paths without the
/secure element. However, all corresponding operations can be
performed for both authenticated and anonymous users. For operations related to authenticated users
you have to prefix the /secure element. This also implies that the
particular implementation of the interface has to make sure to apply the appropriate access control
checks before executing an operation.
Variable parts within URI paths or query parameters can contain special characters. These must be encoded in order to represent valid path elements or parameters. The interface defines that UTF-8 must be used by the client and that URLs returned by the server are UTF-8 encoded.
- Request parameter postAction with a value of put or delete. The case is ignored.
- Request header X-Method-Override with a value of put or delete. The case is ignored.