resources/segments/view/actions/join
This method permits to join a sub-segment with either its predecessor or its successor.
DOC: Move "join" properties to root
URL
(PUT) /resources/segments/view/actions/join
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 |
join | Properties of the segment to be joined: 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, ...) mergeNext: True to merge sub-segment with next sub-segment. False to merge with previous sub-segment.
| Mandatory |
RESULTS
After executing the join, the system returns a spreadsheet with all sub-segments of the segment.
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 |