SearchResponse

Search response


Properties

array of ResourceLink
_links Optional

The server will populate this field when returing the resource. Ignored on PUT and POST.


string
_schema Optional

Schema for this resource


_self Optional

Link to this resource


string
cursor Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)


integer
result_count Optional

Count of results found (across all pages), set only on first page


array of object
results Optional

Search results


boolean
sort_ascending Optional

If true, results are sorted in ascending order


string
sort_by Optional

Field by which records are sorted

JSON Example

{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "cursor": "string",
    "result_count": 0,
    "sort_ascending": false,
    "sort_by": "string"
}
Feedback

Was this page helpful?