Changes between Version 18 and Version 19 of S3/S3REST/URLFormat

Timestamp:

08/15/11 10:52:09 (14 years ago)

Author:

Dominic König

Comment:

--

S3/S3REST/URLFormat

@@ -34 +34 @@
 == Basic Query Format ==
 
-The basic query format is: '''resource'''.'''field'''{'''operator'''}='''value'''
+The basic query format is: '''resource'''.{'''foreign key'''$}'''field'''{'''operator'''}='''value(s)'''
 
-  * '''resource''' is the name of the resource or component (without prefix) or the name of the context
-  * '''field''' is the name of the field to be tested
+  * '''resource''' is the name of the resource or component (without prefix)
+  * '''foreign key''' is the name of the foreign key field
+  * '''field''' is the name of the field in the target table
   * '''operator''' is the operator
-  * '''value''' is the value or a comma-separated list of values to test against (a comma will be treated as OR)
+  * '''value(s)''' is the value or a comma-separated list of values to test against (a comma will be treated as OR)
 
 Supported operators:
@@ -55 +56 @@
   ||!__ex||negative containment, not contains(value)||list types only||
 
+
 == Field Queries ==
 
-  * Testing a field in the main resource
+Field names in URL queries must be prefixed by the resource alias, followed by a "." dot, like:
+
+Master resource:
+
 {{{
 /pr/person?person.first_name__like=Miriam
 }}}
 
-== Component Field Queries ==
+Master resources use their table name without controller prefix as alias, whereas components can have a context-dependent alias (which must be used here).
 
-  * Testing a field in a component resource
+Component:
+
 {{{
 /pr/person?address.city__like=Oslo
 }}}
 
-== Context Queries ==
+Note that any component of the master resource can be queried, even if it is not addressed by the URL.
 
-  * Testing a field in a referenced resource
-  * Context must be specified like '''''context''.'''name'''={'''component'''.}'''field'''
-    * '''name''' is a name for the context (as reference for subsequent queries)
-    * '''component''' is the name of the component resource (without prefix)
-    * '''field''' is the field name of the foreign key field
+To query a field in a referenced record, append the foreign key field name followed by a "$" sign to the resource name prefix.
 
 {{{
-/pr/person?context.location=address.location_id&location.lat__gt=0
+/pr/person?person.location_id$lat__lt=55.0
 }}}
+
+This required that the respective foreign key field is defined as "reference" or "list:reference" type.
 
 == Boundary Box Queries ==