getSchema( )

Developer Preview

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

Retrieves a translation schema by ID.

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
function getSchema(schemaId: string): Promise<Schema>;
Method Parameters
schemaIdstringRequired

ID of the translation schema to retrieve.

Returns
Return Type:Promise<Schema>
JavaScript
import { translationSchemas } from "@wix/multilingual";

async function getSchema(schemaId) {
  const response = await translationSchemas.getSchema(schemaId);
}
Errors

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

Did this help?