r-labs

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

{{>toc}}

h1. REST チケットカテゴリ

h2. フォーマット  /projects/:project_id/issue_categories

h3. GET

ID または識別名(:project_id) で指定されたプロジェクトで利用可能なリストを取得します。

+例+:

<pre>

GET /project/foo/issue_categories.xml

GET /project/1/issue_categories.xml

</pre>

+レスポンス+:

<pre><code class="xml">

<?xml version="1.0" encoding="UTF-8"?>

<issue_categories type="array" total_count="2">

  <issue_category>

    <id>57</id>

    <project name="Foo" id="17"/>

    <name>UI</name>

    <assigned_to name="John Smith" id="22"/>

  </issue_category>

  <issue_category>

    <id>58</id>

    <project name="Foo" id="17"/>

    <name>Test</name>

  </issue_category>

</issue_categories>

</code></pre>

h3. POST

ID または識別名(:project_id) で指定したプロジェクトに対してチケットカテゴリを作成します。

+要素+:

* @issue_category@ (必須): 以下の子要素を持ちます。

** @name@ (必須) : 名称

** @assigned_to_id@: カテゴリの担当者のユーザー ID (このカテゴリを持つチケットを新しく作成した場合、ここで指定されたユーザーが担当者のデフォルトになります)

+レスポンス+:

* @201 Created@: チケットカテゴリは作成されました。

* @422 Unprocessable Entity@: 妥当性の検証に失敗したため、チケットカテゴリは作成されていません。(レスポンスにはエラーメッセージが格納されます)

h2. フォーマット /issue_categories/:id

h3. GET

指定した ID のチケットカテゴリを取得します。

+例+:

<pre>

GET /issue_categories/2.xml

</pre>

+レスポンス+:

<pre><code class="xml">

<?xml version="1.0" encoding="UTF-8"?>

<issue_category>

  <id>2</id>

  <project name="Redmine" id="1"/>

  <name>UI</name>

</version>

</code></pre>

h3. PUT

指定した ID のチケットカテゴリを更新します。

+要素+:

作成と同じです。

+レスポンス+:

* @201 Created@: チケットカテゴリが更新されました。

* @422 Unprocessable Entity@: 妥当性の検証で失敗したため、チケットカテゴリは更新されていません。(レスポンスにはエラーメッセージが格納されます)

h3. DELETE

指定した ID のチケットカテゴリを削除します。

+パラメーター+:

* @reassign_to_id@ (オプション): 削除するカテゴリが割り当てられたチケットがあった場合、このパラメーターの ID を持つカテゴリに再割り当てされます。

+例+:

<pre>

DELETE /issue_categories/2.xml

DELETE /issue_categories/2.xml?reassign_to_id=1

</pre>

+レスポンス+:

* @200 OK@: チケットカテゴリは削除されました。