Page tree
Skip to end of metadata
Go to start of metadata
{ "basePath": "/v2", "consumes": [ "application/json" ], "definitions": { "BadRequest": { "properties": { "errors": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error", "items": { "properties": { "code": { "description": "400", "type": "string" }, "message": { "description": "Bad Request", "type": "string" } }, "required": [ "message", "code" ], "type": "object" }, "type": "array" }, "message": { "description": "Bad Request", "type": "string" }, "status": { "description": "400", "type": "number" } }, "required": [ "message", "status", "errors" ], "type": "object" }, "ConnectWifiDefinition": { "properties": { "ESSID": { "description": "Network name, **Type:** Character String **Example:** Smartenit Network", "type": "string" }, "Interface": { "description": "This field could be empty, wlan0 will be use, **Type:** Character String **Example:** wlan5", "type": "string" }, "Password": { "description": "Password for the connection, **Type:** Character String **Example:** Smartenit123", "type": "string" } }, "type": "object" }, "ExecuteCommandDefinition": { "properties": { "Command": { "description": "Command to be executed, **Type:** Character String **Example:** ls", "type": "string" }, "Params": { "description": "Parameters for the command, **Type:** unknown", "type": "object" } }, "type": "object" }, "Forbidden": { "properties": { "errors": { "description": "The client does not have necessary permissions for the resource", "items": { "properties": { "code": { "description": "403", "type": "string" }, "message": { "description": "Forbidden", "type": "string" } }, "required": [ "message", "code" ], "type": "object" }, "type": "array" }, "message": { "description": "Forbidden", "type": "string" }, "status": { "description": "403", "type": "number" } }, "required": [ "message", "status", "errors" ], "type": "object" }, "LogMessageReportDefinition": { "properties": { "Message": { "description": "System message log, **Type:** Character String **Example:** Log system message", "type": "string" } }, "type": "object" }, "MethodNotAllowed": { "properties": { "errors": { "description": "A request was made of a resource using a request method not supported by that resource", "items": { "properties": { "code": { "description": "405", "type": "string" }, "message": { "description": "Method Not Allowed", "type": "string" } }, "required": [ "message", "code" ], "type": "object" }, "type": "array" }, "message": { "description": "Method Not Allowed", "type": "string" }, "status": { "description": "405", "type": "number" } }, "required": [ "message", "status", "errors" ], "type": "object" }, "NoContentResponse": { "properties": { "errors": { "description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain", "items": { "properties": { "code": { "description": "204", "type": "string" }, "message": { "description": "No Content", "type": "string" } }, "required": [ "message", "code" ], "type": "object" }, "type": "array" }, "message": { "description": "No Content", "type": "string" }, "status": { "description": "204", "type": "number" } }, "required": [ "message", "status", "errors" ], "type": "object" }, "NotFound": { "properties": { "errors": { "description": "The requested resource could not be found but may be available again in the future", "items": { "properties": { "code": { "description": "404", "type": "string" }, "message": { "description": "Not Found", "type": "string" } }, "required": [ "message", "code" ], "type": "object" }, "type": "array" }, "message": { "description": "Not Found", "type": "string" }, "status": { "description": "404", "type": "number" } }, "required": [ "message", "status", "errors" ], "type": "object" }, "RequestTimeout": { "properties": { "errors": { "description": "The server timed out waiting for the request", "items": { "properties": { "code": { "description": "408", "type": "string" }, "message": { "description": "Request Timeout", "type": "string" } }, "required": [ "message", "code" ], "type": "object" }, "type": "array" }, "message": { "description": "Request Timeout", "type": "string" }, "status": { "description": "408", "type": "number" } }, "required": [ "message", "status", "errors" ], "type": "object" }, "StartSupportSessionCommandDefinition": { "properties": { "Port": { "description": "Server port, set it to 22, **Type:** Unsigned 32-bit Integer **Example:** 2822", "type": "number" }, "ReversePort": { "description": "Specify an available port to reverse in the support server, **Type:** Unsigned 32-bit Integer **Example:** 2822", "type": "number" }, "Server": { "description": "Server Domain or IP address, **Type:** Character String **Example:** compacta.pointclark.net", "type": "string" }, "User": { "description": "User to connect to the Support server, **Type:** Character String **Example:** compacta", "type": "string" } }, "type": "object" }, "Unauthorized": { "properties": { "errors": { "description": "Authentication is required and has failed or has not yet been provided", "items": { "properties": { "code": { "description": "401", "type": "string" }, "message": { "description": "Unauthorized", "type": "string" } }, "required": [ "message", "code" ], "type": "object" }, "type": "array" }, "message": { "description": "Unauthorized", "type": "string" }, "status": { "description": "401", "type": "number" } }, "required": [ "message", "status", "errors" ], "type": "object" }, "UpgradeDefinition": { "properties": { "Channel": { "description": "Specify the upgrade channel, testing, staging or stable, empty will be set it to stable, **Type:** Character String **Example:** testing", "type": "string" } }, "type": "object" } }, "host": "api.smartenit.io", "info": { "description": "Provides an interface for controlling a characteristic of a device system like a gateway (Server Side).", "title": "SystemServer Processor", "version": "2.0.0" }, "paths": { "/devices/{id}/comps/{compid}/procs/SystemServer/attributes/LogActive": { "get": { "description": "Active log messages to be reported with LogMessageReport **Example:** true, **Mandatory/Optional:** Mandatory, **Type:** Boolean", "parameters": [ { "description": "Unique identifier for the Device", "in": "path", "name": "id", "required": true, "type": "string" }, { "description": "Unique identifier for the Device component", "in": "path", "name": "compid", "required": true, "type": "number" } ], "responses": { "204": { "description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain", "schema": { "$ref": "#/definitions/NoContentResponse" } }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error", "schema": { "$ref": "#/definitions/BadRequest" } }, "401": { "description": "Authentication is required and has failed or has not yet been provided", "schema": { "$ref": "#/definitions/Unauthorized" } }, "403": { "description": "The client does not have necessary permissions for the resource", "schema": { "$ref": "#/definitions/Forbidden" } }, "404": { "description": "The requested resource could not be found but may be available again in the future", "schema": { "$ref": "#/definitions/NotFound" } }, "405": { "description": "A request was made of a resource using a request method not supported by that resource", "schema": { "$ref": "#/definitions/MethodNotAllowed" } }, "408": { "description": "The server timed out waiting for the request", "schema": { "$ref": "#/definitions/RequestTimeout" } } }, "security": [ { "OAuth2": [] } ], "summary": "Read Attribute 'OnTransitionTime'", "tags": [ "SystemServer" ] }, "put": { "description": "Active log messages to be reported with LogMessageReport **Example:** true, **Mandatory/Optional:** Mandatory, **Type:** Boolean", "parameters": [ { "description": "Unique identifier for the Device", "in": "path", "name": "id", "required": true, "type": "string" }, { "description": "Unique identifier for the Device component", "in": "path", "name": "compid", "required": true, "type": "number" } ], "responses": { "204": { "description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain", "schema": { "$ref": "#/definitions/NoContentResponse" } }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error", "schema": { "$ref": "#/definitions/BadRequest" } }, "401": { "description": "Authentication is required and has failed or has not yet been provided", "schema": { "$ref": "#/definitions/Unauthorized" } }, "403": { "description": "The client does not have necessary permissions for the resource", "schema": { "$ref": "#/definitions/Forbidden" } }, "404": { "description": "The requested resource could not be found but may be available again in the future", "schema": { "$ref": "#/definitions/NotFound" } }, "405": { "description": "A request was made of a resource using a request method not supported by that resource", "schema": { "$ref": "#/definitions/MethodNotAllowed" } }, "408": { "description": "The server timed out waiting for the request", "schema": { "$ref": "#/definitions/RequestTimeout" } } }, "security": [ { "OAuth2": [] } ], "summary": "Update Attribute 'OnTransitionTime'", "tags": [ "SystemServer" ] } }, "/devices/{id}/comps/{compid}/procs/SystemServer/methods/ConnectWifi": { "post": { "description": "System method to connect to a wifi network **Mandatory/Optional:** Optional", "parameters": [ { "description": "Parameters Data", "in": "body", "name": "Data", "required": true, "schema": { "$ref": "#/definitions/ConnectWifiDefinition" } }, { "description": "Unique identifier for the Device", "in": "path", "name": "id", "required": true, "type": "string" }, { "description": "Unique identifier for the Device component", "in": "path", "name": "compid", "required": true, "type": "number" } ], "responses": { "204": { "description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain", "schema": { "$ref": "#/definitions/NoContentResponse" } }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error", "schema": { "$ref": "#/definitions/BadRequest" } }, "401": { "description": "Authentication is required and has failed or has not yet been provided", "schema": { "$ref": "#/definitions/Unauthorized" } }, "403": { "description": "The client does not have necessary permissions for the resource", "schema": { "$ref": "#/definitions/Forbidden" } }, "404": { "description": "The requested resource could not be found but may be available again in the future", "schema": { "$ref": "#/definitions/NotFound" } }, "405": { "description": "A request was made of a resource using a request method not supported by that resource", "schema": { "$ref": "#/definitions/MethodNotAllowed" } }, "408": { "description": "The server timed out waiting for the request", "schema": { "$ref": "#/definitions/RequestTimeout" } } }, "security": [ { "OAuth2": [] } ], "summary": "Method 'ConnectWifi'", "tags": [ "SystemServer" ] } }, "/devices/{id}/comps/{compid}/procs/SystemServer/methods/ExecuteCommand": { "post": { "description": "Execute a command **Mandatory/Optional:** Optional", "parameters": [ { "description": "Parameters Data", "in": "body", "name": "Data", "required": true, "schema": { "$ref": "#/definitions/ExecuteCommandDefinition" } }, { "description": "Unique identifier for the Device", "in": "path", "name": "id", "required": true, "type": "string" }, { "description": "Unique identifier for the Device component", "in": "path", "name": "compid", "required": true, "type": "number" } ], "responses": { "204": { "description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain", "schema": { "$ref": "#/definitions/NoContentResponse" } }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error", "schema": { "$ref": "#/definitions/BadRequest" } }, "401": { "description": "Authentication is required and has failed or has not yet been provided", "schema": { "$ref": "#/definitions/Unauthorized" } }, "403": { "description": "The client does not have necessary permissions for the resource", "schema": { "$ref": "#/definitions/Forbidden" } }, "404": { "description": "The requested resource could not be found but may be available again in the future", "schema": { "$ref": "#/definitions/NotFound" } }, "405": { "description": "A request was made of a resource using a request method not supported by that resource", "schema": { "$ref": "#/definitions/MethodNotAllowed" } }, "408": { "description": "The server timed out waiting for the request", "schema": { "$ref": "#/definitions/RequestTimeout" } } }, "security": [ { "OAuth2": [] } ], "summary": "Method 'ExecuteCommand'", "tags": [ "SystemServer" ] } }, "/devices/{id}/comps/{compid}/procs/SystemServer/methods/LogMessageReport": { "post": { "description": "Log message **Mandatory/Optional:** Optional", "parameters": [ { "description": "Parameters Data", "in": "body", "name": "Data", "required": true, "schema": { "$ref": "#/definitions/LogMessageReportDefinition" } }, { "description": "Unique identifier for the Device", "in": "path", "name": "id", "required": true, "type": "string" }, { "description": "Unique identifier for the Device component", "in": "path", "name": "compid", "required": true, "type": "number" } ], "responses": { "204": { "description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain", "schema": { "$ref": "#/definitions/NoContentResponse" } }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error", "schema": { "$ref": "#/definitions/BadRequest" } }, "401": { "description": "Authentication is required and has failed or has not yet been provided", "schema": { "$ref": "#/definitions/Unauthorized" } }, "403": { "description": "The client does not have necessary permissions for the resource", "schema": { "$ref": "#/definitions/Forbidden" } }, "404": { "description": "The requested resource could not be found but may be available again in the future", "schema": { "$ref": "#/definitions/NotFound" } }, "405": { "description": "A request was made of a resource using a request method not supported by that resource", "schema": { "$ref": "#/definitions/MethodNotAllowed" } }, "408": { "description": "The server timed out waiting for the request", "schema": { "$ref": "#/definitions/RequestTimeout" } } }, "security": [ { "OAuth2": [] } ], "summary": "Method 'LogMessageReport'", "tags": [ "SystemServer" ] } }, "/devices/{id}/comps/{compid}/procs/SystemServer/methods/Ping": { "post": { "description": "System method Ping the service **Mandatory/Optional:** Optional", "parameters": [ { "description": "Unique identifier for the Device", "in": "path", "name": "id", "required": true, "type": "string" }, { "description": "Unique identifier for the Device component", "in": "path", "name": "compid", "required": true, "type": "number" } ], "responses": { "204": { "description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain", "schema": { "$ref": "#/definitions/NoContentResponse" } }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error", "schema": { "$ref": "#/definitions/BadRequest" } }, "401": { "description": "Authentication is required and has failed or has not yet been provided", "schema": { "$ref": "#/definitions/Unauthorized" } }, "403": { "description": "The client does not have necessary permissions for the resource", "schema": { "$ref": "#/definitions/Forbidden" } }, "404": { "description": "The requested resource could not be found but may be available again in the future", "schema": { "$ref": "#/definitions/NotFound" } }, "405": { "description": "A request was made of a resource using a request method not supported by that resource", "schema": { "$ref": "#/definitions/MethodNotAllowed" } }, "408": { "description": "The server timed out waiting for the request", "schema": { "$ref": "#/definitions/RequestTimeout" } } }, "security": [ { "OAuth2": [] } ], "summary": "Method 'Ping'", "tags": [ "SystemServer" ] } }, "/devices/{id}/comps/{compid}/procs/SystemServer/methods/ScanWifi": { "post": { "description": "System method to scan wifi networks **Mandatory/Optional:** Optional", "parameters": [ { "description": "Unique identifier for the Device", "in": "path", "name": "id", "required": true, "type": "string" }, { "description": "Unique identifier for the Device component", "in": "path", "name": "compid", "required": true, "type": "number" } ], "responses": { "204": { "description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain", "schema": { "$ref": "#/definitions/NoContentResponse" } }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error", "schema": { "$ref": "#/definitions/BadRequest" } }, "401": { "description": "Authentication is required and has failed or has not yet been provided", "schema": { "$ref": "#/definitions/Unauthorized" } }, "403": { "description": "The client does not have necessary permissions for the resource", "schema": { "$ref": "#/definitions/Forbidden" } }, "404": { "description": "The requested resource could not be found but may be available again in the future", "schema": { "$ref": "#/definitions/NotFound" } }, "405": { "description": "A request was made of a resource using a request method not supported by that resource", "schema": { "$ref": "#/definitions/MethodNotAllowed" } }, "408": { "description": "The server timed out waiting for the request", "schema": { "$ref": "#/definitions/RequestTimeout" } } }, "security": [ { "OAuth2": [] } ], "summary": "Method 'ScanWifi'", "tags": [ "SystemServer" ] } }, "/devices/{id}/comps/{compid}/procs/SystemServer/methods/StartSupportSessionCommand": { "post": { "description": "Start a support session **Mandatory/Optional:** Optional", "parameters": [ { "description": "Parameters Data", "in": "body", "name": "Data", "required": true, "schema": { "$ref": "#/definitions/StartSupportSessionCommandDefinition" } }, { "description": "Unique identifier for the Device", "in": "path", "name": "id", "required": true, "type": "string" }, { "description": "Unique identifier for the Device component", "in": "path", "name": "compid", "required": true, "type": "number" } ], "responses": { "204": { "description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain", "schema": { "$ref": "#/definitions/NoContentResponse" } }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error", "schema": { "$ref": "#/definitions/BadRequest" } }, "401": { "description": "Authentication is required and has failed or has not yet been provided", "schema": { "$ref": "#/definitions/Unauthorized" } }, "403": { "description": "The client does not have necessary permissions for the resource", "schema": { "$ref": "#/definitions/Forbidden" } }, "404": { "description": "The requested resource could not be found but may be available again in the future", "schema": { "$ref": "#/definitions/NotFound" } }, "405": { "description": "A request was made of a resource using a request method not supported by that resource", "schema": { "$ref": "#/definitions/MethodNotAllowed" } }, "408": { "description": "The server timed out waiting for the request", "schema": { "$ref": "#/definitions/RequestTimeout" } } }, "security": [ { "OAuth2": [] } ], "summary": "Method 'StartSupportSessionCommand'", "tags": [ "SystemServer" ] } }, "/devices/{id}/comps/{compid}/procs/SystemServer/methods/Upgrade": { "post": { "description": "System method to check for available updated and get them **Mandatory/Optional:** Optional", "parameters": [ { "description": "Parameters Data", "in": "body", "name": "Data", "required": true, "schema": { "$ref": "#/definitions/UpgradeDefinition" } }, { "description": "Unique identifier for the Device", "in": "path", "name": "id", "required": true, "type": "string" }, { "description": "Unique identifier for the Device component", "in": "path", "name": "compid", "required": true, "type": "number" } ], "responses": { "204": { "description": "The server successfully processed the request but is not returning any content. This response can be received from CORS when using a javascript client from a different domain", "schema": { "$ref": "#/definitions/NoContentResponse" } }, "400": { "description": "The server cannot or will not process the request due to something that is perceived to be a client error", "schema": { "$ref": "#/definitions/BadRequest" } }, "401": { "description": "Authentication is required and has failed or has not yet been provided", "schema": { "$ref": "#/definitions/Unauthorized" } }, "403": { "description": "The client does not have necessary permissions for the resource", "schema": { "$ref": "#/definitions/Forbidden" } }, "404": { "description": "The requested resource could not be found but may be available again in the future", "schema": { "$ref": "#/definitions/NotFound" } }, "405": { "description": "A request was made of a resource using a request method not supported by that resource", "schema": { "$ref": "#/definitions/MethodNotAllowed" } }, "408": { "description": "The server timed out waiting for the request", "schema": { "$ref": "#/definitions/RequestTimeout" } } }, "security": [ { "OAuth2": [] } ], "summary": "Method 'Upgrade'", "tags": [ "SystemServer" ] } } }, "produces": [ "application/json" ], "schemes": [ "https" ], "securityDefinitions": { "OAuth2": { "flow": "password", "scopes": {}, "tokenUrl": "https://api.smartenit.io/v2/oauth2/token", "type": "oauth2" } }, "swagger": "2.0", "tags": [ { "name": "SystemServer" } ] }
  • No labels