...
Wordbee further defines its own fields for Wordbee specific details such as custom fields or the text status and bookmark.
URL
(GET) /api/settings/tbx/fields
PARAMETERS
The method has no parameters.
RESULTS
The result is a JSON array with one element per SRX rule set:
field | The field ID. Examples: context, grammaticalGender, definition etc. | string |
title | The print title | string |
comment | Optional description | 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[] |
category | The TBX data category. Any of:
NOTE: Data retrieved or stored in "note", "ref" or "xref" are not explicitly listed as fields in the results. | string |
module | The "module" that specifies this field:
| string |
storage | A Wordbee specific information that describes where the field data is stored inside a segment/text. This is useful information if you retrieve segments using the API and you would like to know where data is saved.
| string |
EXAMPLES
Code Block |
---|
[{
"field": "context",
"type": 2,
"levels": [2],
"title": "Context",
"comment": "A sample sentence that contains the term.",
"values": null,
"category": "descrip",
"module": "Basic",
"storage": "TbxField"
},
{
"field": "definition",
"type": 2,
"levels": [0, 1],
"title": "Definition",
"comment": null,
"values": null,
"category": "descrip",
"module": "Basic",
"storage": "TbxField"
},
{
"field": "grammaticalGender",
"type": 3,
"levels": [2],
"title": "Gender",
"comment": null,
"values": [{
"v": "Feminine",
"t": "feminine"
},
{
"v": "Masculine",
"t": "masculine"
},
{
"v": "Neuter",
"t": "neuter"
},
{
"v": "Other Gender",
"t": "otherGender"
}],
"category": "termNote",
"module": "Basic",
"storage": "TbxField"
}
.....
]
|