{ "uuid": "91167874-c796-4a55-a541-0b0e88de9863", "lastMigration": 29, "name": "groov View Public API", "endpointPrefix": "api", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "5f3ad600-6899-4dae-95a3-9fe3dfbc7723", "documentation": "Get information about groov View. No authorization required.", "method": "get", "endpoint": "info", "responses": [ { "uuid": "eaf1135e-167c-4732-9a48-0db83635d6ef", "body": "{\n \"currentApiVersion\": {{faker 'number.int' max=99999}},\n \"groovAdminVersion\": \"\",\n \"groovBoxDescription\": \"\",\n \"groovNodeRedVersion\": \"\",\n \"isGroovBox\": {{faker 'datatype.boolean'}},\n \"isGroovBoxSetup\": {{faker 'datatype.boolean'}},\n \"isLicenseValid\": {{faker 'datatype.boolean'}},\n \"licenseType\": \"\",\n \"minimumApiVersion\": {{faker 'number.int' max=99999}},\n \"shouldShowTrialDialog\": {{faker 'datatype.boolean'}},\n \"timezoneName\": \"\",\n \"timezoneOffset\": {{faker 'number.int' max=99999}},\n \"trialPeriodExpiration\": {{faker 'number.int' max=99999}},\n \"warVersion\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e95ec43e-22ac-4a3e-ba92-3546fd88c6e3", "documentation": "List devices available in the data store. Authorized for admins and editors.", "method": "get", "endpoint": "v1/data-store/devices", "responses": [ { "uuid": "35a13d47-17d0-43d9-8ec2-b2904fc15757", "body": "[\n {\n \"deviceType\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a4b31077-b4aa-4851-8358-abd037c71138", "documentation": "List tags of the given device. Authorized for admins and editors.", "method": "get", "endpoint": "v1/data-store/devices/:id/tags", "responses": [ { "uuid": "f51bc2b0-b25a-415b-94fc-77586987ab66", "body": "[\n {\n \"dataType\": \"{{oneOf (array 'boolean' 'integer' 'float' 'string' 'booleanArray' 'integerArray' 'floatArray' 'stringArray')}}\",\n \"deviceId\": {{faker 'number.int' max=99999}},\n \"id\": {{faker 'number.int' max=99999}},\n \"length\": {{faker 'number.int' max=99999}},\n \"name\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "740ec655-9425-4266-8c9a-a14116169844", "documentation": "Read selected tags from the data store. Authorized for admins and editors.", "method": "post", "endpoint": "v1/data-store/read", "responses": [ { "uuid": "f452af38-9e06-4e52-8344-024ea8e092db", "body": "[\n {\n \"valueType\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b0e87a14-7a8b-4146-b7e0-228ebed32ccc", "documentation": "Read the current value of a single tag. Authorized for admins and editors.", "method": "get", "endpoint": "v1/data-store/read/:id", "responses": [ { "uuid": "0f97c3cc-078f-40c6-8f1a-dd59078bb2c1", "body": "{\n \"valueType\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "3e09cdfb-a43a-4d80-99f5-5105531340d0", "documentation": "List all data store tags defined in the project. Authorized for admins and editors.", "method": "get", "endpoint": "v1/data-store/tags", "responses": [ { "uuid": "bed1e1d3-481d-417b-b353-4871a3e5fa85", "body": "[\n {\n \"dataType\": \"{{oneOf (array 'boolean' 'integer' 'float' 'string' 'booleanArray' 'integerArray' 'floatArray' 'stringArray')}}\",\n \"deviceId\": {{faker 'number.int' max=99999}},\n \"id\": {{faker 'number.int' max=99999}},\n \"length\": {{faker 'number.int' max=99999}},\n \"name\": \"\"\n }\n]", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fe67a4cc-1542-4ccb-bc72-3f87abd8f44b", "documentation": "Writes a new value to the given tag. Authorized for admins and editors.", "method": "post", "endpoint": "v1/data-store/write/:id", "responses": [ { "uuid": "852ee346-dc4e-4a4d-a9d4-13335993b233", "body": "{\n \"valueType\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "1939aa30-e241-466a-b886-541ae0ce73c2", "documentation": "Downloads the complete groov View log in JSON format. Added in groov View R4.2a.", "method": "get", "endpoint": "v1/logging/groovLogs.json", "responses": [ { "uuid": "dcc4a149-f1c6-44b0-890e-adf34e11b8fb", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Downloaded log file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "50e6653f-c80e-4b20-82d2-d143e6285663", "documentation": "Downloads the complete groov View log. Added in groov View R4.2a.", "method": "get", "endpoint": "v1/logging/groovLogs.txt", "responses": [ { "uuid": "6122237f-32f0-4154-b08b-d74af9933d26", "body": "\"\"", "latency": 0, "statusCode": 200, "label": "Downloaded log file.", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e6e9cc55-db74-4966-9993-2325f17fa7e2", "documentation": "Get information about the user you are authenticated as. Authorized for admins, editors, operators, and kiosk.", "method": "get", "endpoint": "whoami", "responses": [ { "uuid": "75067a46-6c91-4e6a-af9a-7efa42e1b59e", "body": "{\n \"apiKey\": \"\",\n \"email\": \"\",\n \"groups\": [\n {{faker 'number.int' max=99999}}\n ],\n \"id\": {{faker 'number.int' max=99999}},\n \"needsPasswordChange\": {{faker 'datatype.boolean'}},\n \"role\": \"\",\n \"username\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "5f3ad600-6899-4dae-95a3-9fe3dfbc7723" }, { "type": "route", "uuid": "e95ec43e-22ac-4a3e-ba92-3546fd88c6e3" }, { "type": "route", "uuid": "a4b31077-b4aa-4851-8358-abd037c71138" }, { "type": "route", "uuid": "740ec655-9425-4266-8c9a-a14116169844" }, { "type": "route", "uuid": "b0e87a14-7a8b-4146-b7e0-228ebed32ccc" }, { "type": "route", "uuid": "3e09cdfb-a43a-4d80-99f5-5105531340d0" }, { "type": "route", "uuid": "fe67a4cc-1542-4ccb-bc72-3f87abd8f44b" }, { "type": "route", "uuid": "1939aa30-e241-466a-b886-541ae0ce73c2" }, { "type": "route", "uuid": "50e6653f-c80e-4b20-82d2-d143e6285663" }, { "type": "route", "uuid": "e6e9cc55-db74-4966-9993-2325f17fa7e2" } ] }