Get Members of an Instance
get
/process/api/v1/instances/{id}/members
Member with READ permission and above can get all members of a process instance.
Request
Path Parameters
-
id(required): string
Process instance ID
Query Parameters
-
limit: integer
The number of items to return. If parameter is omitted default value 25 is set. If limit <=0 or limit> 50 then upto 50 records are returned.=0>Default Value:
25
-
memberLabel: string
member label
-
memberPermission: string
member permission
-
offset: integer
0 based index. The number of items to skip before starting to collect the result set. to return.
-
orderBy: string
This parameter specifies the order by clause. The value must follow the format of fieldName[:(asc/desc)][,fieldName[:(asc/desc)]]*. e.g. label:asc. Multiple ordering is not supported. The supported attributes include: permission and label
Header Parameters
-
oci-original-url:
Endpoint requested by customer
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : Link
Type:
object
Defines Link
Show Source
-
code: integer
Minimum Value:
100
Maximum Value:600
-
href(required): string
-
hreflang: string
-
length: integer
(int32)
-
mediaType: string
-
message: string
-
rel(required): string
-
title: string
-
type: string
Nested Schema : Member
Type:
Show Source
object
-
identityId: string
The identity ID of the member
-
identityName: string
The identity name of the member
-
identityType: string
The identity type of the member
-
label: string
The label of the member
-
level: string
Allowed Values:
[ "INSPECT", "READ", "USE", "MANAGE" ]
The permission level of the member
Examples
401 Response
Unauthorized
Examples
500 Response
Internal server error