redmine.org の Rest_IssueRelations (version 3)の日本語訳です。

• 目次
• 関係するチケット
  • フォーマット /issues/:issue_id/relations
    • GET
    • POST
  • フォーマット /relations/:id
    • GET
    • DELETE

関係するチケット¶

フォーマット /issues/:issue_id/relations¶

GET¶

ID(:issue_id) で指定したチケットに対して、関係するチケットの情報の一覧を取得します。

例:

GET /issues/8470/relations.xml

レスポンス:

<?xml version="1.0" encoding="UTF-8"?>
<relations type="array">
  <relation>
    <id>1819</id>
    <issue_id>8470</issue_id>
    <issue_to_id>8469</issue_to_id>
    <relation_type>relates</relation_type>
    <delay/>
  </relation>
  <relation>
    <id>1820</id>
    <issue_id>8470</issue_id>
    <issue_to_id>8467</issue_to_id>
    <relation_type>relates</relation_type>
    <delay/>
  </relation>
</relations>

Note: チケット情報とその関係するチケット情報を取得したい場合は、 /issues/:issue_id.xml?include=relations と記述すると一度に取得することが出来ます。

POST¶

ID(:issue_id) で指定したチケットに対して、新たにチケットの関連付け(関係するチケット情報の作成)を行います。

要素:

• relation (必須): 次の関係するチケット情報の子要素を持ちます
  • issue_to_id (必須): 関係するチケットの ID
  • relation_type (必須): 関係のタイプ。以下の値をとります。
    • relates : "関係している"
    • duplicates : "重複している"
    • duplicated : "重複されている"
    • blocks : "ブロックしている"
    • blocked : "ブロックされている"
    • precedes : "先行する"
    • follows : "後続する"
  • delay (オプション): "precedes" または "follows" の場合の遅延する日数

レスポンス:

• 201 Created: 関係情報が作成されました(関連付けが行われました)
• 422 Unprocessable Entity: 妥当性の検証で失敗したため、関連付けは行われていません。(レスポンスにはエラーメッセージが格納されます)

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

GET¶

指定した ID の関係するチケット情報を取得します。

例:

GET /relations/1819.xml

レスポンス:

<?xml version="1.0" encoding="UTF-8"?>
<relation>
  <id>1819</id>
  <issue_id>8470</issue_id>
  <issue_to_id>8469</issue_to_id>
  <relation_type>relates</relation_type>
  <delay/>
</relation>

DELETE¶

指定した ID の関係するチケット情報を削除します。
すなわち、関連付けをはずします。

レスポンス:

• 200 OK: 関係するチケット情報は削除されました。
• 422 Unprocessable Entity: 情報の削除に失敗しました。(レスポンスにはエラーメッセージが格納されます)