篩選器語法

本頁說明篩選帳戶時必須使用的語法。

語法

整數以外的所有值都必須以雙引號 () 括住。目的地： 如要瞭解特定欄位可接受哪些值，請參閱參考 說明文件。

您可以使用 AND 篩選同一項查詢中的多個欄位。你也可以 使用 AND 合併多個 relationship(...) 和 service(...) 篩選器。 以下範例結合多個 relationship(...) 和 service(...) 篩選器：

(relationship(service(type = "ACCOUNT_MANAGEMENT") AND service(handshakeState = "PENDING"))) OR (accountName = "store" AND relationship(...))

這個範例會傳回下列帳戶：

• 所有具備帳戶管理關係的帳戶都與其他帳戶相關聯， 以及尚待接受的其他關係

• 所有顯示名稱皆為「"store"」的帳戶，與其他帳戶有關係。

您無法使用 AND 篩選相同欄位中的多個值。適用對象 例如，您無法使用 accountName = "*A*" AND accountName = "*B*"。

您可以使用 OR 篩選同一項查詢中的兩個欄位。納入篩選器 OR 運算子的每一側都以括號表示。例如：(accountName = "storeA") OR (accountName = "storeB")

您只能使用 OR 合併兩個欄位。例如，您無法使用 (accountName = "storeA") OR (accountName = "storeB") OR (accountName = "storeC")。

AND 和 OR 運算子除外，以及 函式叫用，例如 relationship(...) 和 service(...)。

針對 accountName 和 accountIdAlias 等字串欄位，您可以篩選以下項目： 值，方法是以 連續星號 (*)。舉例來說，accountName = "*foo*" 會傳回全部 具有 accountName 的帳戶，包含 foo，例如「storeFoo」。

你可以使用 != 篩選不含特定序列的值 和 *。舉例來說，accountName != "*foo*" 會傳回所有含有 不含 foo 的 accountName。

系統會忽略多餘的空格。例如，foo AND bar 與 foo AND bar 相同。

規格

篩選器遵循 AIP 篩選器中的子集 及其正式的 EBNF 文法：

filter
    : accountFilterDisj
    | accountFilterConj
    ;
accountFilterDisj
    : "(" accountFilterConj " OR " accountFilterConj ")"
    ;
accountFilterConj
    : accountFilter {" AND " accountFilter}
    ;
accountFilter
    : displayNameFilter | relationshipFn
    ;
displayNameFilter
    : "displayName" comparator value
    ;
relationshipFn
    : "relationship(" relationshipConj ")"
    ;
relationshipConj
    : relationshipFilter {" AND " relationshipFilter}
    ;
relationshipFilter
    : "providerId = " numValue
    | "callerHasAccessToProviderFilter()"
    | "externalAccountId" comparator value
    | "accountIdAlias" comparator value
    | serviceFn
    ;
serviceFn
    : "service(" serviceConj ")"
    ;
serviceConj
    : serviceFilter {" AND " serviceFilter}
    ;
serviceFilter
    : handshakeStateFilter
    | typeFilter
    ;
handshakeStateFilter
    : "handshakeState = " value
    ;
typeFilter
    : "type = " value
    ;
comparator
    : " = " | " != "
    ;