settings/tbx/config/platform
Gets the TBX field configuration on platform level.
URL
(GET) /api/settings/tbx/config/platform
PARAMETERS
There are no parameters.
RESULTS
The result is a JSON object.
editAlways | Null or an array of TBX fields that shall always be shown when editing a concept or term, or when creating a new concept or term. If null then only those fields that are populated will be rendered when editing. A user can then add fields as needed. Fields will be shown in the given sequence. Example:
CODE
| string[]? |
editAllowed1 | The list of fields that a user can edit if he/she has access right "Can edit TBX fields of category 1". If null, then user with this access right can edit all TBX fields. | string[]? |
editAllowed2 | The list of fields that a user can edit if he/she has access right "Can edit TBX fields of category 2". If null, then user with this access right can edit all TBX fields. If empty array, then the user has no access to any fields. | string[]? |
editAllowed3 | The list of fields that a user can edit if he/she has access right "Can edit TBX fields of category 3". If null, then user with this access right can edit all TBX fields. If empty array, then the user has no access to any fields. | string[]? |
selectorTop | When adding more TBX fields to a concept or term, the TBX fields listed here shall be shown on top. These are the most important fields. This property cannot be null.
CODE
| string[] |
selectorHide | TBX fields that are removed from selectors to add more TBX fields to a concept or term. Purpose: remove TBX fields that are not used in your workflow. Set to null if all fields can be used. | string[]? |
fields | The list of all (accessible) TBX fields | object[] |
The "fields" array contains objects with these properties:
field | The field ID. Examples: context, grammaticalGender, definition etc. | string |
title | The print title | string |
type | The data type, any of:
| string |
levels | Specifies where this field can be used: On concept level, on language level or term level or any combination thereof. The array values are:
| int[] |
values | If the "type" is a pick list then this is an array of recommended values to choose from. Each array element is an object:
| object[] |
EXAMPLES
Query:
(GET) /api/settings/tbx/config/platform
Result:
{
"fields": [{
"field": "context",
"type": 2,
"levels": [2],
"title": "Context",
"values": null
}
...
],
"editAlways": ["definition", "context", "explanation", "processStatus"],
"editAllowed1": ["definition", "context", "explanation", "processStatus"],
"editAllowed2": ["explanation"],
"editAllowed3": [],
"selectorTop": ["definition", "context", "explanation", "processStatus"],
"selectorHide": null
}