Authorization Resource Options

The /authorization resource supports two custom OPTIONS requests, one for the resource as such and one for individual authorization instances. The OPTIONS request allows you to check for the set of available operations that the currently authenticated user can perform on the /authorization resource. Whether the user can perform an operation or not may depend on various factors, including the users authorizations to interact with this resource and the internal configuration of the process engine.

Method

OPTIONS /authorization for available interactions on resource

OPTIONS /authorization/{id} for available interactions on resource instance

Result

A JSON object with a single property named links, providing a list of resource links. Each link has the following properties

Name Value Description
method String The HTTP method to use for the interaction.
href String The interaction URL
rel String The relation of the interaction (ie. a symbolic name representing the nature of the interaction). Examples: create, delete ...

Response Codes

Code Media type Description
200 application/json Request successful.

Example

Request

OPTIONS /authorization/anAuthorizationId

Response

Status 200.

{"links":[
  {"method": "GET", href":"http://localhost:8080/engine-rest/authorization/anAuthorizationId", "rel":"self"},
  {"method": "PUT", href":"http://localhost:8080/engine-rest/authorization/anAuthorizationId", "rel":"update"},
  {"method": "DELETE", href":"http://localhost:8080/engine-rest/authorization/anAuthorizationId", "rel":"delete"}]}

On this Page: