Skip to main content

Search Received Routes

Request

The API provides capability to get list of received routes using search criteria, including optional filtering, pagination and sorting

Security
BearerAuth
Path
connectionIdstringrequired

Connection Id

Example:557400f8-d360-11e9-bb65-2a2ae2dbcce4
Bodyapplication/jsonrequired
filterobject(ConnectionRouteEntryFilters)
paginationobject(PaginationRequest)

Pagination request information

sortArray of objects(ConnectionRouteSortCriteria)
Payload
{ "filter": { "and": [ … ] }, "pagination": { "offset": 0, "limit": 20 }, "sort": [ { … } ] }

Responses

Successful operation

Bodyapplication/json
paginationobject(Pagination)

Pagination response information

dataArray of objects(ConnectionRouteTableEntry)

Data returned from the API call.

Response
{ "pagination": { "offset": 0, "limit": 20, "total": 1 }, "data": [ { … } ] }
Was this page helpful?