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

    Results

    The results page template is rendered in response to requests that are sent to the configured API endpoints. It contains the RDF data that was returned by the endpoint, displayed in a tabular format. Each resource is displayed as a table, which can be nested within other tables up to a maximum depth.

    The main body of the results page contains the list of result items and links to alternative formats (eg. JSON, CSV).

    The results page is comprised by the following sections:

    In addition, the error page may be rendered in place of the results.

    Result Formats

    The list of result formats is displayed in the top-right corner of the main body.

    The result formats area uses the following style classes:

    Class Usage
    result-format The container for result format links.
    result-format-csv The link to the results in CSV format.
    result-format-json The link to the results in JSON format.
    result-format-ttl The link to the results in TTL format.
    result-format-xml The link to the results in RDF XML format.

    Results List

    The result list displays a label (if available) for each result item and a table of its properties.

    It uses the following style classes:

    Class Usage
    item-label The label for a result item.
    no-results The message that is displayed when no results are found for the request.

    Result Table

    The properties of each resource are displayed in a table with two columns. The left column displays the property’s JSON name, and the right column displays the values of that property as nodes. The nodes themselves can be rendered as nested property tables, unless it would exceed the maximum nesting depth.

    Each property table uses the following style classes:

    Class Usage
    result-table The table containing the item’s properties.
    property-name The property name column.
    property-value The property value column.
    item-id The URI of the item that the table describes.
    literal-value A literal node.
    resource-value The URI of resource node.
    array-value An array of value nodes.
    property-table A nested table within a property value cell.
    resource-label A readable label that is assigned to a resource value.
    suppressed-url A full resource url where link is disabled.

    Labels are inferred for resource values which are not expanded into nested tables. They will usually take the value of one of the resource’s standard label properties, such as rdfs:label or skos:prefLabel. In that case, the label element will also have the short name of that property as a style class.

    Literal Nodes

    Literal property values are usually rendered in their textual form in a literal-value element. However, annotated literal values, such as lang-strings or typed literals, will be rendered in multiple parts.

    Such nodes are rendered using the following style classes:

    Class Usage
    literal-node The container of the literal node’s value and annotations.
    literal-value The textual form of the literal.
    literal-suffix The generic element which displays an annotation for a literal value.
    language-tag A language tag.
    type-tag A data type annotation.

    Blank Nodes

    When a result item contains a blank node, if that node has any properties, and it would not exceed the maximum nesting depth, it will be rendered as a nested table. Otherwise, it will be rendered as placeholder text, in an element with the blank-node style class.

    Error Page

    API endpoints can return errors if there is a problem with the application configuration or the user makes an invalid request. In that case, a specific error page template will be rendered using the usual layout.

    The error page uses the following style classes:

    Class Usage
    error-attribute One of the attributes of the error (eg. status code).
    error-status The status code of the error.
    error-error The label for the status code.
    error-message A description of the error.