DEdefra
Query

Query a MongoDB collection

Query a MongoDB collection with OData-style parameters.

Examples:

  • GET /api/query/sam_cph_holdings?$filter=CPH eq 'ABC123'&$top=50
  • GET /api/query/sam_cph_holdings?$filter=contains(CPH,'ABC') and IsDeleted eq false&$orderby=UpdatedAtUtc desc
  • GET /api/query/sam_cph_holdings?$select=CPH,UpdatedAtUtc&$top=20
get/query/{collectionName}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/query/{collectionName}
  • Auth
    API key in header X-API-Key

Path parameters

collectionNamestring required

Name of the collection (e.g., 'sam_cph_holdings')

Query parameters

$filterstring

OData $filter expression

$orderbystring

OData $orderby expression (e.g., 'UpdatedAtUtc desc')

$selectstring

OData $select expression (e.g., 'CPH,UpdatedAtUtc')

$skipinteger
$topinteger

Max 1000, default 100

$countboolean

Include total count in response

Response

Query results

collectionNamestring
countinteger
totalCountinteger nullable
dataobject[]
executedAtUtcstring date-time

Changes

No recorded changes to this operation across all 5 revisions of this API.