專案

一般

設定檔

動作

搜尋

/search.:format

GET

依指定的條件參數回傳搜尋結果。

參數:

  • offset:在回應中跳過此數量的結果(可選)
  • limit:回應中的結果數量(可選)
  • q:查詢字串。允許使用空格「 」分隔的多個值。

可選篩選器

  • scope:搜尋範圍條件
    • 「all」:搜尋所有專案
    • 「my_project」:搜尋指派的專案
    • 「subprojects」:當指定專案時包含子專案
  • all_words:是否匹配所有查詢字串
  • titles_only:是否僅匹配標題
  • issues:是否包含議題
  • news:是否包含新聞
  • documents:是否包含文件
  • changesets:是否包含變更集
  • wiki_pages:是否包含 Wiki 頁面
  • messages:是否包含訊息
  • projects:是否包含專案
  • open_issues:依開啟的議題篩選。
  • attachments:依描述和附件篩選
    • 「0」:僅在描述中搜尋
    • 「1」:依描述和附件搜尋
    • 「only」:僅在附件中搜尋

範例:

GET /search.xml?q=query_string

Paging example:
GET /search.xml?q=query_string&offset=0&limit=100

Filtering issues and wikis example:
GET /search.xml?q=issue_keyword wiki_keyword&issues=1&wiki_pages=1

回應:

<results total_count="2" offset="0" limit="25" type="array">
  <result>
    <id>5</id>
    <title>Wiki: Wiki_Page_Name</title>
    <type>wiki-page</type>
    <url>
    https://redmine.dev.org.tw/projects/new_crm_dev/wiki/Wiki_Page_Name
    </url>
    <description>h1. Wiki Page Name wiki_keyword</description>
    <datetime>2016-03-25T05:23:35Z</datetime>
  </result>
  <result>
    <id>10</id>
    <title>Issue #10 (Closed): Issue_Title</title>
    <type>issue closed</type>
    <url>http://www.redmin.org/issues/10</url>
    <description>issue_keyword</description>
    <datetime>2016-03-24T05:18:59Z</datetime>
  </result>
</results>

Takenori TAKAKI大約 3 年前 更新 · 2 個版本