Offset

offset specifies the number of results that will be skipped. For instance, to retrieve the first 10 results, offset must be set to 0 and limit to 10. To retrieve the next 10 results, offset must be set to 10 and limit to 10.

offset is specified as a numeric integer value.

offset Examples

Assuming there are 10 entities with class “Person”, skipping the first 5 of them, the rest will be returned:

[{
    "FindEntity": {
        "with_class": "Person",
        "offset": 5,
        "results": {
            "list": ["id"]
        }
    }
}]

Successful response:

[{
    "FindEntity": {
        "entities": [{
            "_class": "Person",
            "id": 5
        }, {
            "_class": "Person",
            "id": 6
        }, {
            "_class": "Person",
            "id": 7
        }, {
            "_class": "Person",
            "id": 8
        }, {
            "_class": "Person",
            "id": 9
        }],
        "returned": 5,
        "status": 0
    }
}]

Assuming there is 1 image per year since the year 1990 and skipping first 10 of them, 5 images from 2000 to 2004 will be returned:

[{
    "FindImage": {
        "constraints": ["$year_captured", ">=", 1990],
        "sort": "year_captured",
        "limit": 5,
        "offset": 10,
        "results": {
            "list": ["year_captured"]
        },
        "blobs": true
    }
}]

Successful response:

[{
    "FindImage": {
        "returned": 5,
        "status": 0,
        "blobs_start": 0,
        "entities": [{
            "_class": "Images",
            "_blob_index": 0,
            "year_captured": 2000
        }, {
            "_class": "Images",
            "_blob_index": 1,
            "year_captured": 2001
        }, {
            "_class": "Images",
            "_blob_index": 2,
            "year_captured": 2002
        }, {
            "_class": "Images",
            "_blob_index": 3,
            "year_captured": 2003
        }, {
            "_class": "Images",
            "_blob_index": 4,
            "year_captured": 2004
        }]
    }
}]