prosyst-api-ms1.json

{"apiVersion":"1.0","swaggerVersion":"1.2","basePath":"/api","resourcePath":"/rs","apis":[{"path":"/rs/OSGiDeviceManagerWS/getOSGiDevice","description":"getConnectionState","operations":[{"method":"GET","summary":"Get the current connection state of the gateway specified by the deviceid","notes":"getConnectionState","type":"OsgiDeviceInfo","nickname":"getConnectionState","parameters":[{"name":"deviceId","description":"A unique identifier of a gateway","defaultValue":"","required":true,"type":"string","paramType":"body","allowMultiple":false}],"responseMessages":[{"code":200,"message":null,"responseModel":"OsgiDeviceInfo"}],"deprecated":"false"}]},{"path":"/rs/devices/invokeAction","description":"publishGatewayChangeEvent","operations":[{"method":"POST","summary":"Notification of changes of gateway attributes","notes":"publishGatewayChangeEvent","type":"ComplexValue","nickname":"publishGatewayChangeEvent","parameters":[{"name":"cuType","description":"Value: 'boschtt.vpngw'","defaultValue":"","required":true,"type":"string","paramType":"body","allowMultiple":false},{"name":"cuId","description":"dev: 'GatewayManager', production: '1'","defaultValue":"","required":true,"type":"string","paramType":"body","allowMultiple":false},{"name":"deviceId","description":"Gateway unique identifier","defaultValue":"","required":true,"type":"string","paramType":"body","allowMultiple":false},{"name":"deviceType","description":"Value: 'mprm.osgi.device'","defaultValue":"","required":true,"type":"string","paramType":"body","allowMultiple":false},{"name":"actionId","description":"???","defaultValue":"","required":true,"type":"string","paramType":"body","allowMultiple":false}],"responseMessages":[{"code":200,"message":null,"responseModel":"ComplexValue"}],"deprecated":"false"}]},{"path":"/rs/devices/queryStateVraible","description":"getVpnConnectionState","operations":[{"method":"GET","summary":"Get the current VPN connection state of the gateway specified by the deviceid","notes":"Retrieves a state variable value of a control unit instance. \"Vraible\" not a typo, spelling mistake will be fixed in Production (12/2015)","type":"ComplexValue","nickname":"getVpnConnectionState","parameters":[{"name":"stateVarId","description":"Should be 'openvpnConnectionState'","defaultValue":"","required":true,"type":"string","paramType":"path","allowMultiple":false},{"name":"cuidInfo","description":"cuidInfo","defaultValue":"","required":false,"type":"CUIDInfo","paramType":"body","allowMultiple":false}],"responseMessages":[{"code":200,"message":null,"responseModel":"ComplexValue"}],"deprecated":"false"}]}],"models":{"OsgiDeviceInfo":{"id":"OsgiDeviceInfo","description":"","required":["objectId","deviceID","status","deviceAddress","transport","lastOnlineTime"],"extends":"","properties":{"objectId":{"type":"string","description":"???"},"deviceID":{"type":"string","description":"A unique identifier of a gateway"},"status":{"type":"string","description":"Online or Offline"},"deviceAddress":{"type":"string","description":"???"},"transport":{"type":"string","description":"???"},"lastOnlineTime":{"type":"integer","format":"int64","description":"???"}}},"ComplexValue":{"id":"ComplexValue","description":"","extends":"","properties":{"primitive":{"$ref":"object","description":"???"},"list":{"type":"array","description":"???","items":{"type":"object"}},"map":{"$ref":"object","description":"???"}}},"CUIDInfo":{"id":"CUIDInfo","description":"","required":["controlUnitType","controlUnitId","deviceId","deviceType"],"extends":"","properties":{"controlUnitType":{"type":"string","description":"boschtt.vpngw"},"controlUnitId":{"type":"string","description":"dev: 'GatewayManager', production: '1'"},"deviceId":{"type":"string","description":"???"},"deviceType":{"type":"string","description":"mprm.osgi.device"}}}}}