API の一覧

ノートの検索

検索 Markdown で表示

GET/api/search/note

条件に合うノートを、参加しているプロジェクトの中から検索します。

パラメーター

projectId"@all" | integerquery必須
プロジェクト ID。@all を渡すと、参加中の終了していないプロジェクトすべてが対象になります。
qstringquery
ノートのタイトルと本文から探すキーワード (200 文字まで)。スペースで区切ると、すべてに一致するノートだけが対象です。
tagIdsstringquery
カンマ区切りのタグ ID (100 件まで)。none を渡すとタグのないノートに一致します。
tagModeand | excludequery
tagIds の使い方。and はそのタグのいずれかが付いたノート、exclude は付いていないノートを返します。省略すると and です。
includeWip0 | 1 | true | falsequery
作業中 (WIP) のノートを含めるかどうか (true、false、1、0)。省略すると true です。
resultids | itemsquery
レスポンスの形。ids は一致したノートの ID、items はノートの概要を 1 ページ 30 件で返します。省略すると ids です。
pageintegerquery
ページ番号 (1 から)。result が items のときだけ使われます。

レスポンス

  • 200Matching notes ({ noteIds, truncated } or { items, hasMore })
  • 400Invalid query
  • 401Authentication is required

Repsonaはクッキーを使ってサービスを提供しています。当社のウェブサイトにアクセスすることにより、Cookieポリシー に記載されているCookieの使用に同意するものとします。