Newcastle University · JSON Structure

Newcastle Timeseriesentry Structure

A historic entry associated with a timeseries and a time.

Type: object Properties: 6
EducationHigher EducationUniversityUnited KingdomOpen DataResearch DataSmart CitiesDigital Library

TimeseriesEntry is a JSON Structure definition published by Newcastle University, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

time duration value error message description

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://api-evangelist.com/newcastle/newcastle-timeseriesentry-structure.json",
  "name": "TimeseriesEntry",
  "type": "object",
  "description": "A historic entry associated with a timeseries and a time.",
  "properties": {
    "time": {
      "type": "string",
      "description": "Date and time associated with the historic value",
      "format": "date-time"
    },
    "duration": {
      "type": "number",
      "description": "The duration this value applies to, or if negative, the window of error in which the value change could have occurred."
    },
    "value": {
      "type": "any",
      "description": "The value associated with the time in the timeseries, unless the timeseries does not contain values (i.e. event only)."
    },
    "error": {
      "type": "boolean",
      "description": "Indication that an error occurred, and data could not be supplied."
    },
    "message": {
      "type": "string",
      "description": "Short description of why data could not be supplied."
    },
    "description": {
      "type": "string",
      "description": "Verbose description of why an error occurred and data could not be supplied."
    }
  }
}