Provides a wide range of tools to update one or more filtered segments in batch. The batch operations include: Change text, Find & Replace, Change status and bookmarks, Pre-translate from memories etc.
URL
(POST) /resources/segments/view/actions/batch
PARAMETERS
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 |
| layout | The editor grid layout. Only fields included in the layout can be updated by the batch operations. If not set then a default layout will be created that covers only a minimal set of columns (typically source and target text). | Optional |
| query | An optional query object. This allows to delimit the operation to a subset of the scope's segments. | Optional |
| actions | A JSON object describing the actions to apply. See below. | Optional |
| doSave | Optional, default is true. True: Changes are saved. False: Changes are not saved. The latter permits to obtain statistics about what data the operation will update without actually updating. | Optional |
The actions property is an object configuring the actual actions to apply:
items | An array with one or more actions to apply. The structure of each element is described below. The action type is contained in property type. See the following links for details on each action type:
| Mandatory |
| onChangeBookmark | Optional. When a segment text or a property of the text is updated by an operation then optionally update the bookmark value as follows:
| Optional |
| onChangeStatus | Optional. When a segment text or a property of the text is updated by an operation then optionally update the status of the text as follows:
|
RESULTS
A JSON with these properties:
|
|