settings/tbx/fields/{id}

Get title, comments and full details for a specific TBX field.

URL

(GET) /api/settings/tbx/fields/{id}

PARAMETERS

URL parameters are:

id

TBX field ID such as "context", "grammaticalGender" or "definition".

Use settings/tbx/fields to enumerate all fields and their IDs.

string, Mandatory

RESULTS

The result is a JSON object.

See settings/tbx/fields for a description of properties.

EXAMPLES

Query:

CODE

(GET) /api/settings/tbx/context

Result:

CODE

{
 "field": "context",
 "type": 2,
 "levels": [2],
 "title": "Context",
 "comment": "A sample sentence that contains the term.",
 "values": null,
 "category": "descrip",
 "module": "Basic",
 "storage": "TbxField"
}