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.
| PROPERTY | SUPPORTED FILTERS & SORTING |
|---|---|
_id | eq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending() |
key.appId | eq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending() |
key.entityType | eq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending() |
key.scope | eq(),ne(),exists(),in(),hasSome(),ascending(),descending() |
hidden | eq(),ne(),exists(),in(),hasSome(),ascending(),descending() |
parentId | eq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending() |
You can only call this method when authenticated as a Wix app or Wix user identity.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.