Enumerates segment level or document level comments for all source documents in a scope. This only includes files marked for translation.
With translation memories or termbases (which use the DocumentSet scope), this method yields import operations.
Note that the method does not support the GlobalSearch scope.
URL
(POST) /resources/documents/listPARAMETERS
The parameters are a JSON object included in the request body:
scope | The scope object. The segment must be within the scope. NOTE: This method does not support the Global Search scope. | Mandatory, object |
| skip | Used for pagination. 0 = get documents from the start. If not specified, value will be 0. | Optional, int? |
| take | Used for pagination. Number of documents to retrieve. If not set, value will be 30. | Optional, int? |
| name | Optional filter on the name. This is an infix filter. | Optional, string? |
| did | Optional filter on a specific document. If specified the system returns information for this specific document only. | Optional, int? |
...
RESULTS
A JSON with these properties:
items | An array of all documents in alphabetical order. See Document Details (Object) for details. The advanced properties are not included. |
| total | The total of documents. |
| hasmore | Boolean indicating if there are more results available. |
...