Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

# Schema Overview  The Schema SPI describes the endpoints and payloads for schema API requests to your external database and the payloads for their success and failure responses. Schema API requests may occur whenever your site needs to interact with the data in your external collection. The schema may be cached for at most the amount of time indicated in the `ttl` field of the `schema` object.

# Schema Overview

The Schema SPI describes the endpoints and payloads for schema API requests to your external database and the payloads for their success and failure responses. Schema API requests may occur whenever your site needs to interact with the data in your external collection. The schema may be cached for at most the amount of time indicated in the `ttl` field of the `schema` object.

The ID of the external collection making the request.

installationId

The ID of the Wix site making the request.



instanceId

The ID of the site visitor making the request.

memberId

Supported values: `VISITOR`, `MEMBER`, `OWNER`, `BACKEND_CODE`.

The role of the user or process making the request.

memberRole

requestContext

Supported values: `INSERT`, `UPDATE`, `GET`, `REMOVE`, `FIND`, `COUNT`.

A list of allowed data manipulation operations.

allowedOperations

Set of key-value pairs. A list of field specification objects

fields

The maximum number of items returned per page when querying data from this schema.

maxPageSize

The number of seconds for which the schema can be cached.



Schema

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



Find Schema by ID

Retrieves a list of available schemas in the external database collection.