List Available Schemas

Get a list of all schema objects.

Syntax

function ListAvailable Schemas(requestContext: _com_wixpress_cloud_externaldb_api_RequestContext): ListSchemas<_com_wixpress_cloud_externaldb_api_ListSchemasResponse>

List Available Schemas Parameters

NAME

TYPE

DESCRIPTION

requestContext

_com_wixpress_cloud_externaldb_api_RequestContext

The request context object.

Returns

Return Type:

_com_wixpress_cloud_externaldb_api_ListSchemasResponse

NAME

TYPE

DESCRIPTION

schemas

Array<_com_wixpress_cloud_externaldb_api_Schema>

A list of schema objects.

Was this helpful?

Get a list of all available schemas.

Request

curl

Copy Code

1curl -X POST 'https://mysql-adapter.com/schemas/list' \
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}'

Response

json

1
2{"schemas": [
3    {
4    "displayName": "car",
5    "id": "car",
6    "allowedOperations":     [
7      "get",
8      "find",
9      "count",
10      "update",
11      "insert",
12      "remove"
13    ],
14    "maxPageSize": 50,
15    "ttl": 3600,
16    "fields":     {
17      "_id":       {
18        "displayName": "_id",
19        "type": "text",
20        "queryOperators":         [
21          "eq",
22          "lt",
23          "gt",
24          "hasSome",
25          "and",
26          "lte",
27          "gte",
28          "or",
29          "not",
30          "ne",
31          "startsWith",
32          "endsWith"
33        ]
34      },
35      "_owner":       {
36        "displayName": "_owner",
37        "type": "text",
38        "queryOperators":         [
39          "eq",
40          "lt",
41          "gt",
42          "hasSome",
43          "and",
44          "lte",
45          "gte",
46          "or",
47          "not",
48          "ne",
49          "startsWith",
50          "endsWith"
51        ]
52      },
53      "make":       {
54        "displayName": "make",
55        "type": "text",
56        "queryOperators":         [
57          "eq",
58          "lt",
59          "gt",
60          "hasSome",
61          "and",
62          "lte",
63          "gte",
64          "or",
65          "not",
66          "ne",
67          "startsWith",
68          "endsWith"
69        ]
70      },
71      "model":       {
72        "displayName": "model",
73        "type": "text",
74        "queryOperators":         [
75          "eq",
76          "lt",
77          "gt",
78          "hasSome",
79          "and",
80          "lte",
81          "gte",
82          "or",
83          "not",
84          "ne",
85          "startsWith",
86          "endsWith"
87        ]
88      },
89      "year":       {
90        "displayName": "year",
91        "type": "number",
92        "queryOperators":         [
93          "eq",
94          "lt",
95          "gt",
96          "hasSome",
97          "and",
98          "lte",
99          "gte",
100          "or",
101          "not",
102          "ne",
103          "startsWith",
104          "endsWith"
105        ]
106      },
107      "date_added":       {
108        "displayName": "date_added",
109        "type": "datetime",
110        "queryOperators":         [
111          "eq",
112          "lt",
113          "gt",
114          "hasSome",
115          "and",
116          "lte",
117          "gte",
118          "or",
119          "not",
120          "ne",
121          "startsWith",
122          "endsWith"
123        ]
124      }
125    }
126  },
127    {
128    "displayName": "manufacturer",
129    "id": "manufacturer",
130    "allowedOperations":     [
131      "get",
132      "find",
133      "count",
134      "update",
135      "insert",
136      "remove"
137    ],
138    "maxPageSize": 50,
139    "ttl": 3600,
140    "fields":     {
141      "name":       {
142        "displayName": "name",
143        "type": "text",
144        "queryOperators":         [
145          "eq",
146          "lt",
147          "gt",
148          "hasSome",
149          "and",
150          "lte",
151          "gte",
152          "or",
153          "not",
154          "ne",
155          "startsWith",
156          "endsWith"
157        ]
158      },
159      "country":       {
160        "displayName": "country",
161        "type": "text",
162        "queryOperators":         [
163          "eq",
164          "lt",
165          "gt",
166          "hasSome",
167          "and",
168          "lte",
169          "gte",
170          "or",
171          "not",
172          "ne",
173          "startsWith",
174          "endsWith"
175        ]
176      },
177      "established":       {
178        "displayName": "established",
179        "type": "datetime",
180        "queryOperators":         [
181          "eq",
182          "lt",
183          "gt",
184          "hasSome",
185          "and",
186          "lte",
187          "gte",
188          "or",
189          "not",
190          "ne",
191          "startsWith",
192          "endsWith"
193        ]
194      },
195      "_id":       {
196        "displayName": "_id",
197        "type": "text",
198        "queryOperators":         [
199          "eq",
200          "lt",
201          "gt",
202          "hasSome",
203          "and",
204          "lte",
205          "gte",
206          "or",
207          "not",
208          "ne",
209          "startsWith",
210          "endsWith"
211        ]
212      },
213      "_owner":       {
214        "displayName": "_owner",
215        "type": "text",
216        "queryOperators":         [
217          "eq",
218          "lt",
219          "gt",
220          "hasSome",
221          "and",
222          "lte",
223          "gte",
224          "or",
225          "not",
226          "ne",
227          "startsWith",
228          "endsWith"
229        ]
230      },
231      "share_price":       {
232        "displayName": "share_price",
233        "type": "number",
234        "queryOperators":         [
235          "eq",
236          "lt",
237          "gt",
238          "hasSome",
239          "and",
240          "lte",
241          "gte",
242          "or",
243          "not",
244          "ne",
245          "startsWith",
246          "endsWith"
247        ]
248      }
249    }
250  }
251]}