Module redmine_api::api::roles

source · [−]
Expand description

Roles Rest API Endpoint definitions

Redmine Documentation

  • all roles endpoint
  • specific role endpoint

Structs

GetRole
The endpoint for a specific role
GetRoleBuilder
Builder for GetRole.
ListRoles
The endpoint for all roles
ListRolesBuilder
Builder for ListRoles.
Role
a type for roles to use as an API return type
RoleEssentials
a minimal type for Redmine roles used in lists of roles included in other Redmine objects (e.g. custom fields) and also in the global ListRoles endpoint (unlike most other Redmine API objects)
RoleWrapper
A lot of APIs in Redmine wrap their data in an extra layer, this is a helper struct for outer layers with a role field holding the inner data
RolesWrapper
helper struct for outer layers with a roles field holding the inner data

Enums

GetRoleBuilderError
Error type for GetRoleBuilder
IssuesVisibility
determines which issues are visible to users/group with a role
ListRolesBuilderError
Error type for ListRolesBuilder
TimeEntriesVisibility
determines which time entries are visible to users/group with a role
UsersVisibility
determines which users are visible to users/group with a role