Oracle Rules on REST and Query of Resources (Oracle Rest Standards)

Field Naming Standard Recommendations

• Field names must follow the general naming standard. Field names should start with a lower case letter.
• The primary identifier field should have "Id" name suffix (or just “Id” if desirable).
• A field that takes a Boolean value should have "Flag" as a suffix in the name.
• A field that indicates a user should use "By" as a suffix, such as lastUpdatedBy.

q Query Parameters

In the Oracle REST standard, the “q” query parameter is used by the client to specify the equivalent of the SQL “where clause” to search for resources in a collection. Oracle recommendation is to use SCIM’s filtering syntax, unless there is a need to support Mongo DB’s query format, or there are other requirements that SCIM doesn’t support. SCIM uses a plain text string to represent filtering. Here is a list of SCIM query parameters.

SCIM Query Parameters

Operator	Description	Behavior
eq	equal	The attribute and operator values must be identical for a match.
sw	starts with	The entire operator value must be a substring of the attribute value, starting at the beginning of the attribute value. This criterion is satisfied if the two strings are identical.
ew	ends with	The entire operator value must be a substring of the attribute value, matching at the end of the attribute value. This criterion is satisfied if the two strings are identical.
gt	greater than	If the attribute value is greater than operator value, there is a match. The actual comparison is dependent on the attribute type. For string attribute types, this is a lexicographical comparison and for DateTime types, it is a chronological comparison. For Integer attributes it is a comparison by numeric value. Boolean and Binary attributes shall cause a failed response (HTTPS).