r-labs

redmine.org の "Rest_Projects":http://www.redmine.org/projects/redmine/wiki/Rest_Projects (version 10)の日本語訳です。

{{>toc}}

h1. REST プロジェクト

h2. 一覧

  GET /projects.xml

全てのプロジェクトのリストを取得します。

+レスポンス+:

<pre><code class="xml">

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

</code></pre>

h2. 表示

  GET /projects/[id].xml

ID や識別名で指定したプロジェクトの情報を取得します。 

+パラメーター+:

* @include@ (オプション): 関連情報を含めます。指定可能な値は以下の 2 つです。

** trackers (トラッカー)

** issue_categories (チケットのカテゴリ)

+例+:

<pre>

GET /projects/12.xml

GET /projects/12.xml?include=trackers 

GET /projects/12.xml?include=trackers,issue_categories 

GET /projects/redmine.xml

</pre>

+レスポンス+:

<pre><code class="xml">

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

</code></pre>

h2. 作成

  POST /projects.xml

プロジェクトを作成します。

+要素+:

* @project@ (必須): 以下の子要素を指定します。

  * @name@ (必須): 名称

  * @identifier@ (必須): 識別子

  * @description@ : 説明

+レスポンス+:

  * @201 Created@: プロジェクトは作成されました。

  * @422 Unprocessable Entity@: 妥当性の検証でエラーが発生し、プロジェクトの作成に失敗しました。

    (レスポンスの中身はエラーメッセージです。)

h2. 更新

  PUT /projects/[id].xml

ID や識別子で指定したプロジェクトを更新します。

h2. 削除

  DELETE /projects/[id].xml

ID や識別子で指定したプロジェクトを削除します。