Feature #1214

REST API for Issues

Added by Eric Davis over 6 years ago. Updated over 4 years ago.

Status:ClosedStart date:2008-05-08
Priority:NormalDue date:
Assignee:Eric Davis% Done:

100%

Category:REST API
Target version:1.0.0 (RC)
Resolution:Fixed

Description

Part of the main REST API issue (#296), this should expose some APIs to work with issues.

  • Get a list of issues
  • Create a new issue
  • Update an existing issue
  • Delete an issue

Related issues

Related to Feature #296: REST API Closed
Related to Feature #5305: "related issues" info is required in XML data New 2010-04-13
Blocked by Feature #3920: REST API for authentication Closed 2009-09-25

Associated revisions

Revision 3310
Added by Jean-Philippe Lang almost 5 years ago

XML REST API for issues that provides CRUD operations for Issues (#1214).

Revision 3766
Added by Eric Davis over 4 years ago

Added JSON support to the issues API. #1214

History

#1 Updated by Doug Raney over 6 years ago

Im for this approach as well. See #725. I would like to see this API implemented as SOAP 1.2 compliant.

#2 Updated by Nikolay Kotlyarov almost 5 years ago

+1.
Need this to replace "csv import plugin"(and then import thousands of tasks from excel)

#3 Updated by Michael Ivanov almost 5 years ago

Incidentally, the author of "csv import plugin" recognizes that the plugin does not work: (.
Are there any other methods of import issues in large volumes?

P.S. I speak English not just bad, but badly, I know:)

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

  • Category changed from Issues to REST API
  • Status changed from New to Resolved
  • Target version set to 0.9.1
  • Resolution set to Fixed

Feature added in r3310.
Documentation started at Rest_api.

#5 Updated by Nikolay Kotlyarov almost 5 years ago

You've done it maaan:))) Awesome!!! Big thanks, Jean!

#6 Updated by Eric Davis almost 5 years ago

Shouldn't this be targeted for 1.0 and not 0.9.1? I thought the 0.9 series was in RC and new features are for 1.0 only?

#7 Updated by Jean-Philippe Lang almost 5 years ago

You're right, 0.9 is in RC.
But it's not a big change and it would be a shame to have a API style authentication without any API behind in 0.9. This API should be considered as a draft in 0.9 so we can get some feedback and improve it for 1.0.

#8 Updated by Eric Davis almost 5 years ago

Jean-Philippe Lang wrote:

But it's not a big change and it would be a shame to have a API style authentication without any API behind in 0.9. This API should be considered as a draft in 0.9 so we can get some feedback and improve it for 1.0.

I'd disagree, this is a moderate sized change. It adds an entire API, new views, and some more routes. (From what I'm seeing, it's also missing the JSON format)

Also 0.9 already included part of the XML/JSON API for News to test the API authentications (http://www.redmine.org/issues/3920#note-8). My goal was to get API authentication tested and into 0.9 so plugin developers can take advantage of it to build APIs for their plugins while the core had time to refine the main REST API.

#9 Updated by Jean-Philippe Lang almost 5 years ago

  • Target version changed from 0.9.1 to 1.0.0 (RC)

#10 Updated by Henrik Mohr almost 5 years ago

I just updated our installation today from master (github) -> version 0.9.1.

  • /projects.xml returns usable XML, but
  • /issues.xml returns html

The begin of the HTML is:

    <h2>Issues</h2>

    <form action="/queries/new" id="query_form" method="post"><div style="margin:0;padding:0;display:inline"><input name="authenticity_token" type="hidden" value="TgnsQpEayRkvUZGDHNfYmQSvo/Fs/yQPPnK/Pz6IM8Y=" /></div>

        <div id="query_form_content">
    <fieldset id="filters"><legend>Filters</legend>
    <script type="text/javascript">

Any ideas on what is wrong?

#11 Updated by Lane Roathe almost 5 years ago

I am looking forward to seeing this happen. For areas I am interested in using it, I would want JSON data (for example, any mobile device at this time handles XML very slowly compared to JSON), so I am glad to see it's being provided so far and I hope continues to be going forward. :)

#12 Updated by Hannes Horneber almost 5 years ago

I’ve got the same issue like Henrik. Projects.xml works just fine, but issues.xml returns html.
I just updated from github to Version 0.9.2dev.
Any Ideas?

#13 Updated by Felix Schäfer almost 5 years ago

Hannes and Henrik, the issues.xml issue is a new bug regarding functionality that has been introduced and is believed to be working, please file a new bug for that problem.

#14 Updated by Hannes Horneber almost 5 years ago

Hi there... I just submitted a bug report Issues #4795.
Hopefully this is going to be fixed soon ;-)

#15 Updated by Hannes Horneber almost 5 years ago

Just to give some feedback. The problem Henrik and I mentioned was solved for me, if I removed the redmine_subtasks_plugin.
Is had nothing to do with redmine itself.

#16 Updated by Eric Davis almost 5 years ago

  • Status changed from Resolved to 7
  • Resolution deleted (Fixed)

Reopening this, the JSON format isn't finished yet and I want to make sure it isn't missed.

#17 Updated by Eric Davis over 4 years ago

  • Status changed from 7 to Closed
  • Assignee set to Eric Davis
  • % Done changed from 0 to 100
  • Resolution set to Fixed

Added json support to the issues API (r3766).

Also available in: Atom PDF