Group Membership Resource Options

The OPTIONS request allows checking for the set of available operations that the currently authenticated user can perform on the resource. The fact whether the user can perform an operation or not may depend on various things, including the users authorizations to interact with this resource and the internal configuration of the process engine.

Method

OPTIONS /group/{id}/members for available interactions on resource

Parameters

Path Parameters

Name Description
id The id of the group.

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 /group/sales/members

Response

Status 200.

{"links":[
    {"method":"GET","href":"http://localhost:8080/camunda/api/engine/engine/default/group/sales/members","rel":"self"},
    {"method":"DELETE","href":"http://localhost:8080/camunda/api/engine/engine/default/group/sales/members","rel":"delete"},
    {"method":"PUT","href":"http://localhost:8080/camunda/api/engine/engine/default/group/sales/members","rel":"create"}]
}

On this Page: