CircuitBreakerResURI.swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Circuit Breaker (IEC 61850)",
    "version": "2019-06-13",
    "license": {
      "name": "OCF Data Model License",
      "url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md",
      "x-copyright": "copyright 2019 Open Connectivity Foundation, Inc. All rights reserved."
    },
    "termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md"
  },
  "schemes": ["http"],
  "consumes": ["application/json"],
  "produces": ["application/json"],
  "paths": {
    "/CircuitBreakerResURI" : {
      "get": {
        "description": "This Resource describes functions for the control and monitoring of IEC 61850 based circuit breaker.",
        "parameters": [
          {"$ref": "#/parameters/interface"}
        ],
        "responses": {
            "200": {
              "description" : "",
              "x-example":
                {
                  "rt": ["oic.r.circuitbreaker"],
                  "if": ["oic.if.s", "oic.if.baseline"],
                  "status": "on",
                  "ratedcurrent": 10.0,
                  "ratedbreakingcurrent": 2500.0,
                  "ratedvoltage": 460.0,
                  "leakagecurrent": 0.5,
                  "insulationresistance": 0.3,
                  "timestamp": "2015-11-05T14:30:00.10Z"
                },
              "schema": { "$ref": "#/definitions/CircuitBreaker" }
            }
        }
      }
    }
  },
  "parameters": {
    "interface" : {
      "in": "query",
      "name": "if",
      "type": "string",
      "enum": ["oic.if.s", "oic.if.baseline"]
    }
  },
  "definitions": {
    "CircuitBreaker" : {
      "properties": {
        "rt" : {
          "description": "The Resource Type",
          "items": {
              "enum": ["oic.r.circuitbreaker"],
              "maxLength": 64,
              "type": "string"
          },
          "minItems": 1,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        },
        "status" : {
          "description": "The circuit breaker status. The status can only be reset out of bounds.",
          "readOnly": true,
          "type": "string",
          "enum" : [ "on", "off", "trip"]
        },
        "ratedcurrent" : {
          "description": "The rated current in Ampere, defined at manufacturing time.",
          "readOnly": true,
          "type": "number"
        },
        "ratedbreakingcurrent" : {
          "description": "The rated breaking current in Ampere, defined at manufacturing time.",
          "readOnly": true,
          "type": "number"
        },
        "ratedvoltage" : {
          "description": "The rated voltage in Volts, defined at manufacturing time.",
          "readOnly": true,
          "type": "number"
        },        
        "leakagecurrent" : {
          "description": "The leakage current in mA.",
          "readOnly": true,
          "type": "number"
        },
        "insulationresistance" : {
          "description": "Insulation resistance of circuit breaker (M Ohm).",
          "readOnly": true,
          "type": "number"
        },
        "timestamp": {
          "description": "An RFC3339 formatted time indicating when the data was observed (e.g.: 2016-02-15T09:19Z, 1996-12-19T16:39:57-08:00). Note that 1/100 time resolution should be used.",
          "format": "date-time",
          "readOnly": true,
          "type": "string"
        },
        "n": {
          "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n"
        },
        "id": {
          "$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id"
        },
        "if": {
          "description": "The OCF Interface set supported by this Resource.",
          "items": {
            "enum": [
              "oic.if.s",
              "oic.if.baseline"
            ],
            "type": "string"
          },
          "minItems": 2,
          "uniqueItems": true,
          "readOnly": true,
          "type": "array"
        }
      },
      "type": "object",
      "required": ["status", "ratedcurrent", "ratedbreakingcurrent", "ratedvoltage", "timestamp"]
    }
  }
}