POST

Find Schemas


Get a list of schema objects base on a list of schema IDs.

Make this method available at the following path: /schemas/find.

Body Params
schemaIdsArray <string>

A list of schemas to find.


requestContextRequestContext

The request context object.

Response Object
schemasArray <Schema>

A list of schema objects

Find Schemas Example 1

Get a list of schema objects in the list ["car","manufacturer"].

Request
cURL
curl -X POST \ 'https://mysql-adapter.com/schemas/find' \ --header 'Content-Type: application/json' \ --data-raw '{ "requestContext": { "settings": { "secretKey": "mySecureSecret" }, "instanceId": "12a345b6-7890-98d7-65e4-f321abc1de23", "installationId": "987fe654-3d21-4def-ab5c-6d78e90f123a", "memberId": "77aa88bb-2c2c-d3d3-4e4e-ff55aa66bb77", "role": "OWNER" }, "schemaIds": [ "car", "manufacturer" ] }'
Response
JSON
{ "schemas": [ { "displayName": "car", "id": "car", "allowedOperations": [ "get", "find", "count", "update", "insert", "remove" ], "maxPageSize": 50, "ttl": 3600, "fields": { "_id": { "displayName": "_id", "type": "text", "queryOperators": [ "eq", "lt", "gt", "hasSome", "and", "lte", "gte", "or", "not", "ne", "startsWith", "endsWith" ] }, "_owner": { "displayName": "_owner", "type": "text", "queryOperators": [ "eq", "lt", "gt", "hasSome", "and", "lte", "gte", "or", "not", "ne", "startsWith", "endsWith" ] }, "make": { "displayName": "make", "type": "text", "queryOperators": [ "eq", "lt", "gt", "hasSome", "and", "lte", "gte", "or", "not", "ne", "startsWith", "endsWith" ] }, "model": { "displayName": "model", "type": "text", "queryOperators": [ "eq", "lt", "gt", "hasSome", "and", "lte", "gte", "or", "not", "ne", "startsWith", "endsWith" ] }, "year": { "displayName": "year", "type": "number", "queryOperators": [ "eq", "lt", "gt", "hasSome", "and", "lte", "gte", "or", "not", "ne", "startsWith", "endsWith" ] }, "date_added": { "displayName": "date_added", "type": "datetime", "queryOperators": [ "eq", "lt", "gt", "hasSome", "and", "lte", "gte", "or", "not", "ne", "startsWith", "endsWith" ] } } }, { "displayName": "manufacturer", "id": "manufacturer", "allowedOperations": [ "get", "find", "count", "update", "insert", "remove" ], "maxPageSize": 50, "ttl": 3600, "fields": { "name": { "displayName": "name", "type": "text", "queryOperators": [ "eq", "lt", "gt", "hasSome", "and", "lte", "gte", "or", "not", "ne", "startsWith", "endsWith" ] }, "country": { "displayName": "country", "type": "text", "queryOperators": [ "eq", "lt", "gt", "hasSome", "and", "lte", "gte", "or", "not", "ne", "startsWith", "endsWith" ] }, "established": { "displayName": "established", "type": "datetime", "queryOperators": [ "eq", "lt", "gt", "hasSome", "and", "lte", "gte", "or", "not", "ne", "startsWith", "endsWith" ] }, "_id": { "displayName": "_id", "type": "text", "queryOperators": [ "eq", "lt", "gt", "hasSome", "and", "lte", "gte", "or", "not", "ne", "startsWith", "endsWith" ] }, "_owner": { "displayName": "_owner", "type": "text", "queryOperators": [ "eq", "lt", "gt", "hasSome", "and", "lte", "gte", "or", "not", "ne", "startsWith", "endsWith" ] }, "share_price": { "displayName": "share_price", "type": "number", "queryOperators": [ "eq", "lt", "gt", "hasSome", "and", "lte", "gte", "or", "not", "ne", "startsWith", "endsWith" ] } } } ] }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?