redmine.org の Rest_Trackers (version 2)の日本語訳です。

• 目次
• REST チケットカテゴリ
  • フォーマット /projects/:project_id/issue_categories
    • GET
    • POST
  • フォーマット /issue_categories/:id
    • GET
    • PUT
    • DELETE

REST チケットカテゴリ¶

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

GET¶

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

例:

GET /project/foo/issue_categories.xml
GET /project/1/issue_categories.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>

POST¶

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

要素:

• issue_category (必須): 以下の子要素を持ちます。
  • name (必須) : 名称
  • assigned_to_id: カテゴリの担当者のユーザー ID (このカテゴリを持つチケットを新しく作成した場合、ここで指定されたユーザーが担当者のデフォルトになります)

レスポンス:

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

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

GET¶

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

例:

GET /issue_categories/2.xml

レスポンス:

<?xml version="1.0" encoding="UTF-8"?>
<issue_category>
  <id>2</id>
  <project name="Redmine" id="1"/>
  <name>UI</name>
</version>

PUT¶

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

要素:

作成と同じです。

レスポンス:

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

DELETE¶

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

パラメーター:

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

例:

DELETE /issue_categories/2.xml
DELETE /issue_categories/2.xml?reassign_to_id=1

レスポンス:

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