X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/0248222743f73e853cf428ddaa49a89113f519d1..f7f5dfb456c1ddb6db63cf6e6a79e5d468d20a20:/doc/api/methods.html.textile.liquid diff --git a/doc/api/methods.html.textile.liquid b/doc/api/methods.html.textile.liquid index 0e01b3c6dd..872a1bca71 100644 --- a/doc/api/methods.html.textile.liquid +++ b/doc/api/methods.html.textile.liquid @@ -96,7 +96,7 @@ table(table table-bordered table-condensed). |1|operator|string|Comparison operator|@>@, @>=@, @like@, @not in@| |2|operand|string, array, or null|Value to compare with the resource attribute|@"d00220fb%"@, @"1234"@, @["foo","bar"]@, @nil@| -The following operators are available. +The following operators are available.[1] table(table table-bordered table-condensed). |_. Operator|_. Operand type|_. Description|_. Example| @@ -107,6 +107,7 @@ table(table table-bordered table-condensed). |@is_a@|string|Arvados object type|@["head_uuid","is_a","arvados#collection"]@| |@exists@|string|Test if a subproperty is present.|@["properties","exists","my_subproperty"]@| +Note: h4(#substringsearchfilter). Filtering using substring search @@ -129,6 +130,7 @@ table(table table-bordered table-condensed). |@like@, @ilike@|string|SQL pattern match, single character match is @_@ and wildcard is @%@, ilike is case-insensitive|@["properties.my_subproperty", "like", "d00220fb%"]@| |@in@, @not in@|array of strings|Set membership|@["properties.my_subproperty", "in", ["fizz", "buzz"]]@| |@exists@|boolean|Test if a subproperty is present or not (determined by operand).|@["properties.my_subproperty", "exists", true]@| +|@contains@|string, number|Filter where subproperty has a value either by exact match or value is element of subproperty list.|@["foo", "contains", "bar"]@ will find both @{"foo": "bar"}@ and @{"foo": ["bar", "baz"]}@.| Note that exclusion filters @!=@ and @not in@ will return records for which the property is not defined at all. To restrict filtering to records on which the subproperty is defined, combine with an @exists@ filter. @@ -140,7 +142,6 @@ To query multiple clusters, the list request must: * Have filters only matching @[["uuid", "in", [...]]@ or @["uuid", "=", "..."]@ * Specify @count=none@ -* If @select@ is specified, it must include @uuid@ * Not specify @limit@, @offset@ or @order@ * Not request more items than the maximum response size @@ -168,3 +169,5 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location | {background:#ccffcc}.|uuid|string|The UUID of the resource in question.|path|| |{resource_type}|object||query|| + +fn1^. NOTE: The filter operator for full-text search (@@) which previously worked (but was undocumented) is deprecated and will be removed in a future release.