r-labs

redmine.org の "Rest_api_with_curl":http://www.redmine.org/projects/redmine/wiki/Rest_api_with_curl の日本語訳です。

h1. cURL での REST API の使用法

"cURL":http://curl.haxx.se/ はいろんなプロトコルに対応したデータ通信用のコマンドラインツールです。 これを Redmine REST API でのやりとりに使うことが出来ます。

+JSON を使用+

以下の例はチケットを更新するコマンドの簡単な使用例です。

<pre>

curl -v -H "Content-Type: application/json" -X PUT --data "@388.json" -u login:password http://redmine/issues/388.json

</pre>

Redmine に送る @388.json@ ファイルの内容は次のようになっています。

<pre><code class="json">

{

  "issue": {

    "subject": "subject123",

    "notes": "Changing the subject"

  }

}

</code></pre>

*注意*: 送信するデータのフォーマットにあわせて、 @Content-Type@ ヘッダー を設定する必要があります。

次の値のうちのどちらかを必ず指定して下さい。

* @application/json@

* @application/xml@

+XML を使用+

次の例ではカスタムフィールドを持ったチケットを作成しています。

<pre>

curl -v -H "Content-Type: application/xml" -X POST --data "@issue.xml" -u login:password http://redmine/issues.xml

</pre>

@issue.xml@ の中身は以下のものです。

<pre><code class="xml">

<?xml version="1.0" encoding="ISO-8859-1" ?>

<issue>

  <subject>API custom fields</subject>

  <project_id>1</project_id>

  <tracker_id>2</tracker_id>

  <custom_fields type="array">

    <custom_field>

      <id>2</id>

      <value>Fixed</value>

    </custom_field>

    <custom_field>

      <id>1</id>

      <value>0.8.2</value>

    </custom_field>

  </custom_fields>

</issue>

</code></pre>