Rest api with ruby » History » Revision 10
Revision 9 (Marcin Garski, 2016-04-25 14:37) → Revision 10/15 (Toshi MARUYAMA, 2016-04-25 15:28)
h1. Using the REST API with Ruby Redmine REST API follows the Rails's RESTful conventions, so using it with "ActiveResource":http://api.rubyonrails.org/classes/ActiveResource/Base.html is pretty straightforward. h2. ActiveResource On Redmine 3.x (Rails 4.2), you need to add 'activeresource' gem. For example, at Gemfile.local: <pre><code class="ruby"> gem 'activeresource' </code></pre> Here is a simple ruby script that demonstrates how to use the Redmine REST API: <pre> <code class="ruby"> require 'rubygems' require 'active_resource' # Issue model on the client side class Issue < ActiveResource::Base self.site = 'http://redmine.server/' self.user = 'foo' self.password = 'bar' end # Retrieving issues issues = Issue.find(:all) puts issues.first.subject # Retrieving an issue issue = Issue.find(1) puts issue.description puts issue.author.name # Creating an issue issue = Issue.new( :subject => 'REST API', :assigned_to_id => 1, :project_id => 1 # custom field with id=2 exist in database :custom_fields => [{id: 2, value: "IT"}] ) if issue.save puts issue.id else puts issue.errors.full_messages end # Updating an issue issue = Issue.find(1) issue.subject = 'REST API' issue.save # Deleting an issue issue = Issue.find(1) #issue.destroy </code> </pre> _You may need to set @include_root_in_json = true@ in your ActiveResource class_