TIP RedmineQueryPlugin is not installed on Foswiki.org.

Redmine Query Plugin

A simple plugin to query Redmine issues over a REST API using JSON

Usage

The plugin provides the macro RMQ (for Redmine Query)

The following parameters can be used:

Parameter name Description Default value
id The id of an issue. If this is set, other filters are ignored (except for the project filter which is always set)  
format Format of a single line of output, which can contain the variables $id, $fixed_version, $assigned_to, $priority, $status, $tracker, $subject, $category, $due_date REDMINEQUERYPLUGIN_FORMAT
tracker Filter on the id of a tracker (see /tracker.xml on redmine for mapping). Multiple ids can be specified. REDMINEQUERYPLUGIN_TRACKER
status Filter on the id of a status (see /issue_statuses.xml on redmine for mapping). Multiple ids can be specified. REDMINEQUERYPLUGIN_STATUS
category Filter on the name of category. Returns error message if category is unknown to Redmine.  
fixed_version Filter on the name of fixed_version. Returns error message if version is unknown to Redmine.  

Preferences

Plugin preferences should be set using configure, as described in DevelopingPlugins.

You can also use preference settings to define any user-controllable configuration.

  • Set FORMAT = | $due_date | $tracker:$id | $subject | $assigned_to | $status | $category |
  • Set TRACKER = 1|2|3
  • Set STATUS = 1|2|3|5|6

Installation

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.

The following settings have to be set in configure:
  • Limit: Limit the maximum number of issues received / displayed
  • ApiKey: A valid Redmine API key
  • RedmineUrl: The base URL for the redmine instance
  • ProjectIdentifier: The filter on a single project, which is always active

Dependencies

None

Change History

0.2 (2017-02-07) Improved error handling
0.1 (2017-02-02 Initial version

PackageForm edit

Author PhilippHoppen
Version 0.2
Release 2017-02-07
Description A simple plugin to query Redmine issues over a REST API using JSON
Copyright 2017, PhilippHoppen, All Rights Reserved
License
Home
Support
Repository
ExtensionClassification Data and Files
ExtensionType PluginPackage
Compatibility v2.1.0
IncompatibleWith
ImageUrl
DemoUrl http://
SupportUrl RedmineQueryPlugin
ModificationPolicy CoordinateWithAuthor
Topic revision: r1 - 21 Feb 2017, PhilippHoppen - This page was cached on 04 Jun 2017 - 20:01.

The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. See Copyright Statement. Creative Commons License