クエリの書き方
固定リンクがコピーされました
cli-kintoneで条件を絞り込むためのクエリの書き方を説明します。
絞り込み条件
固定リンクがコピーされました
レコードの絞り込み条件は、--conditionオプションで指定します。
--conditionオプションで指定する条件は、"（ダブルクオート）で囲んでください。
演算子／関数は組み合わせて使用できます。
|
|
値に文字列や選択肢の項目を指定する場合、値を\"（エスケープしたダブルクオート）で囲みます。
|
|
演算子
| 演算子 | 例 | 説明 |
|---|---|---|
= |
--condition "文字列_0 = \"テスト\"" |
演算子の前に指定したフィールドコードの値と演算子の後に指定した値が一致する |
!= |
--condition "文字列_0 != \"テスト\"" |
演算子の前に指定したフィールドコードの値と演算子の後に指定した値が異なる |
> |
--condition "数値_0 > 10" |
演算子の前に指定したフィールドコードの値が、演算子の後に指定した値より大きい |
< |
--condition "数値_0 < 10" |
演算子の前に指定したフィールドコードの値が、演算子の後に指定した値より小さい |
>= |
--condition "数値_0 >= 10" |
演算子の前に指定したフィールドコードの値が、演算子の後に指定した値以上である |
<= |
--condition "数値_0 <= 10" |
演算子の前に指定したフィールドコードの値が、演算子の後に指定された値以下である |
in |
--condition "ドロップダウン_0 in (\"A\", \"B\")" |
演算子の前に指定したフィールドコードの値が、演算子の後の括弧内に列挙した文字列のいずれかと一致する |
not in |
--condition "ドロップダウン_0 not in (\"A\", \"B\")" |
演算子の前に指定したフィールドコードの値が、演算子の後の括弧内に列挙した文字列と一致しない |
like |
--condition "文字列_0 like \"テスト\"" |
演算子の前に指定したフィールドコードの値が、演算子の後に指定した値を含む 判定するフィールドの型が添付ファイルの場合、ファイル名とファイルの内容が判定の対象になります。 like演算子で使用できない記号は、次のページを参照してください。 検索キーワード入力時の注意事項 
|
not like |
--condition "文字列_0 not like \"テスト\"" |
演算子の前に指定したフィールドコードの値が、演算子の後に指定した値を含まない like演算子で使用できない記号は、次のページを参照してください。 検索キーワード入力時の注意事項
|
or |
--condition "数値_0 < 10 or 数値_0 > 20" |
上述の演算子を使用した2つの条件式の論理和 |
and |
--condition "数値_0 >= 10 and 数値_0 <= 20" |
上述の演算子を使用した2つの条件式の論理積 |
補足
- テーブル内のフィールド、および関連レコードのフィールドをクエリに含める場合、
=や!=演算子の代わりに、inやnot in演算子を使ってください。 - クエリで文字列検索する場合は単語検索です。
詳しくは、次のページを参照してください。
検索キーワード入力時の注意事項
関数
| 関数名 | 例 | 説明 |
|---|---|---|
LOGINUSER() |
--condition "作成者 in (LOGINUSER())" |
APIを実行したユーザー |
PRIMARY_ORGANIZATION() |
--condition "組織 in (PRIMARY_ORGANIZATION())" |
APIを実行したユーザーの優先する組織 APIを実行したユーザーに優先する組織が設定されていない場合、 組織 in (PRIMARY_ORGANIZATION())の条件は無視され、それ以外の絞り込み条件を満たすすべてのレコードが取得されます。 |
NOW() |
--condition "作成日時 = NOW()" |
APIを実行した日時 |
TODAY() |
--condition "作成日時 = TODAY()" |
APIを実行した日 |
YESTERDAY() |
--condition "作成日時 = YESTERDAY()" |
APIを実行した日の前日 |
TOMORROW() |
--condition "日時 = TOMORROW()" |
APIを実行した日の翌日 |
FROM_TODAY(数字, 期間の単位) |
--condition "作成日時 < FROM_TODAY(5, DAYS)" |
APIを実行した日から起算した期間 期間の単位に指定可能な文字列は次のとおりです。
|
THIS_WEEK(曜日) |
--condition "作成日時 = THIS_WEEK()" |
APIを実行した週 引数に次の値を指定することで、曜日を指定できます。
|
LAST_WEEK(曜日) |
--condition "作成日時 = LAST_WEEK()" |
APIを実行した週の前週 引数に THIS_WEEK()と同じ値を指定することで、曜日を指定できます。引数を指定しない場合は、前週のすべての日が対象です。 |
NEXT_WEEK(曜日) |
--condition "日時 = NEXT_WEEK()" |
APIを実行した週の翌週 引数に THIS_WEEK()と同じ値を指定することで、曜日を指定できます。引数を指定しない場合は、翌週のすべての日が対象です。 |
THIS_MONTH(数値またはフォーマット文字) |
--condition "作成日時 = THIS_MONTH()" |
APIを実行した月 引数に次の値を指定することで、日付を指定できます。
指定した日付が存在しない場合は、APIを実行した月の翌月1日で計算されます。 |
LAST_MONTH(数値またはフォーマット文字) |
--condition "作成日時 = LAST_MONTH()" |
APIを実行した月の前月 引数に次の値を指定することで、日付を指定できます。
指定した日付が存在しない場合は、APIを実行した月の翌月1日で計算されます。 |
NEXT_MONTH(数値またはフォーマット文字) |
--condition "日時 = NEXT_MONTH()" |
APIを実行した月の翌月 引数に次の値を指定することで、日付を指定できます。
指定した日付が存在しない場合は、APIを実行した月の翌々月1日で計算されます。 |
THIS_YEAR() |
--condition "作成日時 = THIS_YEAR()" |
APIを実行した年 |
LAST_YEAR() |
--condition "作成日時 = LAST_YEAR()" |
APIを実行した年の前年 |
NEXT_YEAR() |
--condition "日時 = NEXT_YEAR()" |
APIを実行した年の翌年 |
フィールド、システム識別子ごとの利用可能な演算子と関数一覧
詳しくは、次のページを参照してください。
kintone API共通｜クエリの書き方 フィールド、システム識別子ごとの利用可能な演算子と関数一覧
並び順
固定リンクがコピーされました
レコードの並び順は、--order-byオプションで指定します。
|
|
フィールドコードの後にascを指定すると昇順、descを指定すると降順で並び替えられます。
複数の項目で並び替える場合、「フィールドコード並び順」をカンマ区切りで指定してください。
|
|
--order-byで指定できるフィールドには制限があります。
詳しくは、次のページを参照してください。
ソートで選択できるフィールド
エスケープ処理
固定リンクがコピーされました
次のフィールドの値に、"（ダブルクオート）やバックスラッシュ\（バックスラッシュ）を含む場合、エスケープが必要です。
- 文字列（1行）
- 文字列（複数行）
- リッチエディター
- チェックボックス
- ラジオボタン
- ドロップダウン
- 複数選択
- ステータス
エスケープの例
チェックボックス（フィールドコード：Checkbox）について、"や\を含む値をエスケープする例です。
以下は「sample"1"」をエスケープする例です。
|
|
以下は「sample\2\」をエスケープする例です。
|
|
サンプルクエリ
固定リンクがコピーされました
クエリの記述例は、次のページを参照してください。
サンプルクエリ
ただし、--conditionに指定するクエリは"で囲み、値を囲んだ"をエスケープする必要があります。