Module issues

Issues Rest API Endpoint definitions

Redmine Documentation

Redmine Documentation Journals (Journals in Redmine terminology are notes/comments and change histories for an issue)

• all issues endpoint
  • sort
    • limit sort to the existing columns only instead of a string value
  • query_id parameter
  • pagination
  • issue_id filter
    • issue id (multiple are possible, comma separated)
  • project_id filter
    • project id (multiple are possible, comma separated)
  • subproject_id filter
    • !* filter to only get parent project issues
  • tracker_id filter
    • tracker id (multiple are possible, comma separated)
  • status_id filter
    • open (default)
    • closed
    • • for both
    • status id (multiple are possible, comma separated)
  • category_id filter
    • category id (multiple are possible, comma separated)
  • priority_id filter
    • priority id (multiple are possible, comma separated)
  • author_id filter
    • any
    • me
    • !me
    • user/group id (multiple are possible, comma separated)
    • negation of list
  • assigned_to_id filter
    • any
    • me
    • !me
    • user/group id (multiple are possible, comma separated)
    • negation of list
    • none (!*)
  • fixed_version_id filter (Target version, API uses old name)
    • version id (multiple are possible, comma separated)
  • is_private filter
  • parent_id filter
    • issue id (multiple are possible, comma separated)
  • custom field filter
    • exact match
    • substring match
    • what about multiple value custom fields?
  • subject filter
    • exact match
    • substring match
  • description filter
    • exact match
    • substring match
  • done_ratio filter
    • exact match
    • less than, greater than ?
    • range?
  • estimated_hours filter
    • exact match
    • less than, greater than ?
    • range?
  • created_on filter
    • exact match
    • less than, greater than
    • date range
  • updated_on filter
    • exact match
    • less than, greater than
    • date range
  • start_date filter
    • exact match
    • less than, greater than
    • date range
  • due_date filter
    • exact match
    • less than, greater than
    • date range
• specific issue endpoint
• create issue endpoint
  • attachments
• update issue endpoint
  • attachments
• delete issue endpoint
• add watcher endpoint
• remove watcher endpoint

Structs

AddWatcher

The endpoint to add a Redmine user as a watcher on a Redmine issue

AddWatcherBuilder

Builder for AddWatcher.

AssigneeEssentials

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

ChildIssue

minimal issue used e.g. in child issues

CreateIssue

The endpoint to create a Redmine issue

CreateIssueBuilder

Builder for CreateIssue.

CustomField

a custom field

DeleteIssue

The endpoint to delete a Redmine issue

DeleteIssueBuilder

Builder for DeleteIssue.

GetIssue

The endpoint for a specific Redmine issue

GetIssueBuilder

Builder for GetIssue.

Issue

a type for issue to use as an API return type

IssueEssentials

a minimal type for Redmine issues included in other Redmine objects

IssueWrapper

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

IssuesWrapper

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

Journal

journals (issue comments and changes)

JournalChange

a changed attribute entry in a journal entry

ListIssues

The endpoint for all Redmine issues

ListIssuesBuilder

Builder for ListIssues.

RemoveWatcher

The endpoint to remove a Redmine user from a Redmine issue as a watcher

RemoveWatcherBuilder

Builder for RemoveWatcher.

UpdateIssue

The endpoint to update an existing Redmine issue

UpdateIssueBuilder

Builder for UpdateIssue.

UploadedAttachment

the information the uploader needs to supply for an attachment in CreateIssue or UpdateIssue

Enums

AddWatcherBuilderError

Error type for AddWatcherBuilder

AssigneeFilter

ways to filter for users or groups in assignee

AuthorFilter

ways to filter for users in author (always a user (not group), never !*)

ChangePropertyType

the type of journal change

ComparableFilter

Filter for a comparable filter (those you can use ranges, less, greater,…) on

CreateIssueBuilderError

Error type for CreateIssueBuilder

DeleteIssueBuilderError

Error type for DeleteIssueBuilder

GetIssueBuilderError

Error type for GetIssueBuilder

IssueInclude

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

IssueListInclude

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

ListIssuesBuilderError

Error type for ListIssuesBuilder

RemoveWatcherBuilderError

Error type for RemoveWatcherBuilder

SortByColumn

Sort by this column

StatusFilter

ways to filter for issue status

StringFieldFilter

Filter options for subject and description

SubProjectFilter

ways to filter for subproject

UpdateIssueBuilderError

Error type for UpdateIssueBuilder

Traits

ComparableFilterValue

a trait for comparable filter values, we do not just use Display because one of our main application is dates and we need a specific format