di-api-ms1.json

{"apiVersion":"1.0","swaggerVersion":"1.2","basePath":"/api","resourcePath":"/deviceManagement","apis":[{"path":"/deviceManagement/connectionState","description":"publishConnectionChangeEvent","operations":[{"method":"POST","summary":"Publish a change of the gateway connection state","notes":"publishConnectionChangeEvent","type":"ResultJson","nickname":"publishConnectionChangeEvent","parameters":[{"name":"connectionState","description":"connectionState","defaultValue":"","required":false,"type":"ConnectionStateChangeEventJson","paramType":"body","allowMultiple":false}],"responseMessages":[{"code":200,"message":null,"responseModel":"ResultJson"}],"deprecated":"false"}]},{"path":"/deviceManagement/gateways/{deviceid}","description":"getGateway","operations":[{"method":"GET","summary":"Get gateway attributes by the specified deviceid","notes":"getGateway","type":"GatewayJson","nickname":"getGateway","parameters":[{"name":"deviceid","description":"A unique identifier of a gateway","defaultValue":"","required":true,"type":"string","paramType":"path","allowMultiple":false}],"responseMessages":[{"code":200,"message":null,"responseModel":"GatewayJson"}],"deprecated":"false"}]}],"models":{"GatewayJson":{"id":"GatewayJson","description":"","required":["deviceid","locationName","isActive","businessUnitNames"],"extends":"","properties":{"deviceid":{"type":"string","description":"A unique identifier of a gateway"},"locationName":{"type":"string","description":"Name of the gateway location"},"isActive":{"type":"boolean","description":"Whether the gateway is in operation (=true) or not (=false)"},"businessUnitNames":{"type":"array","description":"Name of business units that are related to the gateway","items":{"type":"string"}}}},"ResultJson":{"id":"ResultJson","description":"","required":["status"],"extends":"","properties":{"status":{"type":"string","description":"","enum":["ok","error"]},"message":{"type":"string","description":"Contains the cause in case of an error"},"translatedMessage":{"type":"string","description":"Contains the translation in case of an error or the translation key if no translation is present"},"info":{"$ref":"object","description":"Contains additional information in some cases of an error"}}},"ConnectionStateChangeEventJson":{"id":"ConnectionStateChangeEventJson","description":"","required":["deviceid","isOnline"],"extends":"","properties":{"deviceid":{"type":"string","description":"A unique identifier of a gateway"},"isOnline":{"type":"boolean","description":"Whether the status is online (=true) or not (=false)"}}}}}