A webapp which can be used to serve some missing redmine REST API resources. Currently these are:
- custom fields
- enumerations
The information is deliviered with the MIME type 'application/xml'. Caution: this webapp is dependent on the underlying redmine database layout, currently redmine 1.4.4 works for sure. Others might work, check your database tables against the layout described in the section 'Technical Information'
To create a customized webapp, do the following:
- copy the configuration template 'redmine-databases.groovy.template' to 'redmine-databases.groovy'
- modify this file according to your needs
- run the command 'gradlew war'
- copy the JAR of your jdbc driver (e.g. mysql-connector-java-5.1.21.jar) to your containers lib folder (consult your containers documentation for where JDBC drivers should be placed)
- Alternatively you can modify the build-dependencies.gradle file and add your jdbc driver there
- deploy the generated war file from build/libs to your favorite servlet container, you probably want to rename the war file first (maybe just remove the version number)
Once deployed the webapp can be called to deliver the information. Which information that is, is determined by the extra path information. Right now this is either
- /custom_fields or */enumerations So if your webapp is deployed to a context 'missapi' and the webapp url is http://myserver.com/missapi, you would receive the definition of custom_fields by calling 'http://myserver.com/missapi/custom_fields?location=&key=<REDMINE_REST_API_KEY>&type='. The parameters location, key and type are mandatory:
- location
- one of the configured locations, see your redmine-databases.groovy file (or the web.xml) for possible values
- key
- the api key, this value can be found in your redmine instance. Go to 'My Account' in redmine, and find your personal REST api access key on the right side.
- type
- one of the possible redmine customfield types (look in your redmine database in the table 'custom_fields' for possible values)
Additionally the following optional parameters are supported
- reload
- Beware that the value is irrelevant, if this parameter is present it always signals true. So reload=false does not mean what it should, but rather reload=true.
- Tells the servlet that it should reread the cached values. Useful if you modified the customfields or enumerations in your redmine instance.
To test your webapp, call your server and provide the necessary parameters e.g. for custom_fields:
and for enumerations:
This project is written in groovy. It uses gradle as a build system, and has the gradle wrapper task active - therefore no installation of gradle is necessary to run the build. This webapp works for redmine 1.4.4 database layout, but may also work with other versions. Redmine 1.4.4 has the following database tables:
- table CUSTOM_FIELDS:
| Field | Type | Null | Key | Default | Extra |
|---|---|---|---|---|---|
| id | int(11) | NO | PRI | NULL | auto_increment |
| type | varchar(30) | NO | |||
| name | varchar(30) | NO | |||
| field_format | varchar(30) | NO | |||
| possible_values | text | YES | NULL | ||
| regexp | varchar(255) | YES | |||
| min_length | int(11) | NO | 0 | ||
| max_length | int(11) | NO | 0 | ||
| is_required | tinyint(1) | NO | 0 | ||
| is_for_all | tinyint(1) | NO | 0 | ||
| is_filter | tinyint(1) | NO | 0 | ||
| position | int(11) | YES | 1 | ||
| searchable | tinyint(1) | YES | 0 | ||
| default_value | text | YES | NULL | ||
| editable | tinyint(1) | YES | 1 | ||
| visible | tinyint(1) | NO | 1 | ||
| multiple | tinyint(1) | YES | 0 |
- table ENUMERATIONS:
| Field | Type | Null | Key | Default | Extra |
|---|---|---|---|---|---|
| id | int(11) | NO | PRI | NULL | auto_increment |
| name | varchar(30) | NO | |||
| position | int(11) | YES | 1 | ||
| is_default | tinyint(1) | NO | 0 | ||
| type | varchar(255) | YES | NULL | ||
| active | tinyint(1) | NO | 1 | ||
| project_id | int(11) | YES | MUL | NULL | |
| parent_id | int(11) | YES | NULL |