...
The parameters are a JSON object included in the request body:
scope | The scope object. The segment must be within the scope. | Mandatory |
| query | An optional query object. This allows to constrain the segments to fetch comments forinclude in the report. | MandatoryOptional |
| locssloc | The source language. | OptionalMandatory |
| locttloc | The target language. | Optional |
| take | Used for pagination. Number of pages to retrieve. If not set, value will be 30. | Optional |
| knownPersons | Optional array of person/user ids for which we do not need name and company, since we already have this information. Try to provide the person ids if you already have details as this will speed up performance. | Optional |
| asc | Optional sort order. False (default) = sort with most recent comments on top. True = Oldest comments on top. | Optional |
RESULTS
A JSON with these properties:
scomments | An array of segment level comments. See Comment (Object) for details. | object[] |
| scommentsHasMore | True if there are more segment level comments. Find more elements using this method: resources/comments/list and set skip to the value of "take" used with this call. | bool |
| dcomments | An array of document level comments. See Comment (Object) for details. Find more elements using this method: resources/comments/list and set skip to the value of "take" used with this call. | object[] |
| dcommentsHasMore | True if there are more document level comments. Find more elements using this method: resources/comments/list and set skip to the value of "take" used with this call. | bool |
| persons | An object containing the persons referred to by comments or revisions. Note:
See Persons List (Object) for details. | object |
| locales | A list of all locales available for this segment and which are within the scope. You can use these in a comments/revisions language filter. | string[] |
| rights | A few access rights that are specifically useful when working with the results:
Note: When using the APIs to add/edit/delete comments, you may obtain a not authorized information even when the edit, canAdd or canSendEmail properties are true. The reason for this is that further detailed access rights check are done upon those advanced operations. | object |
ACCESS RIGHTS
When working with the timeline of a segment, you should always read out these properties:
- comments.[].edit: Tells if a comment can be edited or deleted.
- rights.canAdd: Tells if a new comment can be added to the segment.
- rights.canSendEmail: Tells if a newly added comment can be notified by email to people involved with this segment.
EXAMPLE
...
| Revisions and comments are shown in this language only. | Mandatory | |
| mode | The type of report:
By default the system uses "revisions". | Optional |
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 |