Find Items

Get a list of items based on a filter.

Syntax

function FindItems(skip: integer, filter: _com_wixpress_cloud_externaldb_api_Filter, collectionName: string, requestContext: _com_wixpress_cloud_externaldb_api_RequestContext, sort: array<_com_wixpress_cloud_externaldb_api_OrderSpec>, limit: integer): Find<_com_wixpress_cloud_externaldb_api_FindResponse>

Find Items Parameters

NAME

TYPE

DESCRIPTION

skip

integer

The number of items to skip from the first item.

filter

_com_wixpress_cloud_externaldb_api_Filter

A query filter.

collectionName

string

The collection or table to be queried.

requestContext

_com_wixpress_cloud_externaldb_api_RequestContext

The request context object.

sort

Array<_com_wixpress_cloud_externaldb_api_OrderSpec>

Sort order.

limit

integer

The maximum number of items to retrieve.

Returns

Return Type:

_com_wixpress_cloud_externaldb_api_FindResponse

NAME

TYPE

DESCRIPTION

items

Array<struct>

A list of objects containing the retrieved items.

totalCount

integer

The total number of items matching the query filter.

Was this helpful?

Get data matching a filter from a collection.

Request

curl

Copy Code

1curl -X POST 'https://mysql-adapter.com/data/find'  \
2--header 'Content-Type: application/json'  \
3--data-raw '{
4    "requestContext": {
5        "settings": {
6            "secretKey": "mySecureSecret"
7        },
8        "instanceId": "12a345b6-7890-98d7-65e4-f321abc1de23",
9        "installationId": "987fe654-3d21-4def-ab5c-6d78e90f123a",
10        "memberId": "77aa88bb-2c2c-d3d3-4e4e-ff55aa66bb77",
11        "role": "OWNER"
12    },
13   "collectionName": "car",
14    "filter": {
15        "operator": "$and",
16        "value": [
17            {
18                "operator": "$contains",
19                "fieldName": "make",
20                "value": "a"
21            },
22            {
23                "operator": "$gt",
24                "fieldName": "year",
25                "value": 2018
26            }
27        ]
28    },
29    "sort": [
30        {
31            "fieldName": "year",
32            "direction": "asc"
33        }
34    ],
35    "skip": 0,
36    "limit": 10000
37}'

Response

json

1
2{
3  "items":   [
4        {
5      "_id": "95953ca3-5fe5-4ce7-9cca-9bcc1ba64ba6",
6      "_owner": "77aa88bb-2c2c-d3d3-4e4e-ff55aa66bb77",
7      "make": "Toyota",
8      "model": "Corolla",
9      "year": 2019,
10      "date_added": {"$date": "2020-09-30T21:30:00.000Z"}
11    },
12        {
13      "_id": "20cd8f8d-1a0f-4530-91df-6d31fe9e83a5",
14      "_owner": "77aa88bb-2c2c-d3d3-4e4e-ff55aa66bb77",
15      "make": "Ferrari",
16      "model": "812GTS",
17      "year": 2020,
18      "date_added": {"$date": "2020-03-31T21:00:00.000Z"}
19    }
20  ],
21  "totalCount": 2
22}