Breadcrumbs

settings/tbx/config/user

Gets list of TBX fields to which the connected user has access including preferences and editing rights.

URL

(GET) /api/settings/tbx/config/user

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:

"editAlways": [ "explanation", "context" ]

string[]?

editAllowed

The list of fields that the user is allowed to edit. Null gives unlimited editing rights for all TBX fields.

"editAllowed": [ "explanation", "context" ]

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.

"selectorTop": [ "explanation", "context" ]

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:

  • 0 - plainText: Text without any markup.

  • 1 - basicText: Text with markup, see TBX specification.

  • 2 - noteText: Text with markup, see TBX specification.

  • 3 - picklist: User chooses from a list of recommended values. See the "values" collection below.

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:

  • 0 - termEntry: Concept level.

  • 1 - langSet: Language level.

  • 2 - term: Term level.

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:

  • v: The value

  • t: An optional title. If null then no title is defined and you would use "v"instead

object[]


EXAMPLES

 Query:

(GET) /api/settings/tbx/config/user

Result:

{
	"fields": [{
		"field": "context",
		"type": 2,
		"levels": [2],
		"title": "Context",
		"values": null
	}
	...
	],
	"editAlways": ["definition", "context", "explanation", "processStatus"],
	"editAllowed": null,
	"selectorTop": ["definition", "context", "explanation",
	"processStatus"],
	"selectorHide": null
}