Generates an Excel report containing the revisions and comments per each filtered segment.
Note that the report prints information for a maximum of 10.000 segmentsThis 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/timelineview/reportpropertiesPARAMETERS
The parameters are a JSON object included in the request body:
scope | The scope object. | Mandatory | |||
| query | An optional query object. This allows to constrain the segments to include in the reportlayout | 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 | ||
| slocallColumns | The source language. | Mandatory | tloc | The target language. Revisions and comments are shown in this language onlyTrue: The result includes the list of all available columns. Use if you need this list for configuration purposes. | Mandatory |
| mode | The type of report:
By default the system uses "revisions". | OptionalloadRightsFromCache | 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:
filetoken | A token that lets you download the Excel file. Then open a browser page and direct to media/get/{token}/stream to then download the Excel. | string | ||
| segments | Total number of segments in the report. | int | ||
| rows | Total number of Excel rows. Each row is one text version hence there are typically multiple rows per each segment. | intlayout | 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 |