Realtime Cloud Storage

queryItems

Retrieves a set of items from a table filtering by primary key and by default sorting by secondary key.

A filter by secondary key can also be used but it will only be applied to the items with the given primary key.

Sample

curl 'https://storage-backend-prd-useast1.realtime.co/queryItems' -H 'Content-Type: application/json; charset=UTF-8' -d '{ "applicationKey":"[YOUR_APP_KEY]", "authenticationToken":"[YOUR_TOKEN]", "table":"SampleUser", "key": { "primary": "developer" } }'

Parameters

String applicationKey

Public key of the application's license.

String privateKey optional

Private key of the application's license. For administration use only.

String authenticationToken

Identification of the user using the application.

String table

The name of the table.

DataKey key

Value of the primary key.

String[] properties optional

Attributes that compose the item. If not present it will retrieve them all.

QueryFilter filter optional

Evaluates the results and returns only the desired values. The filter is used to compare against the existing values of the secondary key.

DataKey startKey optional

The primary key of the item from which to continue an earlier operation. This value is returned in the stopKey if that operation was interrupted before completion; either because of the result set size or because of the setting for limit.

Number limit optional

The maximum number of items to evaluate (not necessarily the number of matching items).

Boolean searchForward optional

The items are retrieved in descending('false') or ascending ('true') order according to their secondary key. Default is 'true'.

QueryItemsResponse callback

Function called when the operation completes.

Response

QueryItemsResponse(data, error)

Response of the queryItems operation.

Object data

Error error

The attribute that holds the results of the operation if an error occurred.