Skip to main content

Dashboard stream API

This API is based on the Device Configuration API framework. For guidance on how to use these APIs, please refer to the Device Configuration APIs section in the VAPIX Library.

note

This API is in RELEASE stage. It can be used in the production environment.

Overview​

The Dashboard stream API provides configuration of air quality dashboard stream.

Use the API to configure:

  • Dark mode
  • Display language

Use cases​

Get root entity​

This example shows how to get the root entity.

GET /config/rest/dashboard-stream/v1 HTTP/1.1
HOST: my-device
HTTP/1.1 200 OK
Content-Type: application/json

{
    "status": "success",
    "data": {
        "darkmode": true,
        "language": "en"
    }
}

API definition​

Structure​

dashboard-stream.v1 (Root Entity)
    ├── darkmode (Property)
    ├── language (Property)

Entities​

dashboard-stream.v1​

  • Description: Configuration root object
  • Type: Singleton
  • Operations
    • GET
  • Attributes
    • Dynamic Support: No
Properties​
darkmode​
  • Description: Enable or disable dark mode
  • Data type: boolean
  • Operations
    • GET (Permissions: admin, operator, viewer)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
language​
  • Description: Language display in dashboard stream
  • Data type: Language
  • Operations
    • GET (Permissions: admin, operator, viewer)
    • SET (Permissions: admin)
  • Attributes
    • Nullable: No
    • Dynamic Support: No / Dynamic Enum: No / Dynamic Range: No
Actions​

This entity has no actions.

Data types​

Language​

  • Description: The display language of the dashboard stream
  • Type: string
  • Enum Values: "cs", "de", "en", "es", "fr", "it", "nl", "pl", "pt", "fi", "sv", "vi", "tr", "ru", "th", "ko", "zh", "zh-TW", "ja"