Created
November 13, 2015 10:33
-
-
Save tkruse/4bc2b5806150541411da to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{"apiVersion":"1.0","swaggerVersion":"1.2","basePath":"/api","resourcePath":"/deviceManagement","apis":[{"path":"/deviceManagement/gateway/{businessKey}/connectionState","description":"publishConnectionChangeEvent","operations":[{"method":"POST","summary":"Publish a change of the gateway connection state","notes":"publishConnectionChangeEvent","type":"ResultJson","nickname":"publishConnectionChangeEvent","parameters":[{"name":"businessKey","description":"A unique identifier of a gateway","defaultValue":"","required":true,"type":"integer","format":"int64","paramType":"path","allowMultiple":false},{"name":"connectionState","description":"connectionState","defaultValue":"","required":false,"type":"ConnectionStateChangeEventJson","paramType":"body","allowMultiple":false}],"responseMessages":[{"code":200,"message":null,"responseModel":"ResultJson"}],"deprecated":"false"}]},{"path":"/deviceManagement/gateway/{businessKey}/vpnConnectionState","description":"publishVpnConnectionChangeEvent","operations":[{"method":"POST","summary":"Publish a change of the gateway VPN connection state","notes":"publishVpnConnectionChangeEvent","type":"ResultJson","nickname":"publishVpnConnectionChangeEvent","parameters":[{"name":"businessKey","description":"businessKey","defaultValue":"","required":true,"type":"integer","format":"int64","paramType":"path","allowMultiple":false},{"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","description":"getGateway","operations":[{"method":"GET","summary":"Get gateway attributes by the specified businessKey","notes":"getGateway","type":"GatewayJson","nickname":"getGateway","parameters":[{"name":"businessKey","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":["businessKey","locationName","isActive","businessUnitNames"],"extends":"","properties":{"businessKey":{"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":["businessKey","isOnline"],"extends":"","properties":{"businessKey":{"type":"string","description":"A unique identifier of a gateway"},"isOnline":{"type":"boolean","description":"Whether the status is online (=true) or not (=false)"}}}}} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment