{ "openapi" : "3.0.1", "info" : { "title" : "Janitza GridVis REST API", "description" : "This is the reference document for the REST API and resources provided by SERVICE/WEB. The REST APIs are for developers who\n want to integrate SERVICE/WEB with other standalone or web applications and for administrators who want to script interactions\n with the SERVICE/WEB server.\n## Additional information\n* [How to specify dates und times](/rest/doc/ex-doc.html#date-and-time) (e.g. energy/{value}/{type}?start=EUROPEAN_01.01.2022&end=NAMED_Today)\n* [Content negotiation (XML/JSON)](/rest/doc/ex-doc.html#content-negotiation)\n", "contact" : { "name" : "Janitza", "url" : "http://www.janitza.de", "email" : "support@janitz.de" }, "license" : { "name" : "Janitza GridVis license", "url" : "http://www.janitza.de" }, "version" : "1.0" }, "servers" : [ { "url" : "/rest/", "description" : "Running Server", "variables" : { } } ], "security" : [ { "basicAuth" : [ ] } ], "tags" : [ { "name" : "data", "description" : "Data of projects and devices", "externalDocs" : { "description" : "docs desc" } }, { "name" : "maintenance", "description" : "Maintenance", "externalDocs" : { "description" : "docs desc 2" } } ], "paths" : { "/1/deviceicon/{uniqueType}" : { "get" : { "tags" : [ "data" ], "summary" : "Provides the image corresponding to a specified device type.", "description" : "Provides the image corresponding to a specified device type.", "operationId" : "getImage", "parameters" : [ { "name" : "uniqueType", "in" : "path", "description" : "Unique device type name.", "required" : true, "schema" : { "type" : "string" }, "example" : "UMG604" }, { "name" : "size", "in" : "query", "description" : "Optional: size of the device image", "schema" : { "type" : "string", "description" : "var 1", "default" : "MEDIUM", "enum" : [ "SMALL", "MEDIUM", "LARGE", "EXTRA_LARGE" ] } } ], "responses" : { "200" : { "description" : "Returns an image for the specified device.", "content" : { "image/png" : { } } }, "404" : { "description" : "Bad request, e.g. no image found for device." } } } }, "/1/heapdump" : { "get" : { "tags" : [ "maintenance" ], "summary" : "Creates a heap dump file.", "description" : "Creates a Heap dump as a hprof file in user-dir.", "operationId" : "createHeapDump", "responses" : { "200" : { "description" : "Heap dump file successfully created", "content" : { "text/plain" : { } } } } } }, "/1/projects/{pname}" : { "get" : { "tags" : [ "data" ], "summary" : "Provides information about a specified (loaded) project.", "description" : "Provides information about a specified (loaded) project.", "operationId" : "get", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" } ], "responses" : { "200" : { "description" : "Returns a full representation of a project.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/ProjectEnt" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProjectEnt" } } } }, "404" : { "description" : "Project name not found." } } }, "delete" : { "tags" : [ "maintenance" ], "summary" : "Marks a project to prevent it from loading on the next server restart.", "description" : "Marks a project to prevent it from loading on the next server restart.", "operationId" : "deleteProject", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" } ], "responses" : { "204" : { "description" : "OK, removed on next restart.", "content" : { "application/xml" : { }, "application/json" : { } } }, "404" : { "description" : "Project name not found." }, "401" : { "description" : "You do not have the necessary permission, use basic auth." } } } }, "/1/projects/{pname}/devices" : { "get" : { "tags" : [ "data" ], "summary" : "Provides information about all devices of a specified project.", "description" : "Provides information about all devices of a specified project.", "operationId" : "getDevList", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "field", "in" : "query", "description" : "Specifies the fields to include in the device list response, allowing for a customized data set.", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "filter", "in" : "query", "description" : "Filter devices by their capabilities. Multiple filters are OR-chained", "schema" : { "type" : "string", "description" : "var 2", "enum" : [ "events", "transients" ] } } ], "responses" : { "200" : { "description" : "Returns a representation of all devices.", "content" : { "application/xml" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DeviceEnt" } } }, "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DeviceEnt" } } } } }, "404" : { "description" : "Project name not found." } } } }, "/1/projects" : { "get" : { "tags" : [ "data" ], "summary" : "Provides a list of all loaded projects.", "description" : "Provides a list of all loaded projects.", "operationId" : "getProjects", "responses" : { "200" : { "description" : "Returns a list of all loaded projects.", "content" : { "application/xml" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProjectEnt" } } }, "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProjectEnt" } } } } }, "204" : { "description" : "No content." } } }, "put" : { "tags" : [ "data" ], "summary" : "Load a project", "description" : "Load a project into the server.", "operationId" : "loadProject", "requestBody" : { "description" : "File path of the project on the server.", "content" : { "text/plain" : { "schema" : { "type" : "string" }, "examples" : { "path" : { "summary" : "example for windows", "description" : "path", "value" : "c:\\GridVisProjects\\Project A" } } } } }, "responses" : { "200" : { "description" : "The project was loaded successfully." }, "400" : { "description" : "The path could not be found or is not a gridvis project. Also licence may be missing." }, "401" : { "description" : "You do not have the necessary permission, use basic auth." } }, "security" : [ { "admin" : [ ] } ] } }, "/1/threaddump" : { "get" : { "tags" : [ "maintenance" ], "summary" : "Provides a thread dump.", "description" : "Provides a thread dump in the form of an XML-formatted string.", "operationId" : "getThreadDump", "responses" : { "200" : { "description" : "Returns a thread dump as an XML formatted String.", "content" : { "text/xml" : { } } } } } }, "/common/info/version/full" : { "get" : { "tags" : [ "data" ], "summary" : "Provides the current version of the server.", "description" : "Provides the current version of the server.", "operationId" : "getVersion", "responses" : { "200" : { "description" : "Returns the version string.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/NamedStringEnt" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/NamedStringEnt" } } } } } } }, "/common/info/language/test" : { "get" : { "tags" : [ "default" ], "summary" : "Test", "description" : "Test", "operationId" : "getLanguageTest", "responses" : { "default" : { "description" : "default response", "content" : { "application/xml" : { "schema" : { "type" : "string" } }, "application/json" : { "schema" : { "type" : "string" } } } } } } }, "/1/valuetypes" : { "get" : { "tags" : [ "data" ], "summary" : "Provides information about all available value types.", "description" : "Provides information about all available value types.", "operationId" : "getValueTypes", "responses" : { "200" : { "description" : "Returns a list of all value types.", "content" : { "application/xml" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ValueTypeEnt" } } }, "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ValueTypeEnt" } } } } } } } }, "/1/valuetypes/subtypes" : { "get" : { "tags" : [ "data" ], "summary" : "Provides all subtypes for /rest/valuetypes/{subtype}.", "description" : "Provides all subtypes for /rest/valuetypes/{subtype}.", "operationId" : "getAllSubtypes", "responses" : { "200" : { "description" : "Returns a list of all subtypes.", "content" : { "application/xml" : { }, "application/json" : { } } } } } }, "/1/valuetypes/{subtype}" : { "get" : { "tags" : [ "data" ], "summary" : "Provides a list of value types for a specific subtype.", "description" : "Provides a list of value types for a specific subtype.", "operationId" : "getSubtype", "parameters" : [ { "name" : "subtype", "in" : "path", "description" : "A subtype from the list /rest/valuetypes/subtypes", "required" : true, "schema" : { "type" : "string" }, "example" : "currentharmonicsrel" } ], "responses" : { "200" : { "description" : "Returns a list of all value type for the subtype.", "content" : { "application/xml" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ValueTypeEnt" } } }, "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ValueTypeEnt" } } } } }, "400" : { "description" : "Bad request, e.g. unknown type." } } } }, "/1/projects/{pname}/deviceicon/{devid}" : { "get" : { "tags" : [ "data" ], "summary" : "Provides the image associated with a specified device within a project.", "description" : "Provides the image associated with a specified device within a project.", "operationId" : "getImage_1", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 }, { "name" : "size", "in" : "query", "description" : "Optionally size of the device image (defaults to MEDIUM).", "schema" : { "type" : "string", "description" : "var 3", "default" : "MEDIUM", "enum" : [ "SMALL", "MEDIUM", "LARGE", "EXTRA_LARGE" ] } } ], "responses" : { "200" : { "description" : "Returns an image for the specified device.", "content" : { "image/png" : { } } }, "404" : { "description" : "Not Found. The requested API endpoint or resource could not be located on the server." } } } }, "/1/projects/{pname}/devices/{devid}/firmware" : { "get" : { "tags" : [ "data" ], "summary" : "Provides the firmware version of a specified device.", "description" : "Provides the firmware version of a specified device.", "operationId" : "getFirmware", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 } ], "responses" : { "200" : { "description" : "Provides the firmware version of the specified device.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/FirmwareEnt" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/FirmwareEnt" } } } }, "404" : { "description" : "Not Found. The requested API endpoint or resource could not be located on the server." } } } }, "/1/projects/{pname}/devices/{devid}/nominalValues" : { "get" : { "tags" : [ "data" ], "summary" : "Provides the nominal values of a specified device.", "description" : "Provides the nominal values of a specified device.", "operationId" : "getNominalValues", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 } ], "responses" : { "200" : { "description" : "Provides the nominal values of the specified device.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/NominalValuesEnt" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/NominalValuesEnt" } } } }, "404" : { "description" : "Not Found. The requested API endpoint or resource could not be located on the server." } } } }, "/1/projects/{pname}/devices/{devid}/measCircuitConnectionMode" : { "get" : { "tags" : [ "data" ], "summary" : "Provides the measurement circuit connection mode of a specified device.", "description" : "Provides the Current Connection Mode of a specified device.", "operationId" : "getCurrentConnectionMode", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 } ], "responses" : { "200" : { "description" : "Provides the measurement circuit connection mode of the specified device.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/MeasCircuitConnectionModeEnt" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/MeasCircuitConnectionModeEnt" } } } }, "404" : { "description" : "Not Found. The requested API endpoint or resource could not be located on the server." } } } }, "/1/projects/{pname}/devices/{devid}/connectiontest" : { "get" : { "tags" : [ "data" ], "summary" : "Runs a connection test.", "description" : "Runs a connection test.", "operationId" : "getConnectionTest", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 } ], "responses" : { "200" : { "description" : "Result of the connection test (failed / succeeded).", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/ConnectionTestEnt" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConnectionTestEnt" } } } }, "404" : { "description" : "Not Found. The requested API endpoint or resource could not be located on the server." } } } }, "/1/projects/{pname}/devices/{devid}" : { "get" : { "tags" : [ "data" ], "summary" : "Provides information about a specified device.", "description" : "Provides information about a specified device.", "operationId" : "getInfo", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 }, { "name" : "field", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "description" : "Returns a full representation of the specified device.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/DeviceEnt" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/DeviceEnt" } } } }, "404" : { "description" : "Not Found. The requested API endpoint or resource could not be located on the server." } } } }, "/1/projects/{pname}/devices/{devid}/histenergy" : { "get" : { "tags" : [ "data" ], "summary" : "Provides the energy consumption from a device within a specified timespan.", "description" : "Provides the energy usage data for a selected device, based on a specific value and type, over a defined period.

For information on supported timespan parameters, please refer to the documentation.", "operationId" : "getEnergyValue", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 }, { "name" : "value", "in" : "query", "description" : "A value name - check /hist/values for a list of all viable names

\"[\"U_Effective\"]\" gets parsed to \"U_Effective\".", "required" : true, "schema" : { "$ref" : "#/components/schemas/ValuesEnum" }, "example" : [ "U_Effective" ] }, { "name" : "type", "in" : "query", "description" : "A type, e.g. L1, L2, L3, L4, L5, L2L1, L3L2, L1L3, SUM13, SUM14 and others.", "required" : true, "schema" : { "type" : "string" }, "example" : "L1" }, { "name" : "timebase", "in" : "query", "description" : "Aggregation time interval, eg HOUR, DAY, WEEK, MONTH, QUARTER or YEAR", "schema" : { "type" : "integer", "format" : "int32" }, "example" : 900 }, { "name" : "start", "in" : "query", "description" : "Start time for the timespan filter", "required" : true, "schema" : { "type" : "string" }, "example" : "UTC_34235345" }, { "name" : "end", "in" : "query", "description" : "End time for the timespan filter", "required" : true, "schema" : { "type" : "string" }, "example" : "NAMED_Today" }, { "name" : "online", "in" : "query", "description" : "Whether the value was recorded online.", "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "Returns the sum of all found values.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/EnergyEnt" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/EnergyEnt" } } } }, "204" : { "description" : "No content for the requested timespan." }, "404" : { "description" : "Not Found. The requested API endpoint or resource could not be located on the server." } } } }, "/1/projects/{pname}/devices/{devid}/hist/energy/{value}/{type}" : { "get" : { "tags" : [ "data" ], "summary" : "Provides the energy consumption from a device within a specified timespan.", "description" : "This method is deprecated.
Note: Using user defined values that contain a \"/\" in their name will result in an error.
Please consider using the updated API methods under histenergy path.

Provides the energy usage data for a selected device, based on a specific value and type, over a defined period.

For information on supported timespan parameters, please refer to the documentation.", "operationId" : "getEnergyValueDeprecated", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 }, { "name" : "value", "in" : "path", "description" : "A value name - check /hist/values for a list of all viable names

\"[\"U_Effective\"]\" gets parsed to \"U_Effective\".", "required" : true, "schema" : { "$ref" : "#/components/schemas/ValuesEnum" }, "example" : [ "U_Effective" ] }, { "name" : "type", "in" : "path", "description" : "A type, e.g. L1, L2, L3, L4, L5, L2L1, L3L2, L1L3, SUM13, SUM14 and others.", "required" : true, "schema" : { "type" : "string" }, "example" : "L1" }, { "name" : "start", "in" : "query", "description" : "Start time for the timespan filter", "required" : true, "schema" : { "type" : "string" }, "example" : "UTC_34235345" }, { "name" : "end", "in" : "query", "description" : "End time for the timespan filter", "required" : true, "schema" : { "type" : "string" }, "example" : "NAMED_Today" } ], "responses" : { "200" : { "description" : "Returns the sum of all found values.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/EnergyEnt" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/EnergyEnt" } } } }, "204" : { "description" : "No content for the requested timespan." }, "404" : { "description" : "Not Found. The requested API endpoint or resource could not be located on the server." } }, "deprecated" : true } }, "/1/projects/{pname}/devices/{devid}/hist/energy/{value}/{type}/{timebase}" : { "get" : { "tags" : [ "data" ], "description" : "This method is deprecated.
Note: Using user defined values that contain a \"/\" in their name will result in an error.
Please consider using the updated API methods under histenergy path.

For information on supported timespan parameters, please refer to the documentation.", "operationId" : "getEnergyValuesInRecordedTimeDeprecated", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 }, { "name" : "value", "in" : "path", "description" : "A value name, check /hist/values

\"[\"U_Effective\"]\" gets parsed to \"U_Effective\".", "required" : true, "schema" : { "$ref" : "#/components/schemas/ValuesEnum" }, "example" : [ "U_Effective" ] }, { "name" : "type", "in" : "path", "description" : "A type, e.g. L1, L2, L3, L4, L5, L2L1, L3L2, L1L3, SUM13, SUM14 and others.", "required" : true, "schema" : { "type" : "string" }, "example" : "L1" }, { "name" : "timebase", "in" : "path", "description" : "Aggregation time interval, eg HOUR, DAY, WEEK, MONTH, QUARTER or YEAR", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 900 }, { "name" : "start", "in" : "query", "description" : "Start time for the timespan filter", "required" : true, "schema" : { "type" : "string" }, "example" : "EUROPEAN_01.07.2018" }, { "name" : "end", "in" : "query", "description" : "End time for the timespan filter", "required" : true, "schema" : { "type" : "string" }, "example" : "EUROPEAN_01.08.2018" }, { "name" : "online", "in" : "query", "description" : "Whether the value was recorded online.", "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : ".", "content" : { "text/plain" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MultipleEnergyEnt" } } }, "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MultipleEnergyEnt" } } } } }, "204" : { "description" : "No content for the requested timespan." }, "404" : { "description" : "Not Found. The requested API endpoint or resource could not be located on the server." } }, "deprecated" : true } }, "/1/projects/{pname}/devices/{devid}/hist/events" : { "get" : { "tags" : [ "data" ], "summary" : "Provides events of a device for a specified timespan.", "description" : "Provides a record of events triggered by a specific device within a project, over a specified timespan.

For information on supported timespan parameters, please refer to the documentation.", "operationId" : "getEvents", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 }, { "name" : "type", "in" : "query", "description" : "Repeatable. A list of event types. Current list: VoltageOver, VoltageUnder, VoltageOutage, VoltageFastChange, CurrentOver, PowerFailure, PowerRecovery, DigitalInputActivated, DigitalInputDeactivated, ComparatorOutputActivated, ComparatorOutputDeactivated, TariffActivated, EmaxChannelActivated, EmaxChannelDeactivated

\"[\"VoltageUnder\", \"VoltageOutage\"]\" gets parsed to \"VoltageUnder, VoltageOutage\".", "required" : true, "schema" : { "$ref" : "#/components/schemas/EventTypeEnum" }, "example" : [ "VoltageUnder", "VoltageOutage" ] }, { "name" : "start", "in" : "query", "description" : "Start time for the timespan filter", "required" : true, "schema" : { "type" : "string" }, "example" : "UTC_34235345" }, { "name" : "end", "in" : "query", "description" : "End time for the timespan filter", "required" : true, "schema" : { "type" : "string" }, "example" : "NAMED_Today" }, { "name" : "unique", "in" : "query", "description" : "optionally filter out duplicate events (default = false).", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "skipMainEvents", "in" : "query", "description" : "optionally filter out main events (default = false).", "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "200" : { "description" : "Returns a list of all found events.", "content" : { "application/xml" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IEvent" } } }, "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IEvent" } } } } }, "204" : { "description" : "No content for the requested timespan." }, "400" : { "description" : "Bad request, e.g. no query param(s) for \"type\"." }, "404" : { "description" : "Not Found. The requested API endpoint or resource could not be located on the server." } } } }, "/1/projects/{pname}/devices/{devid}/hist/flags" : { "get" : { "tags" : [ "data" ], "summary" : "Provides flags from a specified device inside a project.", "description" : "Provides flags from a specified device inside a project.

For information on supported timespan parameters, please refer to the documentation.", "operationId" : "getFlags", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 }, { "name" : "start", "in" : "query", "description" : "Start time for the timespan filter", "required" : true, "schema" : { "type" : "string" }, "example" : "UTC_34235345" }, { "name" : "end", "in" : "query", "description" : "End time for the timespan filter", "required" : true, "schema" : { "type" : "string" }, "example" : "NAMED_Today" } ], "responses" : { "200" : { "description" : "Returns a list of all found flags.", "content" : { "application/xml" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Flag" } } }, "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Flag" } } } } }, "204" : { "description" : "No content for the requested timespan." }, "404" : { "description" : "Not Found. The requested API endpoint or resource could not be located on the server." } } } }, "/1/projects/{pname}/devices/{devid}/hist/sequences/{sequenceType}" : { "get" : { "tags" : [ "data" ], "summary" : "Provides the sequence data of a device inside a project.", "description" : "Provides the sequence data of a device inside a project.

For information on supported timespan parameters, please refer to the documentation.

", "operationId" : "getSequences", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 }, { "name" : "sequenceType", "in" : "path", "description" : "A SequenceType, either Waveform or EffectiveValues.

", "required" : true, "schema" : { "type" : "string", "description" : "var 1", "enum" : [ "Waveform", "EffectiveValues" ] } }, { "name" : "start", "in" : "query", "description" : "Start time for the timespan filter", "required" : true, "schema" : { "type" : "string" }, "example" : "UTC_34235345" }, { "name" : "end", "in" : "query", "description" : "End time for the timespan filter", "required" : true, "schema" : { "type" : "string" }, "example" : "NAMED_Today" } ], "responses" : { "200" : { "description" : "Returns a list of all found sequences.", "content" : { "application/xml" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SequenceEnt" } } }, "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SequenceEnt" } } } } }, "204" : { "description" : "No content for the requested timespan." }, "404" : { "description" : "Not Found. The requested API endpoint or resource could not be located on the server." } } } }, "/1/projects/{pname}/devices/{devid}/hist/transients" : { "get" : { "tags" : [ "data" ], "summary" : "Provides transient data of a device inside a project.", "description" : "Provides transient data of a device inside a project.

For information on supported timespan parameters, please refer to the documentation.

", "operationId" : "getTransients", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 }, { "name" : "start", "in" : "query", "description" : "Start time for the timespan filter", "required" : true, "schema" : { "type" : "string" }, "example" : "UTC_34235345" }, { "name" : "end", "in" : "query", "description" : "End time for the timespan filter", "required" : true, "schema" : { "type" : "string" }, "example" : "NAMED_Today" }, { "name" : "unique", "in" : "query", "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "200" : { "description" : "Returns a list of all found transients.", "content" : { "application/xml" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Transient" } } }, "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Transient" } } } } }, "204" : { "description" : "No content for the requested timespan." }, "404" : { "description" : "Not Found. The requested API endpoint or resource could not be located on the server." } } } }, "/1/projects/{pname}/devices/{devid}/histvalues" : { "get" : { "tags" : [ "data" ], "summary" : "Provides the historical data of a specified device inside a project, over a specified timespan. ", "description" : "Provides the historical data of a specified device inside a project, over a specified timespan.

For information on supported timespan parameters, please refer to the documentation.

", "operationId" : "getHistValueList", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 }, { "name" : "value", "in" : "query", "description" : "A value name, check /hist/values

\"[\"U_Effective\"]\" gets parsed to \"U_Effective\".", "required" : true, "schema" : { "$ref" : "#/components/schemas/ValuesEnum" }, "example" : [ "U_Effective" ] }, { "name" : "type", "in" : "query", "description" : "A type, e.g. Overall, L1, L2, L3, L4, L5, L2L1, L3L2, L1L3, SUM13, SUM14, Main, Aux and others.", "required" : true, "schema" : { "type" : "string" }, "example" : "L1" }, { "name" : "timebase", "in" : "query", "description" : "The timebase in seconds of the recording, in most cases 900.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 900 }, { "name" : "start", "in" : "query", "description" : "Start time for the timespan filter", "required" : true, "schema" : { "type" : "string" }, "example" : "UTC_34235345" }, { "name" : "end", "in" : "query", "description" : "End time for the timespan filter", "required" : true, "schema" : { "type" : "string" }, "example" : "NAMED_Today" }, { "name" : "online", "in" : "query", "description" : "Whether the value was recorded online.", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "aggregate", "in" : "query", "description" : "Force aggregation to requested timebase", "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "200" : { "description" : "Returns a list of all found values.", "content" : { "application/xml" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ValueEnt" } } }, "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ValueEnt" } } } } }, "204" : { "description" : "No content for the requested timespan." }, "404" : { "description" : "Not Found. The requested API endpoint or resource could not be located on the server." } } } }, "/1/projects/{pname}/devices/{devid}/hist/values" : { "get" : { "tags" : [ "data" ], "summary" : "Provides a list of all historical values from a device inside a project.", "description" : "Provides a list of all historical values from a device inside a project.", "operationId" : "getHistValues", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 } ], "responses" : { "200" : { "description" : "Returns a full representation of a values entity.", "content" : { "application/xml" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ValueDescriptionEnt" } } }, "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ValueDescriptionEnt" } } } } }, "404" : { "description" : "Not Found. The requested API endpoint or resource could not be located on the server." } } } }, "/1/projects/{pname}/devices/{devid}/forecast-poweractive" : { "get" : { "operationId" : "getForecastValueList", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 }, { "name" : "type", "in" : "query", "description" : "A type, e.g. Overall, L1, L2, L3, L4, L5, L2L1, L3L2, L1L3, SUM13, SUM14, Main, Aux and others.", "required" : true, "schema" : { "$ref" : "#/components/schemas/TypesEnum" }, "example" : "L1" }, { "name" : "start", "in" : "query", "description" : "Start time for the timespan filter", "required" : true, "schema" : { "type" : "string" }, "example" : "UTC_34235345" }, { "name" : "end", "in" : "query", "description" : "End time for the timespan filter", "schema" : { "type" : "string", "default" : "NAMED_Today" }, "example" : "NAMED_Today" }, { "name" : "online", "in" : "query", "description" : "Whether the value was recorded online.", "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/xml" : { }, "application/json" : { }, "application/javascript" : { } } } } } }, "/1/projects/{pname}/devices/{devid}/hist/values/{value}/{type}/{timebase}" : { "get" : { "tags" : [ "data" ], "summary" : "Provides the historical data of a specified device inside a project, over a specified timespan. ", "description" : "This method is deprecated.
Note: Using user defined values that contain a \"/\" in their name will result in an error.
Please consider using the updated API methods under histvalues path.

Provides the historical data of a specified device inside a project, over a specified timespan.

For information on supported timespan parameters, please refer to the documentation.

", "operationId" : "getHistValueListDeprecated", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 }, { "name" : "value", "in" : "path", "description" : "A value name, check /hist/values

\"[\"U_Effective\"]\" gets parsed to \"U_Effective\".", "required" : true, "schema" : { "$ref" : "#/components/schemas/ValuesEnum" }, "example" : [ "U_Effective" ] }, { "name" : "type", "in" : "path", "description" : "A type, e.g. Overall, L1, L2, L3, L4, L5, L2L1, L3L2, L1L3, SUM13, SUM14, Main, Aux and others.", "required" : true, "schema" : { "type" : "string" }, "example" : "L1" }, { "name" : "timebase", "in" : "path", "description" : "The timebase in seconds of the recording, in most cases 900.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 900 }, { "name" : "start", "in" : "query", "description" : "Start time for the timespan filter", "required" : true, "schema" : { "type" : "string" }, "example" : "UTC_34235345" }, { "name" : "end", "in" : "query", "description" : "End time for the timespan filter", "required" : true, "schema" : { "type" : "string" }, "example" : "NAMED_Today" }, { "name" : "online", "in" : "query", "description" : "Whether the value was recorded online.", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "aggregate", "in" : "query", "description" : "Force aggregation to requested timebase", "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "200" : { "description" : "Returns a list of all found values.", "content" : { "application/xml" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ValueEnt" } } }, "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ValueEnt" } } } } }, "204" : { "description" : "No content for the requested timespan." }, "404" : { "description" : "Not Found. The requested API endpoint or resource could not be located on the server." } }, "deprecated" : true } }, "/1/projects/{pname}/devices/{devid}/hist/values/accepted" : { "get" : { "tags" : [ "data" ], "summary" : "Provides a list of all historical values from a device inside a project.", "description" : "Provides a list of all historical values from a device inside a project.", "operationId" : "getAcceptedHistValues", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 } ], "responses" : { "200" : { "description" : "Returns a full representation of a values entity.", "content" : { "application/xml" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ValueDescriptionEnt" } } }, "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ValueDescriptionEnt" } } } } }, "404" : { "description" : "Not Found. The requested API endpoint or resource could not be located on the server." } } } }, "/1/projects/{pname}/devices/{devid}/manualinput" : { "get" : { "tags" : [ "data" ], "summary" : "Provides a list of all manual input values of a device inside a project.", "description" : "Provides a list of all manual input values of a device inside a project.", "operationId" : "getManualInputValues", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 } ], "responses" : { "200" : { "description" : "Returns a full representation of a input values.", "content" : { "application/xml" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ManualValueEnt" } } }, "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ManualValueEnt" } } } } }, "400" : { "description" : "The device is not a manual input device." }, "404" : { "description" : "Not Found. The requested API endpoint or resource could not be located on the server." } }, "deprecated" : true } }, "/1/projects/{pname}/devices/{devid}/manualinput/{value}/{type}/{timebase}" : { "get" : { "tags" : [ "data" ], "summary" : "Provides the information about the manual input device.", "description" : "Provides the information about the manual input device.", "operationId" : "getSepecificDetails", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 }, { "name" : "value", "in" : "path", "description" : "A value name, check /hist/values

\"[\"U_Effective\"]\" gets parsed to \"U_Effective\".", "required" : true, "schema" : { "$ref" : "#/components/schemas/ValuesEnum" }, "example" : [ "U_Effective" ] }, { "name" : "type", "in" : "path", "description" : "A type, e.g. Overall, L1, L2, L3, L4, L5, L2L1, L3L2, L1L3, SUM13, SUM14, Main, Aux and others.", "required" : true, "schema" : { "type" : "string" }, "example" : "L1" }, { "name" : "timebase", "in" : "path", "description" : "Specifies InputValueEnt containing value to add as well as start and end of time range for added values", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 900 } ], "responses" : { "200" : { "description" : "Returns a full representation of a the input value entity.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/ManualValueEnt" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/ManualValueEnt" } } } }, "400" : { "description" : "The device is not a manual input device." }, "404" : { "description" : "Not Found. The requested API endpoint or resource could not be located on the server." } }, "deprecated" : true }, "post" : { "tags" : [ "data" ], "summary" : "Saves value to historical data.", "description" : "Saves value to historical data.", "operationId" : "insertHistValues", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 }, { "name" : "value", "in" : "path", "description" : "A value name, check /hist/values

\"[\"U_Effective\"]\" gets parsed to \"U_Effective\".", "required" : true, "schema" : { "$ref" : "#/components/schemas/ValuesEnum" }, "example" : [ "U_Effective" ] }, { "name" : "type", "in" : "path", "description" : "A type, e.g. Overall, L1, L2, L3, L4, L5, L2L1, L3L2, L1L3, SUM13, SUM14, Main, Aux and others.", "required" : true, "schema" : { "type" : "string" }, "example" : "L1" }, { "name" : "timebase", "in" : "path", "description" : "Specifies InputValueEnt containing value to add as well as start and end of time range for added values", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 900 } ], "requestBody" : { "description" : "Specifies InputValueEnt containing value to add as well as start and end of time range for addedvalues", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/InputValueEnt" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/InputValueEnt" } } } }, "responses" : { "200" : { "description" : "Confirms successful execution.", "content" : { "text/plain" : { } } }, "400" : { "description" : "Parameters have invalid values. String with error message will be returned." }, "401" : { "description" : "You do not have the necessary permission, use basic auth." } }, "deprecated" : true } }, "/1/projects/{pname}/devices/{devid}/online/values" : { "get" : { "tags" : [ "data" ], "summary" : "Provides a list of all online value types from a specified device inside a project.", "description" : "Provides a list of all online value types from a specified device inside a project.", "operationId" : "getOnlineValues", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 } ], "responses" : { "200" : { "description" : "Returns a full representation of a values entity.", "content" : { "application/xml" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ValueTypeEnt" } } }, "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ValueTypeEnt" } } } } }, "404" : { "description" : "Not Found. The requested API endpoint or resource could not be located on the server." } } } }, "/1/projects/{pname}/devices/{devid}/onlinerecord/settings" : { "get" : { "tags" : [ "data" ], "summary" : "Provides settings for online recording values of a device.", "description" : "Provides settings for online recording values of a device.", "operationId" : "getOnlineRecordSettings", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 } ], "responses" : { "200" : { "description" : "Returns a list for all found online recording values.", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/OnlRecValueListEnt" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/OnlRecValueListEnt" } }, "text/plain" : { } } }, "401" : { "description" : "Unauthorized" }, "404" : { "description" : "Not Found. The requested API endpoint or resource could not be located on the server." } } }, "post" : { "tags" : [ "data" ], "summary" : "Saves settings for online recording values of device.", "description" : "Saves settings for online recording values of device.", "operationId" : "setOnlineRecordSettings", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/OnlRecValueListEnt" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/OnlRecValueListEnt" } } } }, "responses" : { "200" : { "description" : "Confirms successful execution.", "content" : { "text/plain" : { } } }, "400" : { "description" : "Parameters have invalid values. String with error message will be returned." }, "401" : { "description" : "You do not have the necessary permission, use basic auth." } } } }, "/1/projects/{pname}/devices/{devid}/onlinerecord/statistics" : { "get" : { "tags" : [ "data" ], "summary" : "Provides statistics for online recording values of a specified device.", "description" : "Provides statistics for online recording values of a specified device.", "operationId" : "getOnlineRecordStatistics", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "devid", "in" : "path", "description" : "The numeric device id, check GET /devices.", "required" : true, "schema" : { "type" : "integer", "format" : "int32" }, "example" : 1 } ], "responses" : { "200" : { "description" : "Returns a list for all found online recording values.", "content" : { "application/json" : { } } }, "204" : { "description" : "No content." }, "404" : { "description" : "Not Found. The requested API endpoint or resource could not be located on the server." } } } }, "/1/projects/{pname}/onlinevalues" : { "get" : { "tags" : [ "data" ], "summary" : "Provides online value(s) from device(s).", "description" : "

This call will return immediately if all the requested data is delivered on time(\"timeliness\").

If not all data is delivered on time, the request will wait, but no longer than the specified timeout. If a timeout occurs, all known data is returned.

There is no guarantee that the values are measured at the exact same point in time. They simply represent the last known value to the application. The value is retrieved as quickly as possible from its source device.

", "operationId" : "getOnlineValues_1", "parameters" : [ { "name" : "pname", "in" : "path", "description" : "Project name", "required" : true, "schema" : { "type" : "string" }, "example" : "Default Project" }, { "name" : "value", "in" : "query", "description" : "This API value is repeatable and accepts a list of values. Each value in the list is defined by a query parameter \"value\" and the query content, which is a semicolon-separated list consisting of three elements:\n", "schema" : { "type" : "array", "items" : { "type" : "string" } }, "example" : "1;I_Effective;L1,L2,L4" }, { "name" : "appendValueType", "in" : "query", "description" : "A Boolean indicating appending the ValueType.", "schema" : { "type" : "boolean" } }, { "name" : "timeout", "in" : "query", "description" : "Maximum wait time for values in milli seconds for all value to become timely.", "schema" : { "type" : "integer", "format" : "int32", "default" : 500 } }, { "name" : "timeliness", "in" : "query", "description" : "Defines the maxium time between the request and the last update on a value.If the value was updated within this period, it is considered timely.If all values are timely, the request can return a response.", "schema" : { "type" : "integer", "format" : "int32", "default" : 60000 } }, { "name" : "ignoreDeletedDevice", "in" : "query", "description" : "A Boolean flag used to determine whether to ignore deleted devices. If false the whole request fails with 404 if one device is deleted. If true these deleted devices will be skipped in the results.", "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "200" : { "description" : "Returns serval maps for all requested online values. The device ID, value and type separated by a dot are used as the key in each map.