Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Note

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

...

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.

defaultsstringfuture feature, should contain the available values for radio box like configs when used in a GUI.
typestringcontains the type to which value is casted in PHP.
descriptionstringA textual description of the config.
levelintegerConfiguration level. This defines where this configuration can be overwritten and who can see it.
guiNamestringSimple configuration description.
guiGroupstringConfiguration group
commentstring
originstringWhere 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

...