Adding some docs about FIQL

Project: http://git-wip-us.apache.org/repos/asf/syncope/repo
Commit: http://git-wip-us.apache.org/repos/asf/syncope/commit/711d0c02
Tree: http://git-wip-us.apache.org/repos/asf/syncope/tree/711d0c02
Diff: http://git-wip-us.apache.org/repos/asf/syncope/diff/711d0c02

Branch: refs/heads/master
Commit: 711d0c02c8f37a330325d8815e7f8b18e9599ff8
Parents: 9ff420c
Author: Francesco Chicchiriccò <ilgro...@apache.org>
Authored: Mon Feb 19 17:52:29 2018 +0100
Committer: Francesco Chicchiriccò <ilgro...@apache.org>
Committed: Mon Feb 19 17:52:39 2018 +0100

----------------------------------------------------------------------
 .../restfulservices.adoc                        | 67 +++++++++++++++++++-
 1 file changed, 66 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/syncope/blob/711d0c02/src/main/asciidoc/reference-guide/workingwithapachesyncope/restfulservices.adoc
----------------------------------------------------------------------
diff --git 
a/src/main/asciidoc/reference-guide/workingwithapachesyncope/restfulservices.adoc
 
b/src/main/asciidoc/reference-guide/workingwithapachesyncope/restfulservices.adoc
index 900789b..0d817e8 100644
--- 
a/src/main/asciidoc/reference-guide/workingwithapachesyncope/restfulservices.adoc
+++ 
b/src/main/asciidoc/reference-guide/workingwithapachesyncope/restfulservices.adoc
@@ -233,6 +233,71 @@ without performing any deprovisioning operation
  * `UNASSIGN` - unlink and deprovision several users, groups or any objects at 
once from an external resource
 |===
 
+==== Search
+
+It is possible to search for Users, Groups and Any Objects matching a set of 
given conditions expressed through
+https://cxf.apache.org/docs/jax-rs-search.html#JAX-RSSearch-FeedItemQueryLanguage[FIQL^].
+
+The https://tools.ietf.org/html/draft-nottingham-atompub-fiql-00[Feed Item 
Query Language^] (FIQL, pronounced “fickle”)
+is a simple but flexible, URI-friendly syntax for expressing filters across 
the entries in a syndicated feed.
+
+The FIQL queries can be passed to the search endpoints available, e.g.
+
+* `GET /users?fiql=query`
+* `GET /groups?fiql=query`
+* `GET /anyObjects?fiql=query`
+
+where `query` is an URL-encoded string representation of the given FIQL query, 
as in the following examples.
+
+.Simple attribute match
+====
+----
+username==rossini
+----
+====
+
+.Wildcard attribute match
+====
+----
+username==*ini
+----
+====
+
+.Null attribute match
+====
+----
+loginDate==$null
+----
+====
+
+.Resource assignment match
+====
+----
+$resources==resource-ldap
+----
+====
+
+.Group membership match (only for Users and Any Objects)
+====
+----
+$groups==root
+----
+====
+
+.Role membership match (only for Users)
+====
+----
+$roles==Other
+----
+====
+
+.Type match (only for Any Objects)
+====
+----
+$type==PRINTER
+----
+====
+
 ==== Client Library
 
 The Java client library simplifies the interaction with the <<core>> by hiding 
the underlying HTTP
@@ -340,7 +405,7 @@ Advanced REST features are also available from 
`SyncopeClient` instances: check
 
http://syncope.apache.org/apidocs/2.0/org/apache/syncope/client/lib/SyncopeClient.html[the
 javadoc^]
 for more information.
 
-.Search for users, groups or any objects
+.Search for Users, Groups or Any Objects
 ====
 All search operations return
 
http://syncope.apache.org/apidocs/2.0/org/apache/syncope/common/lib/to/PagedResult.html[paged
 result handlers^]

Reply via email to