This section provides important information about the common segmentation mechanism adopted by Fabrick Platform APIs.
Segmentation is available for an endpoint whenever the SEGMENTATION option is highlighted in the technical documentation.
Request
If available, the request for segmentation is managed through query parameters:
<HTTP VERB> <URI>?segmentId={segmentId}&verboseSegmentation={verboseSegmentation}
The segmentId parameter is the ID of the segment to be retrieved.The
verboseSegmentation parameter is a boolean flag used to request the segmentation element in the response. Default value is true.Response
If segmentation is requested, the response body will include the segmentation element:
{
...
"segmentation": {
"segmentLength": 200,
"segmentId": "263687770H...1",
"nextSegmentId": "263687770H...2"
}
}
The
segmentLength field contains the number of elements of the current segment.The
segmentId field contains the ID of the current segment.The
nextSegmentId field contains the ID of the next response segment to be retrieved. If null there are no more segments to be retrieved.