Breaking Changes in thingsHub 6.0

This document outlines the changes that users must be aware of when upgrading from thingsHub 5.5 to thingsHub 6:

API Changes

Removal of deprecated things endpoints:
All things endpoints that were deprecated in thingsHub 5 have been removed from the public API. This includes:

• GET /api/v3/things

• POST /api/v3/things

• DELETE /api/v3/things/{id}

• GET /api/v3/things/{id}

• PUT /api/v3/things/{id}

• DELETE /api/v3/things/{id}/geolocation

• GET /api/v3/things/{id}/geolocation

• PUT /api/v3/things/{id}/geolocation

Changes to the /api/v3/asset-tags endpoint:

• The full-text search parameter has been changed changed from query to search in the LIST endpoint.

  Before:

  CODE

  GET /api/v3/asset-tags?query=car

  After:

  CODE

  GET /api/v3/asset-tags?search=car

Changes to the /api/v3/tracking-algorithms/{id}/position endpoint:

• The request format now requires the tracker_id field to scope positions for a specific tracker. The request body is now as follows:

  JSON

  {
    "at": "2024-10-06T05:41:32.452Z",
    "from": "2024-10-06T05:41:32.452Z",
    "purpose": "Position",
    "to": "2024-10-06T05:41:32.452Z",
    "tracker_id": "string"
  }

• The response format has been updated as follows:

  JSON

  {
    "count": 1000,
    "message": "There may be more positioning data, but only the latest 1000 are loaded",
    "results": [
      {
        "location": {
          "longitude": 8.438669443130493,
          "moved_at": "2020-01-01T04:00:01Z",
          "site": "SmartMakers HQ",
          "speaking_location": "Parking Hallway,SmartMakers HQ",
          "zone": "Parking Hallway"
        },
        "remarks": {
          "message": "no latitude is found",
          "status": "skipped"
        }
      },
      {
        "location": {
          "latitude": 48.438669443130493,
          "longitude": 8.438669443130493,
          "moved_at": "2020-01-01T04:00:01Z",
          "site": "SmartMakers HQ",
          "speaking_location": "Parking Hallway,SmartMakers HQ",
          "zone": "Parking Hallway"
        }
      }
    ],
    "tracker_id": "tracker_id_1234"
  }

Data Table and Grafana Query Breaking Changes

Removal of the things measurement and retention policies:

• The things data tables and retention policy have been completely removed. Data tables, dashboards and alerts created with the things data table will not work in thingsHub 6.

• Consider changing your influxDB queries to use journey_entries measurement in the journey_entries_rp retention policy instead of things.

Breaking Changes from Visualizer

As part of thingsHub’s upgrade to thingsHub 6, thingsHub’s visualizer is upgrading to Grafana 10, which comes with the following breaking changes:

Disabling of certain features:

• Installation and management of plugins in Visualizer is no longer possible.

• The snapshot feature is no longer available.

• Creating and managing Organizations is disabled.

• The Explore feature is also disabled.

Removal of support for deprecated Angular Plugins in Visualizer

With Thingshub 6, Angular plugins in visualizer have been deprecated and will be removed entirely in future versions.

ThingsHub users should migrate any dashboards that rely on Angular plugins to supported alternatives that do not use Angular.

Some plugins commonly used in thingsHub and have to be migrated are as follows:

• agenty-flowcharting-panel: This plugin has been removed, and dashboards using this will have to be migrated to use the Canvas (core) or Diagram plugin.

• grafana-thingshub-btn-panel: This plugin has been removed, and dashboards using this will have to be migrated to use the Canvas plugin.

• grafana-worldmap-panel: This plugin has been removed, and dashboards using this will have to be migrated to use the Geomap (core) plugin.

• bessler-pictureit-panel: This plugin has been removed, and dashboards using this will have to be migrated to use the ePict plugin.

For the full list of the deprecated plugins, and the details on the deprecation and migration, please go through Grafana’s official documentation page on this, where the steps for each plugin is explained in detail.

Breaking helm changes:

Only for On-Premise Customers

Removal of the things block:

• The support for the things block in the helm charts, along with the deprecated things service itself, has been completely removed.

✅ Required Actions

Users should take the following actions to adjust to these breaking changes:

• Update any existing API calls to use the new search parameter instead of query in requests to the /api/v3/asset-tags endpoint.

• Ensure that your application and helm chart no longer reference the removed things service and its endpoints, as they are no longer available.

• Modify your request format to include the tracker_id when interacting with the /api/v3/tracking-algorithms/{id}/position endpoint, and adjust your client to handle the new response format.

• Review and adapt your Visualizer usage based on the disabled features to ensure continued functionality.

• Migrate any dashboards that use Angular plugins to use React Based Grafana plugins.

If your application utilizes any of these endpoints or features, please integrate these changes before upgrading to thingsHub 6.