Sign in
Bundle Translations Provider Interfaces

Update configuration

Changed on

Update the configuration of the Translations Provider Interfaces Bundle

put/pimcore-studio/api/bundle/translations-provider-interfaces/config

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/bundle/translations-provider-interfaces/config
  • Auth: none declared

Request body

additionalAttributesobject

AdditionalAttributes

settingsobject required

General settings

translationsComobject required

Translations.com configuration

deepLobject required

DeepL configuration

Example request

{
  "settings": {
    "auto_submit": true,
    "project_shortcode": "Pimcore",
    "default_provider": "translations-provider.translationscom",
    "allowed_languages": "en",
    "notification_recipients": "",
    "redelivery_threshold": 60,
    "error_threshold": 10
  },
  "translationsCom": {
    "project_director": {
      "username": "pimcore",
      "password": "pa$$w0rd",
      "url": "https://gl-connect7.translations.com/PD",
      "defaultFileFormatProfile": "PimcoreXML"
    }
  },
  "deepL": {
    "api_url": "https://deepl.url",
    "token": "myapitoken",
    "glossary_url": ""
  }
}

Response

Configuration updated successfully

additionalAttributesobject

AdditionalAttributes

configurationobject required

Detailed config data

isWriteableboolean required

Whether the configuration is writeable

activeProviderTypesstring[] required

Active translations providers

Example response

{
  "activeProviderTypes": [
    "Pimcore\\TranslationsProviderInterfaceBundle\\TranslationsProvider\\DeepL"
  ],
  "availableProviders": [
    [
      "translations-provider.deepl",
      "DeepL"
    ]
  ]
}

Changes