API v1 ReferenceProject Roles

Returns all project roles.

Returns all project roles.

Required Permissions
Any authenticated user.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

includeMembersbooleanOptionalDefaults to true
If set, all the assigned members to that role a included in the response. Default is true.
pageintegerOptionalDefaults to 1
Page number for pagination
pageSizeintegerOptionalDefaults to 10
Number of items per page
orderbystringOptional
The properties to order by
filterbystringOptional
The filter expression to filter by

Response

OK
namestring>=0 characters<=255 characters
The name of the project role. Required.
isDefaultboolean or null
Whether to use this role as default when adding new project members.
defaultProjectRoleIdUUID or null
The id of the new default project role. Required if the updated project role is the current default role.
allowOnlyProjectMasterDataReadboolean or null

Whether this role is allowed to have only read permissions for project-master-data.

idUUID or null
The id of the project role.
memberCountinteger or null
The count of members which are linked to this role.
memberslist of objects or null
The members which are linked to this role.
createdOndatetime or null
The date this entity was created.
createdByUUID or null
The id of the user who created this entity.
updatedOndatetime or null
The date this entity was last modified.
updatedByUUID or null
The id of the user who last modified this entity.