How do I query a dataset?

Prev Next

You can query a dataset for records that have been added at any time.

Methods

Call the QueryRelationalData API, specifying the scope and code of the RDD in the URL, and optionally a request body containing parameters. For example:

curl -X POST 'https://<your-domain>.lusid.com/api/api/relationaldatasets/MyDatasets/Addresses/$query'
  -H 'Content-Type: application/json-patch+json' 
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "queryMethod": "TimeSeries",
  "filter": "",
  "customSortBy": [
    "fieldName": "Field1",
    "priorityValues": ["Val1", "Val2"],
    "remainderOrder": "ASC"
  ]
}'

Coming soon

Coming soon

Request fields

This section supplements the API documentation and on-screen help text in the LUSID web app.

If omitted, queryMethod defaults to Latest and data series are returned. To return data points within data series, set queryMethod to TimeSeries. More information.

You can optionally specify a filter to restrict the data returned. More information coming soon.

You can optionally specify a customSortBy method to sort the data returned. More information coming soon.