Module groups

Groups Rest API Endpoint definitions

Redmine Documentation

• all groups endpoint
• specific group endpoint
• create group endpoint
• update group endpoint
• delete group endpoint
• add user to group endpoint
• remove user from group endpoint

Structs

AddUserToGroup

The endpoint to add a Redmine user to a Redmine group

AddUserToGroupBuilder

Builder for AddUserToGroup.

CreateGroup

The endpoint to create a Redmine group

CreateGroupBuilder

Builder for CreateGroup.

DeleteGroup

The endpoint to delete a Redmine group

DeleteGroupBuilder

Builder for DeleteGroup.

GetGroup

The endpoint for a specific Redmine group

GetGroupBuilder

Builder for GetGroup.

Group

a type for groups to use as an API return type

GroupEssentials

a minimal type for Redmine groups used in lists of groups included in other Redmine objects

GroupWrapper

A lot of APIs in Redmine wrap their data in an extra layer, this is a helper struct for outer layers with a group field holding the inner data

GroupsWrapper

helper struct for outer layers with a groups field holding the inner data

ListGroups

The endpoint for all Redmine groups

ListGroupsBuilder

Builder for ListGroups.

RemoveUserFromGroup

The endpoint to remove a Redmine user from a Redmine group

RemoveUserFromGroupBuilder

Builder for RemoveUserFromGroup.

UpdateGroup

The endpoint to update an existing Redmine group

UpdateGroupBuilder

Builder for UpdateGroup.

Enums

AddUserToGroupBuilderError

Error type for AddUserToGroupBuilder

CreateGroupBuilderError

Error type for CreateGroupBuilder

DeleteGroupBuilderError

Error type for DeleteGroupBuilder

GetGroupBuilderError

Error type for GetGroupBuilder

GroupInclude

The types of associated data which can be fetched along with a group

ListGroupsBuilderError

Error type for ListGroupsBuilder

RemoveUserFromGroupBuilderError

Error type for RemoveUserFromGroupBuilder

UpdateGroupBuilderError

Error type for UpdateGroupBuilder