querySchemas( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a query to retrieve a list of schemas.

Note:

This method can retrieve all schemas with a GLOBAL scope and schemas with a SITE scope for the site the API request is authorized to access.

The querySchemas() function builds a query to retrieve a list of translation schemas and returns a SchemasQueryBuilder object.

The returned object contains the query definition, which is used to run the query using the find() function.

You can refine the query by chaining SchemasQueryBuilder functions onto the query. SchemasQueryBuilder functions enable you to filter, sort, and control the results that querySchemas() returns.

querySchemas() runs with the following SchemasQueryBuilder defaults which you can override:

The following SchemasQueryBuilder functions are supported for querySchemas(). For a full description of the operations object, see the object returned for the items property in SchemasQueryResult.

PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
key.appIdeq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
key.entityTypeeq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
key.scopeeq(),ne(),exists(),in(),hasSome(),ascending(),descending()
hiddeneq(),ne(),exists(),in(),hasSome(),ascending(),descending()
parentIdeq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Wix Multilingual - Translation Schema Read
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsQuerySchemasOptions
Returns
JavaScript
Errors

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

Did this help?