Organization
Users and User Groups
Permissions
Data Source
Workspaces
    Workspaces - Entity APIs
    Workspaces - Declarative APIs
    Data Filters
    Workspaces - Settings
    Appearance
    Plugins
    Hierarchy
    Translations
      Get translation tags.getCleans up translations.postRetrieve translations for entities.postSet translations for entities.post
Logical Data Model
Analytical Objects
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

Translations (3.51)

Endpoint:/

Get translation tags.

GET
/api/v1/actions/workspaces/{workspaceId}/translations

Provides a list of effective translation tags.

Get translation tags. › path Parameters

  • workspaceIdstring · required

Get translation tags. › Responses

Retrieved list of translation tags.

string
GET /api/v1/actions/workspaces/{workspaceId}/translations

Cleans up translations.

POST
/api/v1/actions/workspaces/{workspaceId}/translations/clean

Cleans up all translations for a particular locale.

Cleans up translations. › path Parameters

  • workspaceIdstring · required

Cleans up translations. › Request Body

  • localestring · required

    Requested locale in the form of language tag (see RFC 5646).

    Example: en-US

Cleans up translations. › Responses

Translations were successfully removed.

No data returned
POST /api/v1/actions/workspaces/{workspaceId}/translations/clean

Retrieve translations for entities.

POST
/api/v1/actions/workspaces/{workspaceId}/translations/retrieve

Retrieve all translation for existing entities in a particular locale. The source translations returned by this endpoint are always original, not translated, texts. Because the XLIFF schema definition has the 'xs:language' constraint for the 'srcLang' attribute, it is always set to 'en-US' value.

Retrieve translations for entities. › path Parameters

  • workspaceIdstring · required

Retrieve translations for entities. › Request Body

  • localestring · required

    Requested locale in the form of language tag (see RFC 5646).

    Example: en-US

Retrieve translations for entities. › Responses

XLIFF file containing translations for a particular locale.

  • fileobject[] · required
  • otherAttributesobject
  • spacestring
  • srcLangstring
  • trgLangstring
  • versionstring
POST /api/v1/actions/workspaces/{workspaceId}/translations/retrieve

Set translations for entities.

POST
/api/v1/actions/workspaces/{workspaceId}/translations/set

Set translation for existing entities in a particular locale.

Set translations for entities. › path Parameters

  • workspaceIdstring · required

Set translations for entities. › Request Body

  • fileobject[] · required
  • otherAttributesobject
  • spacestring
  • srcLangstring
  • trgLangstring
  • versionstring

Set translations for entities. › Responses

Translations were successfully set.

No data returned
POST /api/v1/actions/workspaces/{workspaceId}/translations/set
HierarchyGenerate Logical Data Model