Redmine

ATTENTION: ALPHA STAGE

This plugin exposes Redmine's REST API under an alternate base path and unlocks write access for administrative resources (Roles, Trackers, Custom Fields, etc.) that are read-only in the standard Redmine API.

It reuses Redmine's native controllers, permissions, and validations, ensuring that data integrity matches the web UI.

Features¶

• Drop-in Proxy: A mirror of the core API at /extended_api. Any request that works on the standard API works here too.
• Admin Write Access: Adds POST, PUT, and DELETE endpoints for:
  • Roles
  • Trackers
  • Issue Statuses
  • Enumerations (Priorities, Activities, etc.)
  • Custom Fields
• Migration Utilities: Special parameters to assist with data imports:
  • Suppress email notifications (notify=false).
  • Preserve original authors and timestamps (created_on/updated_on) during issue/journal creation (Admin only).

Usage¶

To use the extended features, simply prepend /extended_api to any Redmine API path.

• Authentication: Works exactly like core Redmine (via X-Redmine-API-Key header or Basic Auth).
• Format: Accepts and returns JSON (.json) or XML (.xml).

Migration & Imports¶

The extended API is designed to help import data from other systems.

• Suppress Emails: Append notify=false to your payload to stop Redmine from sending emails for that specific request.
• History Preservation: When using the extended API as an admin, you can explicitly set author_id, created_on, updated_on, and closed_on to backfill historical data accurately.

1. Clone the repository into your plugins directory:
   

   cd redmine/plugins
   git clone https://github.com/jcatrysse/redmine_extended_api.git
   

2. Restart Redmine.

No database migrations are required.