Export API

The export endpoint allows the retrieval of full data from an Orgvue dataset including calculations and linked data. A guide to creating basic export requests is described under the Integration Guide as Your First Export Call.

Retrieving full dataset records can be computationally expensive and/or result in large amounts of generated data. This is best handled by making asynchronous POST requests.

Querying data

Data can be filtered by row by supplying a filter object, and columns manipulated via a projection object.

To allow properties to be accurately returned, filtering of data occurs after all calculations have been processed. This is because filtering data before calculations have occurred could change the results of the calculations. To reflect this, query specifications must be nested in the JSON payload under $.query.output as indicated below:

{
  "query": {
    "output": {
      "filter": {
        ...
      },
      "projection": {
        ...
      }
    }
  }
}

In the future it will be possible to supply an input query to improve performance by reducing the amount of data it is necessary to retrieve and process.

See the relevant sections for detailed descriptions of how to configure filters and projections.

Utilizing Cache Keys

A cache key is a unique identifier that can be used to check for dataset updates. You can retrieve a dataset's current cache key via the "Dataset metadata" endpoint. Any time that a dataset is updated, or the security rules change, the cache key will also be updated. If you store a dataset's cache key locally, you can compare it to the dataset's cache key at a later date to check if anything has changed. If the cache keys are the same, then you know that no updates have occurred.

Linked datasets

Orgvue datasets can be linked to one another via linking relationships. Data from a linked dataset can be retrieved as part of an export query as described HERE