If the API changes in an incompatible manner this is listed explicitly in the "important release notes" section of each releases changelog.
Provides access to config of the application
URL: | /editor/config |
Available Methods: | GET,PUT |
Specialities: | List or modify configuration based on user roles |
All translate5 configuration are grouped in 6 different groups called levels. More info about the levels you can find in the table bellow.
| Level name | Level configuration value | Description | Available for user role |
|---|---|---|---|
| system | 1 | This is system configuration level. The values of those configs are defined in the database, and can only be changed there(no translate5 interface or api interface to change config defined with system level ) | / |
| instance | 2 | The instance level configuration can be overwritten via the translate5 interface or api, and the value defined there, is a base value for all other upper levels. The configuration overview panel for instance level configuration can be found in the translate5 preferences tab and it is accessible only for admin users. | admin,api |
| customer | 4 | Customer level configuration can be overwritten via the translate5 interface or api, and the value defined there is a base value for task-import and task configuration. In translate5 the customer configuration panel can be found as separate sub-tab for each customer separately. This panel is only available for admin users. | admin,api |
| task-import | 8 | Task import level configuration can be overwritten via the translate5 interface or api. The task import configuration panel can be found in the task import wizard, after the language resources association. This panel is available only for admin users | admin,api |
| task | 16 | Task level configuration can be overwritten via the translate5 interface or api. The task configuration panel can be found as sub-tab in the task preferences panel and it is available for admin users only. | admin,api |
| user | 32 | All existing user configurations are handled by the state provider. You can not explicit define user level value, but you can define base value for the user level configs in the | admin,api,editor,pm |
Resource Layout
Name | Type | Info |
id | int | |
name | string | Name used in application to retrieve the config. |
confirmed | boolean | future feature. |
module | string | PHP Module where the config is used. |
category | string | A string to categorize the config entry. |
value | string | The config value as string representation. |
default | string | The default config value delivered by translate5. |
| defaults | string | future feature, should contain the available values for radio box like configs when used in a GUI. |
| type | string | contains the type to which value is casted in PHP. |
| description | string | A textual description of the config. |
| level | integer | Configuration level. This defines where this configuration can be overwritten and who can see it. |
| guiName | string | Simple configuration description. |
| guiGroup | string | Configuration group |
| comment | string | |
| origin | string | Where the config overwrite comes from. (db/system, instance, customer, taskImport,task) |
Put request example for changing instance level config
{ data: { "value":"New company name", "name":"runtimeOptions.companyName" } } |
Put request example for overwriting task specific config
{ data:{ "value":"0", "taskGuid":"{1d842b86-c0a1-4f6d-bd23-5c1577172224}", "name":"runtimeOptions.editor.showReferenceFilesPopup" }
|
In the example above, the config value for runtimeOptions.editor.showReferenceFilesPopup will be set to 0 for the task with taskGuid {1d842b86-c0a1-4f6d-bd23-5c1577172224}.
Depending on the second parameter (in the example above taskGuid), translate5 will decide for what kind of config overwrite the current request is. For example if instead of providing the taskGuid,
customerId is provided, this config value will be saved as customer specific overwrite and it will be default value for all tasks of this customer.