di-api-ms2.json

{"apiVersion":"2.4-SNAPSHOT","apis":[{"description":"publishConnectionChangeEvent","operations":[{"method":"POST","summary":"Publish a change of the gateway connection state","notes":"publishConnectionChangeEvent","nickname":"publishConnectionChangeEvent","produces":["*/*"],"consumes":["application/json"],"parameters":[{"allowMultiple":false,"defaultValue":"","description":"connectionState","name":"body","paramType":"body","type":"ConnectionStateChangeEventJson","required":false}],"responseMessages":[{"code":200,"message":null,"responseModel":"ResultJson"}],"deprecated":"false","type":"ResultJson"}],"path":"/deviceManagement/connectionState"},{"description":"getGateway","operations":[{"method":"GET","summary":"Get gateway attributes by the specified deviceId","notes":"getGateway","nickname":"getGateway","produces":["*/*"],"consumes":["application/json"],"parameters":[{"allowMultiple":false,"defaultValue":"","description":"A unique identifier of a gateway","name":"deviceId","paramType":"path","type":"string","required":true}],"responseMessages":[{"code":200,"message":null,"responseModel":"GatewayJson"}],"deprecated":"false","type":"GatewayJson"}],"path":"/deviceManagement/gateways/{deviceId}"},{"description":"createNewOpenVPNCertificate","operations":[{"method":"POST","summary":"Request new Gateway OpenVPN Certificate","notes":"createNewOpenVPNCertificate","nickname":"createNewOpenVPNCertificate","produces":["*/*"],"consumes":["application/json"],"parameters":[{"allowMultiple":false,"defaultValue":"","description":"createCertificateJson","name":"body","paramType":"body","type":"CreateCertificateJson","required":false}],"responseMessages":[{"code":200,"message":null,"responseModel":"CertificateJson"}],"deprecated":"false","type":"CertificateJson"}],"path":"/deviceManagement/gateways/{deviceId}/certificates/openVPNCertificate"},{"description":"getGatewayOpenVPNCertificate","operations":[{"method":"GET","summary":"Get gateway OpenVPN Certificate","notes":"getGatewayOpenVPNCertificate","nickname":"getGatewayOpenVPNCertificate","produces":["*/*"],"consumes":["application/json"],"parameters":[{"allowMultiple":false,"defaultValue":"","description":"A unique identifier of a gateway","name":"deviceId","paramType":"path","type":"string","required":true}],"responseMessages":[{"code":200,"message":null,"responseModel":"CertificateJson"}],"deprecated":"false","type":"CertificateJson"}],"path":"/deviceManagement/gateways/{deviceId}/certificates/openVPNCertificate"},{"description":"invalidateOpenVPNCertificate","operations":[{"method":"DELETE","summary":"Invalidate Gateway OpenVPN Certificate","notes":"invalidateOpenVPNCertificate","nickname":"invalidateOpenVPNCertificate","produces":["*/*"],"consumes":["application/json"],"parameters":[{"allowMultiple":false,"defaultValue":"","description":"deviceId","name":"deviceId","paramType":"path","type":"string","required":true}],"responseMessages":[{"code":200,"message":null,"responseModel":"ResultJson"}],"deprecated":"false","type":"ResultJson"}],"path":"/deviceManagement/gateways/{deviceId}/certificates/openVPNCertificate"},{"description":"invalidateProSystCertificate","operations":[{"method":"DELETE","summary":"Request new Gateway ProSyst Certificate","notes":"invalidateProSystCertificate","nickname":"invalidateProSystCertificate","produces":["*/*"],"consumes":["application/json"],"parameters":[{"allowMultiple":false,"defaultValue":"","description":"deviceId","name":"deviceId","paramType":"path","type":"string","required":true}],"responseMessages":[{"code":200,"message":null,"responseModel":"ResultJson"}],"deprecated":"false","type":"ResultJson"}],"path":"/deviceManagement/gateways/{deviceId}/certificates/proSystCertificate"},{"description":"createNewProSystCertificate","operations":[{"method":"POST","summary":"Invalidate Gateway ProSyst Certificate","notes":"createNewProSystCertificate","nickname":"createNewProSystCertificate","produces":["*/*"],"consumes":["application/json"],"parameters":[{"allowMultiple":false,"defaultValue":"","description":"createCertificateJson","name":"body","paramType":"body","type":"CreateCertificateJson","required":false}],"responseMessages":[{"code":200,"message":null,"responseModel":"CertificateJson"}],"deprecated":"false","type":"CertificateJson"}],"path":"/deviceManagement/gateways/{deviceId}/certificates/proSystCertificate"},{"description":"publishCertificateRenewalRequiredEvent","operations":[{"method":"POST","summary":"Request sending of user notification event that certificates must be renewed but cannot be renewed because gateway is offline.","notes":"publishCertificateRenewalRequiredEvent","nickname":"publishCertificateRenewalRequiredEvent","produces":["*/*"],"consumes":["application/json"],"parameters":[{"allowMultiple":false,"defaultValue":"","description":"deviceId","name":"body","paramType":"body","type":"string","required":false}],"responseMessages":[{"code":200,"message":null,"responseModel":"ResultJson"}],"deprecated":"false","type":"ResultJson"}],"path":"/deviceManagement/gateways/{deviceId}/notifications/certificateRenewalRequired"},{"description":"publishCertificateRenewalSuccessEvent","operations":[{"method":"POST","summary":"Request sending of user notification event that certificates have been successfully updated.","notes":"publishCertificateRenewalSuccessEvent","nickname":"publishCertificateRenewalSuccessEvent","produces":["*/*"],"consumes":["application/json"],"parameters":[{"allowMultiple":false,"defaultValue":"","description":"deviceId","name":"body","paramType":"body","type":"string","required":false}],"responseMessages":[{"code":200,"message":null,"responseModel":"ResultJson"}],"deprecated":"false","type":"ResultJson"}],"path":"/deviceManagement/gateways/{deviceId}/notifications/certificateRenewalSuccessful"},{"description":"getGatewaySSHKey","operations":[{"method":"GET","summary":"Get gateway SSHKey","notes":"getGatewaySSHKey","nickname":"getGatewaySSHKey","produces":["*/*"],"consumes":["application/json"],"parameters":[{"allowMultiple":false,"defaultValue":"","description":"A unique identifier of a gateway","name":"deviceId","paramType":"path","type":"string","required":true}],"responseMessages":[{"code":200,"message":null,"responseModel":"SSHKeyJson"}],"deprecated":"false","type":"SSHKeyJson"}],"path":"/deviceManagement/gateways/{deviceId}/privateSSHKey"}],"basePath":"/api","consumes":["application/json"],"models":{"GatewayJson":{"description":"","id":"GatewayJson","properties":{"deviceid":{"description":"A unique identifier of a gateway","required":true,"type":"string"},"gatewayName":{"description":"A display name for a gateway","required":true,"type":"string"},"locationName":{"description":"Name of the gateway location or null","required":true,"type":"string"},"isActive":{"description":"Whether the gateway is in operation (=true) or not (=false)","required":true,"type":"boolean"},"businessUnitNames":{"description":"Name of business units that are related to the gateway","items":{"type":"string"},"required":true,"type":"array","uniqueItems":true}}},"SSHKeyJson":{"description":"","id":"SSHKeyJson","properties":{"deviceId":{"description":"A unique identifier of a gateway","required":true,"type":"string"},"privateKey":{"description":"The private Key","required":true,"type":"string"}}},"CertificateJson":{"description":"","id":"CertificateJson","properties":{"deviceId":{"description":"A unique identifier of a gateway","required":true,"type":"string"},"certificateString":{"description":"The certificate","required":true,"type":"string"}}},"ResultJson":{"description":"","id":"ResultJson","properties":{"status":{"enum":["ok","error"],"description":"","required":true,"type":"string"},"message":{"description":"Contains the cause in case of an error","required":false,"type":"string"},"translatedMessage":{"description":"Contains the translation in case of an error or the translation key if no translation is present","required":false,"type":"string"},"info":{"description":"Contains additional information in some cases of an error","required":false,"type":"object"}}},"ConnectionStateChangeEventJson":{"description":"","id":"ConnectionStateChangeEventJson","properties":{"deviceid":{"description":"A unique identifier of a gateway","required":true,"type":"string"},"isOnline":{"description":"Whether the status is online (=true) or not (=false)","required":true,"type":"boolean"}}},"CreateCertificateJson":{"description":"","id":"CreateCertificateJson","properties":{"deviceId":{"description":"A unique identifier of a gateway","required":true,"type":"string"},"cipherTypeName":{"description":"A name of the cipher as accepted by JSSE providers","required":true,"type":"string"}}}},"produces":["*/*"],"resourcePath":"/deviceManagement","swaggerVersion":"1.2"}