Returns all project roles.

GET

Returns all project roles.

Required Permissions: Any authenticated user.

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.

isDefaultbooleanOptional

Whether to use this role as default when adding new project members.

defaultProjectRoleIdstringOptionalformat: "uuid"

The id of the new default project role. Required if the updated project role is the current default role.

allowOnlyProjectMasterDataReadbooleanOptional

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

idstringOptionalformat: "uuid"

The id of the project role.

memberCountintegerOptional

The count of members which are linked to this role.

memberslist of objectsOptional

The members which are linked to this role.

createdOndatetimeOptional

The date this entity was created.

createdBystringOptionalformat: "uuid"

The id of the user who created this entity.

updatedOndatetimeOptional

The date this entity was last modified.

updatedBystringOptionalformat: "uuid"

The id of the user who last modified this entity.

Creates a new project role.
Built with