Rest Projects » History » Version 4

Version 3 (Christoph Witzany, 2010-07-05 07:39) → Version 4/36 (Ryan Lovelett, 2010-07-26 00:25)

h1. Projects

h2. Listing projects

GET /projects.xml

Returns all projects

+Response+:

<pre>
<projects type="array">
<project>
<id>1</id>
<name>Redmine</name>
<identifier>redmine</identifier>
<description>
Redmine is a flexible project management web application written using Ruby on Rails framework.
</description>
<created_on>Sat Sep 29 12:03:04 +0200 2007</created_on>
<updated_on>Sun Mar 15 12:35:11 +0100 2009</updated_on>
</project>
<project>
<id>2</id>
...
</project>
</pre>

h2. Showing a project

GET /projects/[id].xml

Returns the project of given id or identifier.

+Examples+:

<pre>
GET /projects/12.xml
GET /projects/redmine.xml
</pre>

+Response+:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<project id="1">
<name>Redmine</name>
<identifier>redmine</identifier>
<description>
Redmine is a flexible project management web application written using Ruby on Rails framework.
</description>
<homepage></homepage>
<created_on>Sat Sep 29 12:03:04 +0200 2007</created_on>
<updated_on>Sun Mar 15 12:35:11 +0100 2009</updated_on>
</project>
</pre>

h2. Creating a project

POST /projects.xml

Creates a the project.

+Parameters+:

* @project@ (required): a hash of the project attributes, including:

* @name@ (required): the project name
* @identifier@ (required): the project identifier
* @description@

+Response+:

* @201 Created@: project was created
* @422 Unprocessable Entity@: project was not created due to validation failures (response body contains the error messages)

h2. Updating a project

PUT /projects/[id].xml

Updates the project of given id or identifier.

h2. Deleting a project

DELETE /projects/[id].xml

Deletes the project of given id or identifier.

h2. Authentication

To interact with issues that are not open to the public you _must_ use your API key.

+Examples _(not real keys)_+:

<pre>
GET /projects.xml?key=1a022b4661da64e5dca53ebab0c94ad7
GET /projects/12.xml?key=1a022b4661da64e5dca53ebab0c94ad7
GET /projects/redmine.xml&key=1a022b4661da64e5dca53ebab0c94ad7
</pre>