API
  • API Index
  • Batch API
  • Content Negotiation
  • Dynamic Paths
  • Hierarchy API
  • List API
  • Quick Reference
  • Time Series API
  • Views
      • Configuration
  • Overview
  • Application Configuration
  • Documentation Configuration
  • Spec Configuration
      • Features
  • API Testing
  • Asynchronous Processing
  • Cassandra Time-Series Engine
  • Cassandra Integration
  • Default Controller Customisation
  • Documentation
  • Geospatial Filtering
  • Model Documentation
  • PostgreSQL Integration
  • Excel Spreadsheet Format
      • Tutorials
  • Step-by-Step Guide
  • Archetype Setup
  • Logging
  • Prometheus
  • Sentry Logging
      • UI Customisation
  • UI Customisation
  • SASS Build Chain
  • Shared Layout
  • API Documentation
  • Model Documentation
  • Results
    • sapi-nt v current

    Views

    Some endpoints provide a choice of views, which are sets of properties to include in API results. All list, item, and hierarchy endpoints have a default view which is used if no specific view is requested.

    The default and available views for each endpoint are defined by their view configuration. You can also see the list of views on the API documentation page, if it’s available.

    View Parameters

    Parameter Description
    _view The name of a view to return.
    _projection A projection string, defined with respect to the requested or default view.
    _withView If both a projection and view are given, include the original view in the resulting projection.