Projects¶

Listing projects¶

GET /projects.xml

Returns all projects

Response:

<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>

Showing a project¶

GET /projects/[id].xml

Returns the project of given id or identifier.

Parameters:

• include: fetch associated data (optional). Possible values: trackers, issue_categories. To fetch multiple associations use comma (e.g ?include=relations,journals)

Examples:

GET /projects/12.xml
GET /projects/redmine.xml

Response:

<?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>

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)

Updating a project¶

PUT /projects/[id].xml

Updates the project of given id or identifier.

Deleting a project¶

DELETE /projects/[id].xml

Deletes the project of given id or identifier.