resources/segments/view/actions/split

This method permits to split a segment (or sub-segment) into two sub-segments.

Manual splitting means that you provide the exact character position where to split. Automatic splitting means that you let the system find a "good" split point.

DOC: Move "split" properties to root

URL

(PUT) /resources/segments/view/actions/split

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. The layout describes how the resulting split (sub-)segments are returned.

If not specified then the default 2 column layout is applied.

Optional

split

Properties of the segment to be split:

dsid: The document set ID of the segment

did: The document ID of the segment

bsid: The bee segment ID of the segment

bssid: The bee sub-segment ID of the segment (0 = first, 1 = second, ...)

locale: The language to split (the source or a target language). Although all language version of the segment are going to be split, this is the language where the split algorithm starts its operations. This typically is the source language.

position: Optional character position in the text where to split. If specified then the split is done at this exact position. If not specified / null then the system finds a "good" split point automatically.

Mandatory

RESULTS

After executing the split of the segment, the system returns a spreadsheet with the segment (and all its sub segments).

result

Contains these properties:

rows: Array with all sub-segments sharing the same bsid value

docs: Array with document details for the segment. Will contain a single element.

users: Users that edited properties of the segments (revisions, comments etc.)

object