Rest Projects » 履歴 » バージョン 1
Mitsuyoshi Yoshida, 2011/11/13 12:19
1 | 1 | Mitsuyoshi Yoshida | redmine.org の "Rest_Projects":http://www.redmine.org/projects/redmine/wiki/Rest_Projects の日本語訳です。 |
---|---|---|---|
2 | |||
3 | {{>toc}} |
||
4 | |||
5 | |||
6 | h1. REST プロジェクト |
||
7 | |||
8 | h2. 一覧 |
||
9 | |||
10 | GET /projects.xml |
||
11 | |||
12 | 全てのプロジェクトの情報が返ってきます。 |
||
13 | |||
14 | + レスポンス +: |
||
15 | |||
16 | <pre><code class="xml"> |
||
17 | <projects type="array"> |
||
18 | <project> |
||
19 | <id>1</id> |
||
20 | <name>Redmine</name> |
||
21 | <identifier>redmine</identifier> |
||
22 | <description> |
||
23 | Redmine is a flexible project management web application written using Ruby on Rails framework. |
||
24 | </description> |
||
25 | <created_on>Sat Sep 29 12:03:04 +0200 2007</created_on> |
||
26 | <updated_on>Sun Mar 15 12:35:11 +0100 2009</updated_on> |
||
27 | </project> |
||
28 | <project> |
||
29 | <id>2</id> |
||
30 | ... |
||
31 | </project> |
||
32 | </code></pre> |
||
33 | |||
34 | |||
35 | h2. 表示 |
||
36 | |||
37 | GET /projects/[id].xml |
||
38 | |||
39 | ID や識別名で指定したプロジェクトの情報が返ってきます。 |
||
40 | |||
41 | +例+: |
||
42 | |||
43 | <pre> |
||
44 | GET /projects/12.xml |
||
45 | GET /projects/redmine.xml |
||
46 | </pre> |
||
47 | |||
48 | +レスポンス+: |
||
49 | |||
50 | <pre><code class="xml"> |
||
51 | <?xml version="1.0" encoding="UTF-8"?> |
||
52 | <project id="1"> |
||
53 | <name>Redmine</name> |
||
54 | <identifier>redmine</identifier> |
||
55 | <description> |
||
56 | Redmine is a flexible project management web application written using Ruby on Rails framework. |
||
57 | </description> |
||
58 | <homepage></homepage> |
||
59 | <created_on>Sat Sep 29 12:03:04 +0200 2007</created_on> |
||
60 | <updated_on>Sun Mar 15 12:35:11 +0100 2009</updated_on> |
||
61 | </project> |
||
62 | </code></pre> |
||
63 | |||
64 | |||
65 | h2. 作成 |
||
66 | |||
67 | POST /projects.xml |
||
68 | |||
69 | プロジェクトを作成します。 |
||
70 | |||
71 | +要素+: |
||
72 | |||
73 | * @project@ (必須): 以下の子要素を指定します。 |
||
74 | |||
75 | * @name@ (必須): 名称 |
||
76 | * @identifier@ (必須): 識別子 |
||
77 | * @description@ : 説明 |
||
78 | |||
79 | +レスポンス+: |
||
80 | |||
81 | * @201 Created@: プロジェクトは作成されました。 |
||
82 | * @422 Unprocessable Entity@: 妥当性の検証でエラーが発生し、プロジェクトの作成に失敗しました。 |
||
83 | (レスポンスの中身はエラーメッセージです。) |
||
84 | |||
85 | h2. 更新 |
||
86 | |||
87 | PUT /projects/[id].xml |
||
88 | |||
89 | ID や識別子で指定したプロジェクトを更新します。 |
||
90 | |||
91 | h2. 削除 |
||
92 | |||
93 | DELETE /projects/[id].xml |
||
94 | |||
95 | ID や識別子で指定したプロジェクトを削除します。 |