Feature #9664

CRUD operations for "custom field definitions" (not setting custom fields on issues!)

Added by Alex Last almost 6 years ago. Updated over 2 years ago.

Status:NewStart date:2011-11-25
Priority:NormalDue date:
Assignee:Etienne Massip% Done:

0%

Category:REST API
Target version:-
Resolution:

Description

my Redmine Java API tests check that a new Issue has some custom fields set.
to do that, I have to create those custom field definitions in Redmine manually first.

would be nice to improve the tests so that they could create the required custom fields in Redmine - but unfortunately Redmine's REST API does not allow that.
Again, I'm talking about creating custom fields definitions in Redmine install, not setting already defined custom fields on an Issue.

I understand that this operation would probably require an admin permission - that's fine.

redmine-customfields-rest.patch Magnifier (1.69 KB) Vincent Caron, 2013-09-24 14:25


Related issues

Related to Redmine - Feature #11159: REST API for getting CustomField definitions Closed
Related to Redmine - Feature #18966: API - Custom field creation Closed
Duplicated by Redmine - Feature #18848: Expand custom field API Closed

History

#1 Updated by Alex Last over 5 years ago

  • Assignee set to Etienne Massip

can you please take a look at this request?

#2 Updated by Alex Last about 5 years ago

any chance of getting this implemented anytime soon?

#3 Updated by St├ęphane Klein over 4 years ago

+1

#4 Updated by Vincent Caron about 4 years ago

I have a patch which implement only the 'R' part, that is lists the available custom fields, for admin users (redmine-customfields-rest.patch). It has been tested on Redmine 2.3.0 and 2.3.2.

And here is a wiki doc which would fit as http://www.redmine.org/projects/redmine/wiki/Rest_IssueCategories :

Custom Fields

/custom_fields.xml

GET

Returns all custom field definitions.

Example:

GET /custom_fields.xml

Response:

<?xml version="1.0" encoding="UTF-8"?>
<custom_fields type="array" limit="4" total_count="4" offset="0">
  <custom_field>
    <id>1</id>
    <name>Foobarity</name>
    <type>IssueCustomField</type>
    <format>list</format>
    <required>false</required>
    <searchable>true</searchable>
    <multiple_values>false</multiple_values>
    <possible_values type="array">
      <value>Foo</value>
      <value>Bar</value>
      <value>None</value>
    </possible_values>
    <default_value>None</default_value>
  </custom_field>
  ...
</custom_fields>

#5 Updated by Jean-Philippe Lang about 4 years ago

  • Related to Feature #11159: REST API for getting CustomField definitions added

#6 Updated by Mischa The Evil over 2 years ago

#7 Updated by Toshi MARUYAMA over 2 years ago

#8 Updated by Ieuan Jenkins over 2 years ago

Just to note, this is useful for another situation than that mentioned in the original description: we have a situation where a custom field dropdown list relates to some external references that change at regular intervals via an automated process.

It would be useful (and much tidier/safer) to be able to update this list via the REST API rather than our current solution of updating the custom_fields DB table directly.

Also available in: Atom PDF