API v3では、フィルターを使用して特定の結果を取得するオプションがあります。

チケット一覧を取得するための GET /tickets API のフィルターには特に制限があります。詳細および利用可能なすべてのオプションについては、こちらの記事をご参照ください。

シンプルフィルター

シンプルフィルターを使用すると、特定のカラムを指定した値で完全一致検索して結果を絞り込むことができます:

{"parameter":"value"}

このシンプルフィルターを使用すると、例えば「新規」ステータスのチケットを取得できます:

_filters:{"status":"N"}

また、条件をカンマで区切ることで複数の条件を組み合わせることもできます。例えば、特定のIDを持つ会社の男性連絡先をすべて検索する場合:

_filters={"gender":"M","company_id":"123abc"}

シンプルフィルターでは、パラメーターに対して特定の値のみを検索でき、演算子の定義や日付範囲の指定はできません。演算子の定義や日付範囲での検索には、アドバンスフィルターを使用してください。

アドバンスフィルター

アドバンス検索のフィルター形式では、シンプルフィルターの2つに対して3つの値が必要です:

[["parameter","operator","value"]]

ご覧のとおり、演算子が使用されています。アドバンスフィルターを使用すると、例えば今週作成されたチケットや削除されていないすべてのチケットを検索できます:

_filters=[["date_created","DP","TW"]]
_filters=[["status","NI","X,B"]]

また、複数の条件を1つのフィルターに組み合わせることもできます。例えば、先月作成された保留中のチケットをすべて検索する場合:

_filters=[["status","E","W"],["date_created","DP","LM"]]

アドバンス検索で使用する演算子

すべてのアドバンスフィルターで以下の演算子を使用できます:

論理演算子
演算子 説明 使用例
L Like(部分一致) [[“tags”,“L”,“3bg4”]]
NL Not like(部分不一致) [[“field_player_id”,“NL”,“007”]]
E Equals(等しい) [[“status”,“E”,“N”]]
NE Not equals(等しくない) [[“field_player_id”,“NE”,“007”]]
CY Contains any of(いずれかを含む) [[“tags”,“CY”,“3bg4,9aue”]]
IN Is in(含まれる) [[“departmentid”,“IN”,“8ld2hdk5,klt0srua”]]
NI Not in(含まれない) [[“departmentid”,“NI”,“default,8ld2hdk5”]]
IE Is empty(空である) [[“company_id”,“IE”,""]]
INE Is not empty(空でない) [[“company_id”,“INE”,""]]
数値演算子
演算子 説明 使用例
= 数値が等しい [[“id”,"=",“209”]]
> 数値が大きい [[“id”,">",“200”]]
< 数値が小さい [[“id”,"<",“51”]]
>= 数値が等しいか大きい [[“id”,">=",“78”]]
<= 数値が等しいか小さい [[“id”,"<=",“3”]]
日付・時刻演算子
演算子 説明 使用例
D= 日付が等しい [[“date_created”,“D=”,“2011-11-11”]]
D> 日付が大きい [[“date_changed”,“D>”,“2023-01-01 13:00:00”]]
D< 日付が小さい [[“date_created”,“D>”,“2022-12-31”]]
D>= 日付が等しいか大きい [[“last_activity”,“D>=”,“2023-12-24 7:00:00”]]
D<= 日付が等しいか小さい [[“date_resolved”,“D<=”,“2022-11-30”]]
T= 時刻が等しい
T> 時刻が大きい
T< 時刻が小さい
T>= 時刻が等しいか大きい
T<= 時刻が等しいか小さい
DP 日付範囲 [[“date_created”,“DP”,“TW”]]
日付・時刻演算子の値
説明 使用例
T 今日 [[“date_created”,“DP”,“T”]]
Y 昨日 [[“date_created”,“DP”,“Y”]]
L7D 過去7日間 [[“date_created”,“DP”,“L7D”]]
L30D 過去30日間 [[“date_created”,“DP”,“L30D”]]
L90D 過去90日間 [[“date_created”,“DP”,“L90D”]]
TW 今週 [[“date_created”,“DP”,“TW”]]
LW 先週 [[“date_created”,“DP”,“LW”]]
L2W 過去2週間 [[“date_created”,“DP”,“L2W”]]
LWW 先週の平日 [[“date_created”,“DP”,“LWW”]]
TM 今月 [[“date_created”,“DP”,“TM”]]
LM 先月 [[“date_created”,“DP”,“LM”]]
TY 今年 [[“date_created”,“DP”,“TY”]]
LY 昨年 [[“date_created”,“DP”,“LY”]]