Opto22

groov View Public API

Revised: 2019-11-21 Overview groov View Public API revision 1.

IoT & devices#openapi#iot

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Revised: 2019-11-21

Overview

groov View Public API revision 1.

Endpoints 10

info

  • GETgroovInfo/infoGet information about groov View. No authorization required.

whoami

  • GETwhoAmI/whoamiGet information about the user you are authenticated as. Authorized for admins, editors, operators, and kiosk.

data-store

  • GETlistDevices/v1/data-store/devicesList devices available in the data store. Authorized for admins and editors.
  • GETlistDeviceTags/v1/data-store/devices/:id/tagsList tags of the given device. Authorized for admins and editors.
  • POSTbatchReadTags/v1/data-store/readRead selected tags from the data store. Authorized for admins and editors.
  • GETreadTag/v1/data-store/read/:id?index=0&count=1Read the current value of a single tag. Authorized for admins and editors.
  • GETlistAllTags/v1/data-store/tagsList all data store tags defined in the project. Authorized for admins and editors.
  • POSTwriteTag/v1/data-store/write/:id?value=string&index=0Writes a new value to the given tag. Authorized for admins and editors.

logging

  • GETdownloadLogJson/v1/logging/groovLogs.json?minimum-log-level=INFO&last-timestamp=0&filter=stringDownloads the complete groov View log in JSON format. Added in groov View R4.2a.
  • GETdownloadLogText/v1/logging/groovLogs.txt?minimum-log-level=INFO&last-timestamp=0&filter=stringDownloads the complete groov View log. Added in groov View R4.2a.

API details

Authentication
An API key in the api_key query parameter
Operations
10 operations on 10 pathsGET 8POST 2
Main resources
data-store 6logging 2info 1whoami 1
Response formats
application/json
Description format
Swagger 2.0, API version R4.2a
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the groov View Public API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the groov View Public API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the api_key query parameter. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “groovInfo” (GET /info), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the groov View Public API?

Revised: 2019-11-21 Overview groov View Public API revision 1. It is listed under IoT & devices and has 10 endpoints.

Who publishes the groov View Public API?

It is listed from Opto22's public API description (an OpenAPI document), not published by Opto22 on Swastik Codes. Anyone who controls opto22.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the groov View Public API?

With an API key in the api_key query parameter.

How many endpoints does the groov View Public API have?

10 operations on 10 paths (8 GET, 2 POST). The largest groups are data-store, logging, info, whoami.

Is forking the groov View Public API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.