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" }, "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" }, "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" }, "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" } }, "host": "api.smartenit.io", "info": { "description": "", "title": "TimeServer Processor", "version": "2.0.0" }, "paths": { "/devices/{id}/comps/{compid}/procs/TimeServer/attributes/DateISO": { "get": { "description": "Attribute 'DateTimeISO' **Example:** 2012-04-23, **Mandatory/Optional:** Mandatory, **Type:** Character String", "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 'DateTimeISO'", "tags": [ "TimeServer" ] } }, "/devices/{id}/comps/{compid}/procs/TimeServer/attributes/DateTimeISO": { "get": { "description": "Attribute 'DateTimeISO' **Example:** 2012-04-23T18:25:43.511Z, **Mandatory/Optional:** Mandatory, **Type:** Character String", "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 'DateTimeISO'", "tags": [ "TimeServer" ] } }, "/devices/{id}/comps/{compid}/procs/TimeServer/attributes/DstEnd": { "get": { "description": "Represents the current level of the device. **Example:** 1473891553, **Range:** Min: 0 Max: 0xFFFFFFFF, **Mandatory/Optional:** Optional, **Type:** Unsigned 32-bit Integer", "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 'DstEnd'", "tags": [ "TimeServer" ] }, "put": { "description": "Represents the current level of the device. **Example:** 1473891553, **Range:** Min: 0 Max: 0xFFFFFFFF, **Mandatory/Optional:** Optional, **Type:** Unsigned 32-bit Integer", "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 'DstEnd'", "tags": [ "TimeServer" ] } }, "/devices/{id}/comps/{compid}/procs/TimeServer/attributes/DstShift": { "get": { "description": "Represents the current level of the device. **Example:** 1473891553, **Range:** Min: 0 Max: 0xFFFFFFFF, **Mandatory/Optional:** Optional, **Type:** 32-bit Integer", "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 'DstShift'", "tags": [ "TimeServer" ] }, "put": { "description": "Represents the current level of the device. **Example:** 1473891553, **Range:** Min: 0 Max: 0xFFFFFFFF, **Mandatory/Optional:** Optional, **Type:** 32-bit Integer", "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 'DstShift'", "tags": [ "TimeServer" ] } }, "/devices/{id}/comps/{compid}/procs/TimeServer/attributes/DstStart": { "get": { "description": "Represents the current level of the device. **Example:** 1473891553, **Range:** Min: 0 Max: 0xFFFFFFFF, **Mandatory/Optional:** Optional, **Type:** Unsigned 32-bit Integer", "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 'DstStart'", "tags": [ "TimeServer" ] }, "put": { "description": "Represents the current level of the device. **Example:** 1473891553, **Range:** Min: 0 Max: 0xFFFFFFFF, **Mandatory/Optional:** Optional, **Type:** Unsigned 32-bit Integer", "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 'DstStart'", "tags": [ "TimeServer" ] } }, "/devices/{id}/comps/{compid}/procs/TimeServer/attributes/LastSetTime": { "get": { "description": "Represents the current level of the device. **Example:** 1473891553, **Range:** Min: 0, Max: 0xFFFFFFFF, **Mandatory/Optional:** Optional, **Type:** String UTC Time", "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 'LastSetTime'", "tags": [ "TimeServer" ] } }, "/devices/{id}/comps/{compid}/procs/TimeServer/attributes/LocalTime": { "get": { "description": "Represents the current level of the device. **Example:** 1473891553, **Range:** Min: 0, Max: 0xFFFFFFFF, **Mandatory/Optional:** Optional, **Type:** Unsigned 32-bit Integer", "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 'LastSetTime'", "tags": [ "TimeServer" ] } }, "/devices/{id}/comps/{compid}/procs/TimeServer/attributes/StandardTime": { "get": { "description": "Represents the current level of the device. **Example:** 1473891553, **Range:** Min: 0, Max: 0xFFFFFFFF, **Mandatory/Optional:** Optional, **Type:** Unsigned 32-bit Integer", "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 'LastSetTime'", "tags": [ "TimeServer" ] } }, "/devices/{id}/comps/{compid}/procs/TimeServer/attributes/Time": { "get": { "description": "Represents the current level of the device. **Example:** 1473891553, **Range:** Min: 0 Max: 0xFFFFFFFF, **Mandatory/Optional:** Mandatory, **Type:** String UTC Time", "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 'Time'", "tags": [ "TimeServer" ] }, "put": { "description": "Represents the current level of the device. **Example:** 1473891553, **Range:** Min: 0 Max: 0xFFFFFFFF, **Mandatory/Optional:** Mandatory, **Type:** String UTC Time", "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 'Time'", "tags": [ "TimeServer" ] } }, "/devices/{id}/comps/{compid}/procs/TimeServer/attributes/TimeISO": { "get": { "description": "Attribute 'DateTimeISO' **Example:** 23:07:44.342, **Mandatory/Optional:** Mandatory, **Type:** Character String", "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 'DateTimeISO'", "tags": [ "TimeServer" ] } }, "/devices/{id}/comps/{compid}/procs/TimeServer/attributes/TimeStatus": { "get": { "description": "Represents the current level of the device. **Example:** 1473891553, **Range:** Min: 0 Max: 0xFFFFFFFF, **Mandatory/Optional:** Mandatory, **Type:** 8-bit Bitmap", "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 'TimeStatus'", "tags": [ "TimeServer" ] }, "put": { "description": "Represents the current level of the device. **Example:** 1473891553, **Range:** Min: 0 Max: 0xFFFFFFFF, **Mandatory/Optional:** Mandatory, **Type:** 8-bit Bitmap", "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 'TimeStatus'", "tags": [ "TimeServer" ] } }, "/devices/{id}/comps/{compid}/procs/TimeServer/attributes/TimeZone": { "get": { "description": "Represents the current level of the device. **Example:** 1473891553, **Range:** Min: -86400 Max: 86400, **Mandatory/Optional:** Optional, **Type:** 32-bit Integer", "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 'TimeZone'", "tags": [ "TimeServer" ] }, "put": { "description": "Represents the current level of the device. **Example:** 1473891553, **Range:** Min: -86400 Max: 86400, **Mandatory/Optional:** Optional, **Type:** 32-bit Integer", "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 'TimeZone'", "tags": [ "TimeServer" ] } }, "/devices/{id}/comps/{compid}/procs/TimeServer/attributes/TimeZoneCode": { "get": { "description": "Attribute 'TimeZoneCode' **Example:** America/Los Angeles, **Mandatory/Optional:** Mandatory, **Type:** Character String", "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 'TimeZoneCode'", "tags": [ "TimeServer" ] } }, "/devices/{id}/comps/{compid}/procs/TimeServer/attributes/UserSunriseTime": { "get": { "description": "Attribute 'UserSunriseTime' **Example:** 06:15:00, **Mandatory/Optional:** Mandatory, **Type:** Character String", "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 'UserSunriseTime'", "tags": [ "TimeServer" ] }, "put": { "description": "Attribute 'UserSunriseTime' **Example:** 06:15:00, **Mandatory/Optional:** Mandatory, **Type:** Character String", "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 'UserSunriseTime'", "tags": [ "TimeServer" ] } }, "/devices/{id}/comps/{compid}/procs/TimeServer/attributes/UserSunsetTime": { "get": { "description": "Attribute 'UserSunsetTime' **Example:** 18:10:00, **Mandatory/Optional:** Mandatory, **Type:** Character String", "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 'UserSunsetTime'", "tags": [ "TimeServer" ] }, "put": { "description": "Attribute 'UserSunsetTime' **Example:** 18:10:00, **Mandatory/Optional:** Mandatory, **Type:** Character String", "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 'UserSunsetTime'", "tags": [ "TimeServer" ] } }, "/devices/{id}/comps/{compid}/procs/TimeServer/attributes/UserTime": { "get": { "description": "Attribute 'UserTime', **Mandatory/Optional:** Mandatory, **Type:** Unsigned 32-bit Integer", "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 'UserTime'", "tags": [ "TimeServer" ] }, "put": { "description": "Attribute 'UserTime', **Mandatory/Optional:** Mandatory, **Type:** Unsigned 32-bit Integer", "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 'UserTime'", "tags": [ "TimeServer" ] } }, "/devices/{id}/comps/{compid}/procs/TimeServer/attributes/UserTimezoneCode": { "get": { "description": "Attribute 'UserTimezoneCode' **Example:** America/Los Angeles, **Mandatory/Optional:** Mandatory, **Type:** Character String", "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 'UserTimezoneCode'", "tags": [ "TimeServer" ] }, "put": { "description": "Attribute 'UserTimezoneCode' **Example:** America/Los Angeles, **Mandatory/Optional:** Mandatory, **Type:** Character String", "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 'UserTimezoneCode'", "tags": [ "TimeServer" ] } }, "/devices/{id}/comps/{compid}/procs/TimeServer/attributes/ValidUntilTime": { "get": { "description": "Represents the current level of the device. **Example:** 1473891553, **Range:** Min: 0 Max: 0xFFFFFFFF, **Mandatory/Optional:** Optional, **Type:** String UTC Time", "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 'ValidUntilTime'", "tags": [ "TimeServer" ] }, "put": { "description": "Represents the current level of the device. **Example:** 1473891553, **Range:** Min: 0 Max: 0xFFFFFFFF, **Mandatory/Optional:** Optional, **Type:** String UTC Time", "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 'ValidUntilTime'", "tags": [ "TimeServer" ] } } }, "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": "TimeServer" } ] }
  • No labels