STRUCTURE RESULTS
...
When you query for segments you obtain the actual data and a detailed description of the data columns. The result (data + columns) is called a spreadsheet.
The spreadsheet column is an extension of the spreadsheet layout (it inherits and extends the layout column object).
PROPERTIES
The columns are listed in a JSON property "columns". Each column has these properties:
| index | A sequential index starting at 0. | int | ||
| name | The print title of the column. For example: "English", "Context", etc. | string | ||
| loc | The language code of the column. Note that some columns are language independent. | string? | ||
| loc_rtl | True if the language is "right-to-left" such as Arabic or Hebrew. | bool | ||
| loc_cmplx | True if the language is a "complex script" language. This is the case for Arabic, Pashto, Sorani, Farsi, Thai and others. You find more information here: https://msdn.microsoft.com/en-us/library/windows/desktop/dd317698(v=vs.85).aspx | bool | ||
| loc_ea | Not used. | bool | ||
| fkey | Uniquely identifies the content of the column. When querying data you only need to include this property. All other properties below are for information purposes only. The format is:
Examples:
| string | ||
| fkeylayout | The corresponding key in the layout you included with your query. This will be different from "fkey" only if you used language indexes instead of codes in the layout. | |||
| ftype | The type of the column. It is embedded inside "fkey". | int | ||
| canEdit | If false then this column is not editable by the user. Note that this is a general access right. You need to look at the access rights details sent back with each segment. | bool | ||
| fqualifier | Used with certain data columns such as custom fields and labels. This then describes the CF or label ID. 0 if not applicable to field type. | int |
EXAMPLES
A column containing the English text of a segment:
| Code Block |
|---|
{ "index": 0, "fkey": "1~en~0", "fkeyLayout": "1~#0~0", "ftype": 1, "fqualifier": 0, "name": "English", "loc": "en", // code required to know eactly which content: locale, custom field id, etc. "loc_rtl": false, // the locale is right to left. For example: Hebrew, Arabic "loc_cmplx": false, // this is a complex script. Used for Arabic, Hebrew, etc. "loc_ea": false // this is an east asia script. For example: Chinese or Japanese. "canEdit": true // the field can be edited } |
STRUCTURE QUERY
| Code Block |
|---|
{ "fkey": "1~en~0" // Determine key of column }} |
The example above shows that the layout specified a language index instead of a specific language code in fkeylayout. The index was replaced in fkey with the first language in the scope.