Query attributes for filter, sort and agregate results

[purrplingcat]

Query attributes for filter and agregate results

At REST server side is applied this "magic" query parameters for filter, agregate and sort results.

Category/Type	Single Entity {}	Native Array []	PCO
Category A	✕	✓	✓
Category B	✕	✕	✓

Category A: Params valid for array/PCO

These parameters are valid for all requests on the collection (array, PCO)

• filter[] - Query array param for filtering results by fields in requested entity. Example: ?filter[login]=admin&filter[email]=admin@localhost
• limit - Limit a count of results in array. For PCO this param limiting records per page.
• fulltext - String for fulltext search valid accross all fields in requested entity
• desc - Boolean. Type of sorting will be DESC.Default value is 0/false. (Default sorting is ASC)
• sortby - String for name of field for sorting by.

Category B: PCO only params

Additional params accesible only in PCO:

• page - Number of requested page

All PCO query params is specified in #16

Example

Fetch all devices, where: field city is Prague, sorted DESC by field title. Limit of records is 10.

/devices?filter[city]=Prague&sortby=title&desc=1&limit=10

Returned data payload (array). Payload can be a part of PCO as attribute data. Example shows only 1 sample.

[
  {
    "name": "XvCfbN0e2c4g",
    "title": "My awesome thermometer",
    "owner": "c54fa45dcc00214a1"
  }
]

---

Related: #16 Following: #2 Source: