Edit on Github

Filter Resource Options

The /filter resource supports two custom OPTIONS requests, one for the resource as such and one for individual filter instances. The OPTIONS request allows you to check for the set of available operations that the currently authenticated user can perform on the /filter 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 /filter for available interactions on resource.

OPTIONS /filter/{id} for available interactions on resource instance.

Result

A JSON object with a single property named links, providing a list of resource links that are allowed actions for the current user. 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 (i.e., 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 /filter/aFilterId

Response

Status 200.

{"links":[
  {"method": "GET", href":"http://localhost:8080/engine-rest/filter/aFilterId", "rel":"self"},
  {"method": "GET", href":"http://localhost:8080/engine-rest/filter/aFilterId/singleResult", "rel":"singleResult"}
  {"method": "POST", href":"http://localhost:8080/engine-rest/filter/aFilterId/singleResult", "rel":"singleResult"}
  {"method": "GET", href":"http://localhost:8080/engine-rest/filter/aFilterId/list", "rel":"list"}
  {"method": "POST", href":"http://localhost:8080/engine-rest/filter/aFilterId/list", "rel":"list"}
  {"method": "GET", href":"http://localhost:8080/engine-rest/filter/aFilterId/count", "rel":"count"}
  {"method": "POST", href":"http://localhost:8080/engine-rest/filter/aFilterId/count", "rel":"count"}
  {"method": "PUT", href":"http://localhost:8080/engine-rest/filter/aFilterId", "rel":"update"},
  {"method": "DELETE", href":"http://localhost:8080/engine-rest/filter/aFilterId", "rel":"delete"}]}

Options