Import Export

Export data

Run the query and return list of result documents. Query cannot contain the following keywords: INSERT, UPDATE, REPLACE, REMOVE and UPSERT.

post/_fabric/{fabric}/_api/export

Request

The document declares no server URL.
Auth
- API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_fabric/:fabric/_api/export/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

fabricstring string required

The name of the fabric.

Request body

bindVarsobject

Key-value pairs representing the bind parameters. Optional if bind parameters are not used in query.

querystring string

C8QL query. Default: returns all documents.

Example request

{
  "bindVars": {}
}

Response

Successfully exported data.

codeinteger

HTTP response code.

errorboolean

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

Example response

{
  "code": 200,
  "result": [
    {
      "_key": "1634556",
      "name": "test1"
    }
  ]
}

Changes

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