resources/segments/view/properties
This method permits to obtain details regarding a spreadsheet.
You input a scope and, optionally, a layout and the method returns detailed information on the spreadsheet. These are typically needed to correctly render segments in a user interface.
URL
(POST) /resources/segments/view/propertiesPARAMETERS
The parameters are a JSON object included in the request body:
scope | The scope object. | Mandatory |
| layout | Optional layout which the list of columns to render. If null or not specified, the spreadsheet is preset for 2 columns: Source text and translation (first if there are multiple). | Optional |
| allColumns | True: The result includes the list of all available columns. Use if you need this list for configuration purposes. | Mandatory |
| loadRightsFromCache | True: Reload all data from cache. False: Optimize performance. We recommend to set true only if you are confident that changes were done to any of: The user access rights, The object to which the scope refers, Custom field or labels settings, etc. | Mandatory |
RESULTS
A JSON with these properties:
layout | Detailed spreadsheet properties including layout, columns and other. See Spreadsheet Properties (Object) for all the properties. | object |
| rights | Detailed access rights regarding scope and spreadsheet. See Rights (Object) for all the properties. | object |
| blankSegment | A skeleton for adding a blank new segment. This simplifies the creation of new segments if the scope refers to a termbase or translation memory. | object |