1. フィルター コレクション リソース

フィルター リソース

フィルター リソースは、フィルターに関連する情報を保持する jsonオブジェクトです。 これはファセット値リソースと非常に似ていますが、次のように、いくつかの点が調整されています。

名前型説明
propertiesオブジェクトプロパティと値を含むディクショナリ オブジェクト。
remove検索リンクこのフィルターを削除した検索を表すリソースへのハイパーリンク。 注: それぞれのフィルターに依存する他のフィルターが存在する場合は、このリンクをクリックすると、これらのフィルターも削除されます。
Entityリンクこのフィルター値の背後にあるエンティティを表すリソースへのハイパーリンク (存在する場合)

範囲を指定しないフィルター リソースの例

{
    "properties": {
        "title": "display text/value for the filter value",
        "matches": 96,
        "identifier": "filter value identifier - could be Redis entity id or Redis definition name or solr field name",
        "operator": "filter operator",
        "positive": true if the filter is positive, false if it's negative,
        "type": "type of the solr field on which this filter is applied",
        "ranged": false
    },
    "remove": {
        "query": "myQueryWithThisFilterAndAllTheDependentFiltersRemoved",
        "href": "http://hostname/api/search?q=myQueryWithThisFilterAndAllTheDependentFiltersRemoved&skip=10&take=10"
    },
    "Entity": {
        "href": "http://hostname/api/entities/entityId"
    }
}

範囲を指定したフィルター リソースの例

{
    "properties": {
        "title1": "display text/value for the lower filter value",
        "identifier1": "identifier for the lower filter value",
        "title2": "display text/value for the higher filter value",
        "identifier2": "identifier for the higher filter value",
        "operator": "Between",
        "positive": true if the filter is positive, false if it's negative,
        "type": "type of the solr field on which this filter is applied",
        "ranged": true
    },
    "remove": {
        "query": "myQueryWithThisFilterAndAllTheDependentFiltersRemoved",
        "href": "http://hostname/api/search?q=myQueryWithThisFilterAndAllTheDependentFiltersRemoved&skip=10&take=10"
    },
    "Entity": null
}

フィルター演算子

フィルター演算子は、必要な操作を識別するために使用される、次のような値のセットです。

演算子説明
等しい値が完全に等しいことを示します。ただし、全文検索用のフィルターに使用する場合は、"Contains" 演算子を使用します。 この演算子は、範囲を指定しないフィルターで使用されます。
Containsフィルター値がフィールド値に含まれることを意味します。 これはテキスト フィルターに使用されます (範囲を指定しないフィルターのみ)。
StartWithフィールド値がフィルター値で始まることを意味します。 これはテキスト フィールドに使用されます (範囲を指定しないフィルターのみ)。
EndsWithフィールド値がフィルター値で終わることを意味します。 これはテキスト フィールドに使用されます (範囲を指定しないフィルターのみ)。
LessThanフィルター値がフィールド値未満であることを意味します。 これは日付フィールドおよび数値フィールドに使用されます (範囲を指定しないフィルターのみ)。
GreaterThanフィルター値がフィールド値より大きいことを意味します。 これは日付フィールドおよび数値フィールドに使用されます (範囲を指定しないフィルターのみ)。
Betweenフィールド値が 2 つのフィルター値の間にあることを意味します。 これは日付フィールドおよび数値フィールドに使用されます (範囲を指定するフィルターのみ)。
この記事を改善するための提案がある場合は、 お知らせください!