sdfobject-time.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "OMA/IPSO Time (Object ID 3333)",
    "version": "2022-02-22",
    "license": {
      "name": "BSD-3-Clause",
      "x-copyright": "Copyright 2019 Open Mobile Alliance."
    }
  },
  "schemes": [
    "http"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/Omaipsotimeobjectid3333ResURI": {
      "get": {
        "description": " This IPSO object is used to report the current time in seconds since January 1, 1970 UTC. There is also a fractional time counter that has a range of less than one second.",
        "parameters": [
          {
            "$ref": "#/parameters/interface"
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "schema": {
              "$ref": "#/definitions/Omaipsotimeobjectid3333"
            }
          }
        }
      }
    }
  },
  "parameters": {
    "interface": {
      "in": "query",
      "name": "if",
      "type": "string",
      "enum": [
        "oic.if.s",
        "oic.if.baseline"
      ]
    }
  },
  "definitions": {
    "Omaipsotimeobjectid3333": {
      "properties": {
        "rt": {
          "description": "The Resource Type.",
          "items": {
            "enum": [
              "oic.r.o.time"
            ],
            "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "n": {
          "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n"
        },
        "if": {
          "description": "The OCF Interface set supported by this Resource.",
          "items": {
            "enum": [
              "oic.if.s",
              "oic.if.baseline"
            ],
            "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "Current_Time": {
          "description": "Unix Time. A signed integer representing the number of seconds since Jan 1st, 1970 in the UTC time zone.",
          "x-label": "Current Time",
          "x-sdfType": "unix-time",
          "type": "number"
        },
        "Fractional_Time": {
          "description": "Fractional part of the time when sub-second precision is used (e.g., 0.23 for 230 ms).",
          "x-label": "Fractional Time",
          "maximum": 1,
          "minimum": 0,
          "type": "number",
          "x-unit": "s"
        },
        "Application_Type": {
          "description": "The application type of the sensor or actuator as a string depending on the use case.",
          "x-label": "Application Type",
          "type": "string"
        },
        "Measurement_Quality_Indicator": {
          "description": "Measurement quality indicator reported by a smart sensor. 0: UNCHECKED No quality checks were done because they do not exist or can not be applied. 1: REJECTED WITH CERTAINTY The measured value is invalid. 2: REJECTED WITH PROBABILITY The measured value is likely invalid. 3: ACCEPTED BUT SUSPICIOUS The measured value is likely OK. 4: ACCEPTED The measured value is OK. 5-15: Reserved for future extensions. 16-23: Vendor specific measurement quality.",
          "x-label": "Measurement Quality Indicator",
          "maximum": 23,
          "minimum": 0,
          "type": "integer",
          "readOnly": true
        },
        "Measurement_Quality_Level": {
          "description": "Measurement quality level reported by a smart sensor. Quality level 100 means that the measurement has fully passed quality check algorithms. Smaller quality levels mean that quality has decreased and the measurement has only partially passed quality check algorithms. The smaller the quality level, the more caution should be used by the application when using the measurement. When the quality level is 0 it means that the measurement should certainly be rejected.",
          "x-label": "Measurement Quality Level",
          "maximum": 100,
          "minimum": 0,
          "type": "integer",
          "readOnly": true
        }
      },
      "type": "object",
      "required": [
        "Current_Time"
      ]
    }
  }
}