Redmine

@webframp/redminev2026.04.30.2· 1mo agoMODELS

01README

Redmine issue tracker integration — workflow-agnostic CRUD model.

Provides 26 model methods covering issues, projects, statuses, trackers, users, custom fields, relations, versions, time entries, watchers, search, issue categories, journal editing, and file uploads. Designed as composable primitives for building any workflow on top of Redmine.

For opinionated Kanban workflows, flow metrics, and sprint reports, see @webframp/redmine-kanban.

Quick Start

swamp extension pull @webframp/redmine
swamp model create @webframp/redmine tracker \
  --global-arg host=https://your-redmine.example.org \
  --global-arg apiKey=YOUR_API_KEY \
  --global-arg project=your-project

02Models1

@webframp/redminev2026.04.30.1redmine/redmine.ts

Global Arguments

Argument	Type	Required	Description
host	string	yes	Redmine instance URL (e.g. https://redmine.example.com)
apiKey	string	yes	Redmine API key (40-character hex string)
project	string	yes	Default project identifier
username?	string	no	Redmine username for X-Redmine-Username header (required by some ingress configurations)

fn list_statuses()

List all issue statuses

fn list_trackers()

List all trackers

fn list_projects()

List all accessible projects

fn list_users(project?: string)

List project memberships (users and groups with their roles)

Argument	Type	Required	Description
project?	string	no	Project identifier (defaults to global project arg)

fn list_custom_fields()

List all custom field definitions

fn list_issues(project?: string, trackerId?: number, statusId?: union, assignedToId?: union, parentId?: number, limit?: number, sort?: string)

List issues matching filters

Argument	Type	Required	Description
project?	string	no	Project identifier
trackerId?	number	no	Filter by tracker ID
statusId?	union	no	Filter by status ID or open/closed/*
assignedToId?	union	no	Filter by assignee ID or 'me'
parentId?	number	no	Filter by parent issue ID
limit?	number	no	Max results (default 25, max 100)
sort?	string	no	Sort field (e.g., 'updated_on:desc')

fn get_issue(issueId: number)

Get a single issue with journals and children

Argument	Type	Required	Description
issueId	number	yes	Issue ID

fn create_issue(subject: string, project?: string, trackerId?: number, statusId?: number, priorityId?: number, assignedToId?: number, description?: string, parentIssueId?: number, estimatedHours?: number, customFields?: array)

Create a new issue

Argument	Type	Required	Description
subject	string	yes	Issue subject
project?	string	no	Project identifier
trackerId?	number	no	Tracker ID
statusId?	number	no	Status ID
priorityId?	number	no	Priority ID
assignedToId?	number	no	Assignee user ID
description?	string	no	Issue description
parentIssueId?	number	no	Parent issue ID
estimatedHours?	number	no	Estimated hours
customFields?	array	no	Custom field values

fn update_issue(issueId: number, subject?: string, trackerId?: number, statusId?: number, priorityId?: number, assignedToId?: number, description?: string, parentIssueId?: number, estimatedHours?: number, doneRatio?: number, dueDate?: string, notes?: string, customFields?: array)

Update an existing issue

Argument	Type	Required	Description
issueId	number	yes	Issue ID to update
subject?	string	no	New subject
trackerId?	number	no	New tracker ID
statusId?	number	no	New status ID
priorityId?	number	no	New priority ID
assignedToId?	number	no	New assignee user ID
description?	string	no	New description
parentIssueId?	number	no	New parent issue ID
estimatedHours?	number	no	New estimated hours
doneRatio?	number	no	Percent done (0-100)
dueDate?	string	no	Updated due date (YYYY-MM-DD)
notes?	string	no	Journal note to add
customFields?	array	no	Custom field values to update

fn delete_issue(issueId: number)

Delete an issue

Argument	Type	Required	Description
issueId	number	yes	Issue ID to delete

fn list_relations(issueId: number)

List relations for an issue

Argument	Type	Required	Description
issueId	number	yes	Issue ID

fn create_relation(issueId: number, issueToId: number, relationType: enum, delay?: number)

Create a relation between two issues

Argument	Type	Required	Description
issueId	number	yes	Source issue ID
issueToId	number	yes	Target issue ID
relationType	enum	yes	Relation type
delay?	number	no	Delay in days (for precedes/follows)

fn delete_relation(relationId: number)

Delete a relation

Argument	Type	Required	Description
relationId	number	yes	Relation ID to delete

fn list_versions(project?: string)

List project versions (milestones/sprints)

Argument	Type	Required	Description
project?	string	no	Project identifier (defaults to global project arg)

fn list_time_entries(issueId?: number, project?: string, userId?: number, from?: string, to?: string, limit?: number)

List time entries, optionally filtered by issue or project

Argument	Type	Required	Description
issueId?	number	no	Filter by issue ID
project?	string	no	Filter by project identifier
userId?	number	no	Filter by user ID
from?	string	no	Start date (YYYY-MM-DD)
to?	string	no	End date (YYYY-MM-DD)
limit?	number	no	Max results (default 25)

fn log_time(issueId: number, hours: number, activityId?: number, comments?: string, spentOn?: string)

Log time spent on an issue

Argument	Type	Required	Description
issueId	number	yes	Issue ID
hours	number	yes	Hours spent
activityId?	number	no	Activity ID
comments?	string	no	Comment
spentOn?	string	no	Date spent (YYYY-MM-DD, defaults to today)

fn add_watcher(issueId: number, userId: number)

Add a watcher to an issue

Argument	Type	Required	Description
issueId	number	yes	Issue ID
userId	number	yes	User ID to add as watcher

fn remove_watcher(issueId: number, userId: number)

Remove a watcher from an issue

Argument	Type	Required	Description
issueId	number	yes	Issue ID
userId	number	yes	User ID to remove as watcher

fn search(query: string, project?: string, limit?: number)

Search across issues, projects, and wiki pages

Argument	Type	Required	Description
query	string	yes	Search query
project?	string	no	Scope search to project identifier
limit?	number	no	Max results (default 25)

fn get_version(versionId: number)

Get a single version by ID

Argument	Type	Required	Description
versionId	number	yes	Version ID

fn create_version(project?: string, name: string, description?: string, status?: enum, dueDate?: string, sharing?: enum, wikiPageTitle?: string)

Create a project version (milestone/sprint)

Argument	Type	Required	Description
project?	string	no	Project identifier (defaults to global project arg)
name	string	yes	Version name
description?	string	no	Description
status?	enum	no	Version status
dueDate?	string	no	Due date (YYYY-MM-DD)
sharing?	enum	no	Sharing scope
wikiPageTitle?	string	no	Wiki page title

fn update_version(versionId: number, name?: string, description?: string, status?: enum, dueDate?: string, sharing?: enum, wikiPageTitle?: string)

Update a version

Argument	Type	Required	Description
versionId	number	yes	Version ID
name?	string	no	New name
description?	string	no	New description
status?	enum	no	New status
dueDate?	string	no	New due date (YYYY-MM-DD)
sharing?	enum	no	New sharing scope
wikiPageTitle?	string	no	New wiki page title

fn delete_version(versionId: number)

Delete a version

Argument	Type	Required	Description
versionId	number	yes	Version ID to delete

fn update_journal(journalId: number, notes: string, privateNotes?: boolean)

Update a journal entry's notes

Argument	Type	Required	Description
journalId	number	yes	Journal ID
notes	string	yes	Updated notes content
privateNotes?	boolean	no	Mark notes as private

fn list_issue_categories(project?: string)

List issue categories for a project

Argument	Type	Required	Description
project?	string	no	Project identifier (defaults to global project arg)

fn upload_file(issueId: number, filePath: string, filename?: string, description?: string, contentType?: string)

Upload a file and attach it to an issue (two-step: upload binary, then attach token)

Argument	Type	Required	Description
issueId	number	yes	Issue ID to attach the file to
filePath	string	yes	Local file path to upload (relative to working directory)
filename?	string	no	Filename for the attachment (defaults to basename of filePath)
description?	string	no	Attachment description
contentType?	string	no	MIME type (auto-detected from filename if omitted)

Resources

issues(30m)— List of issues matching query filters

issue_detail(30m)— Single issue with journals and children

projects(1h)— List of accessible projects

statuses(infinite)— Issue statuses (id, name, isClosed)

trackers(infinite)— Trackers (id, name, defaultStatus, description)

users(1h)— Project memberships (users and groups with roles)

custom_fields(infinite)— Custom field definitions (id, name, fieldFormat, possibleValues, ...)

relations(30m)— Issue relations (blocks, precedes, relates, etc.)

versions(1h)— Project versions (milestones/sprints)

time_entries(30m)— Time entries for issues or projects

search_results(15m)— Search results across issues, projects, and wiki

issue_categories(1h)— Issue categories for a project

03Previous Versions5

2026.04.30.1May 1, 2026

Modified 1 models

2026.04.22.3Apr 23, 2026

2026.04.22.2Apr 23, 2026

2026.04.22.1Apr 22, 2026

2026.04.14.1Apr 14, 2026

04Stats

100 / 100

Downloads

Archive size

22.1 KB

Has README or module doc2/2earned
README has a code example1/1earned
README is substantive1/1earned
Most symbols documented1/1earned
No slow types1/1earned
Has description1/1earned
Platform support declared (or universal)2/2earned
License declared1/1earned
Verified public repository2/2earned

Repository

https://github.com/webframp/swamp-extensions

05Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

06Labels

#redmine #issue-tracker #api