List Dynamic Process Roles
get
/ic/api/process/v1/dp-roles
Get a list of dynamic process roles.
Request
Supported Media Types
- application/json
Query Parameters
-
displayName: string
Filter by process role display name.
-
firstResult: integer
Pagination of results. Specifies the index of the first result to return.Default Value:
-1
-
group: array[string]
Collection Format:
multi
Group name -
maxResults: integer
Pagination of results. Specifies the maximum number of results to return. Returns fewer results if there are no more results left.Default Value:
-1
-
processDefinitionId: string
Filter by process definition ID. Exact match. Used in combination with processInstanceId.
-
processInstanceId: string
Filter by process instance ID. Exact match. Used in combination with processDefinitionId.
-
scopeType: array[string]
Collection Format:
multi
Filter by process role scopeType.-
Allowed Values:
[ "GLOBAL", "DEFINITION", "INSTANCE" ]
-
-
type: string
Type of roleDefault Value:
all
-
userId: string
User id
Response
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : ProcessRoles
Type:
object
Match All
Show Source
-
object
CommonModel
Discriminator:
links
-
object
ProcessRoles-allOf[1]
Nested Schema : ProcessRole
Type:
object
Match All
Show Source
-
object
CommonModel
Discriminator:
links
-
object
ProcessRole-allOf[1]
Nested Schema : ProcessRole-allOf[1]
Type:
Show Source
object
-
displayName:
string
The display name of the process role
-
id:
string
The ID of the process role.
-
overriddenRoleId:
string
The ID of the definition or global scope role overriden by this role
-
scopes:
array scopes
-
scopeType:
string
Allowed Values:
[ "GLOBAL", "DEFINITION", "INSTANCE" ]
400 Response
Returned if some of the query parameters are not valid.
401 Response
Unauthorized.
403 Response
Forbidden.
500 Response
Internal Server Error.