redmine.org の Rest_Versions (version 4)の日本語訳です。

• 目次
• REST バージョン
  • フォーマット /projects/:project_id/versions
    • GET
    • POST
  • フォーマット /versions/:id
    • GET
    • PUT
    • DELETE

REST バージョン¶

フォーマット /projects/:project_id/versions¶

GET¶

ID または識別名(:project_id) で指定されたプロジェクトで利用可能なバージョンのリストを取得します。
レスポンスには他のプロジェクトから共有しているバージョンも含みます。

例:

GET /project/foo/versions.xml
GET /project/1/versions.xml

レスポンス:

<?xml version="1.0" encoding="UTF-8"?>
<versions type="array" total_count="34">
  <version>
    <id>1</id>
    <project name="Redmine" id="1"/>
    <name>0.7</name>
    <description/>
    <status>closed</status>
    <due_date>2008-04-28</due_date>
    <created_on>2008-03-09T12:52:06+01:00</created_on>
    <updated_on>2009-11-15T12:22:12+01:00</updated_on>
  </version>
  <version>
    <id>2</id>
    <project name="Redmine" id="1"/>
    <name>0.8</name>
    <description/>
    <status>closed</status>
    <due_date>2008-12-30</due_date>
    <created_on>2008-03-09T12:52:12+01:00</created_on>
    <updated_on>2009-11-15T12:22:12+01:00</updated_on>
  </version>
</versions>

POST¶

ID または識別名(:project_id) で指定したプロジェクトに対してバージョンを作成します。

要素:

• version (必須): 以下の子要素を持ちます
  • name (必須) : 名称
  • status: バージョンのステータス
    • open (デフォルト) : 進行中
    • locked : ロック中
    • closed : 終了
  • sharing: 共有 t
    • none (デフォルト): 共有しない
    • descendants : サブプロジェクト単位
    • hierarchy : プロジェクト階層単位
    • tree : プロジェクトツリー単位
    • system :すべてのプロジェクト
  • due_date : 期日
  • description : 説明

レスポンス:

• 201 Created: バージョンを作成しました。
• 422 Unprocessable Entity: 妥当性の検証で失敗したため、バージョンは作成されてません。(レスポンスにはエラーメッセージが格納されます)

フォーマット /versions/:id¶

GET¶

ID で指定したバージョンを取得します。

例:

GET /versions/2.xml

レスポンス:

<?xml version="1.0" encoding="UTF-8"?>
<version>
  <id>2</id>
  <project name="Redmine" id="1"/>
  <name>0.8</name>
  <description/>
  <status>closed</status>
  <due_date>2008-12-30</due_date>
  <created_on>2008-03-09T12:52:12+01:00</created_on>
  <updated_on>2009-11-15T12:22:12+01:00</updated_on>
</version>

PUT¶

指定した ID のバージョンを更新します。

要素:

作成時のものと同じです。

レスポンス:

• 200 OK: バージョンを更新しました。
• 422 Unprocessable Entity: 妥当性の検証で失敗したため、バージョンは更新されていません。(レスポンスにはエラーメッセージが格納されます)

DELETE¶

指定した ID のバージョンを削除します。

Response:

• 200 OK: バージョンを削除しました。
• 422 Unprocessable Entity: バージョンの削除に失敗しました。(レスポンスにはエラーメッセージが格納されます)