MAmacrometa
Query Workers

Run query worker

Run a saved query for a given fabric. If there are more that 100 records (default batch-size), the hasMore flag is set to true and the id is set. This id is used to query subsequent records.

post/_fabric/{fabric}/_api/restql/execute/{name}

Request

Path parameters

fabricstring string required

Fabric name of the saved query.

namestring string required

Query name to run.

Request body

bindVarsobject

Specify the bindVars of the query.

batchSizeinteger

The maximum number of documents returned when fetching data from the query.

Example request

{
  "bindVars": {}
}

Response

Successfully ran the query.

codeinteger

HTTP response code.

errorboolean

Flag if there is an error in response. False for this response.

hasMoreboolean
idinteger
cachedboolean

Example response

{
  "code": 201,
  "hasMore": true,
  "id": 11894969,
  "extra": {
    "warnings": []
  },
  "result": [
    {
      "_id": "test/foo",
      "_key": "foo",
      "_rev": "_dPRuHxe--_",
      "data": "data1"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.