Actions
redmine.org の Rest_Issues の日本語訳です。
REST ユーザー¶
一覧¶
GET /users.xml
ユーザーの一覧を取得します。
表示¶
GET /users/[id].xml
ID で指定したユーザーの情報を取得します。
GET /users/current.xml
使用している API キーのユーザーの情報を取得します。
パラメーター:
include
: 共通パラメーターmemberships
: プロジェクトメンバーとしての情報
例:
GET /users/3.xml?include=memberships
ユーザーのプロジェクトメンバーに関する情報を付けて、ID が 3 のユーザーに関する情報を取得します。
レスポンス:
<user>
<id>3</id>
<login>jplang</login>
<firstname>Jean-Philippe</firstname>
<lastname>Lang</lastname>
<mail>jp_lang@yahoo.fr</mail>
<created_on>2007-09-28T00:16:04+02:00</created_on>
<last_login_on>2011-08-01T18:05:45+02:00</last_login_on>
<custom_fields type="array" />
<memberships type="array">
<membership>
<project name="Redmine" id="1"/>
<roles type="array">
<role name="Administrator" id="3"/>
<role name="Contributor" id="4"/>
</roles>
</membership>
<membership>
</user>
作成¶
POST /users.xml
ユーザーを作成します。
要素:
user
(必須): 以下の子要素を持ちます。login
(必須): ログイン名password
: パスワードfirstname
(必須): 名lastname
(必須): 苗字mail
(必須) : メールアドレス- ..
例:
POST /users.xml
<?xml version="1.0" encoding="ISO-8859-1" ?>
<user>
<login>jplang</login>
<firstname>Jean-Philippe</firstname>
<lastname>Lang</lastname>
<password>secret</password>
<mail>jp_lang@yahoo.fr</mail>
</user>
レスポンス:
201 Created
: ユーザーは作成されました。422 Unprocessable Entity
: 妥当性の検証でエラーが発生し、ユーザーの作成に失敗しました。
(レスポンスの中身はエラーメッセージです。)
更新¶
PUT /users/[id].xml
ID でユーザーを指定して更新します。
パラメーター:
user
(必須): 作成時と同じ子要素を持ちます。
削除¶
DELETE /users/[id].xml
ID でユーザーを指定して削除します。
レスポンス:
200 OK
: ユーザーが削除されました。
Updated by Mitsuyoshi Yoshida about 13 years ago · 2 revisions