LoginSignup
8

More than 5 years have passed since last update.

Redmine Rest API (Search API)の使い方

Posted at

Redmine Rest APIのsearch APIの使い方

公式Wikiがまだドキュメント化されていないので、まとめておくことにしました。
公式Wiki URL: http://www.redmine.org/projects/redmine/wiki/Rest_Search

HTTPメソッド

GET /search

説明

RedmineのチケットやWiki、更新履歴などから検索語句を検索し、結果を取得する。

パラメータ

名前 説明 指定値 省略(省略値)
q 検索語句 String 可('') q=query_string
all_words 検索対象:全ての単語かどうか(1:全ての単語) 0 or 1 可(0) all_words=1
titles_only 検索対象:タイトルのみかどうか(1:タイトルのみ) 0 or 1 可(0) titles_only=1
attachments 検索対象:添付ファイルを含むかどうか(1:含む) 0 or 1 可(0) attachments=1
options 検索対象: 0 or 1 可(0) options=1
open_issues 検索対象:未終了チケットのみか(1:未終了チケットのみ) 0 or 1 可(0) open_issues=1
scope 検索対象の範囲 'all' or 'my_projects' or 'subprojects' or '' 可('') scope=

パラメータ指定例

search?q=test&all_words=1&titles_only=1&attachments=1&options=1&open_issues=1&scope=

レスポンス

200

{
  "results":
    "total_count": integer,
    "offset": integer,
    "limit": integer,
    "type" :,
    "result": 
      [
        {
          "id" : integer
          "title" : String
          "type" : String
          "url" : String
          "description" : String
          "datetime" : String
        },
      ]
}

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
8