The Emissions API v1 has been removed. All endpoints have been deprecated and will no longer be available. Please use the Emissions API v2 for all emissions data.

In this version of our App SDK, we have upgraded NX to v19.5.6. Make sure to upgrade your extensions to the latest version of NX.

npx nx migrate 19.5.6
npx nx migrate --run-migrations

Please refer to Maintaining Your Application for more information.

[Breaking change] We are removing the default-src from the cspHeader property in the IrisX App manifest.

We are doing this since we have seen issues with more specific CSP rules and conflicts with default-src.

So in case you have to call an external API and defined:

{
  "cspHeader": {
    "default-src": ["https://api.mycompany.com"]
  }
}

Then it should be changed to the more specific connect-src for API calls:

{
  "cspHeader": {
    "connect-src": ["https://api.mycompany.com"]
  }
}

Introduced new version 2 Emissions API endpoints that removed the field 'estimationConfidence' from the response, in favour of 'dataSourceScore' for individual assets.

Added two new fields to v2 KPI endpoints 'averageDataSourceScore' and 'dataSourceScoreCompilation'.

• averageDataSourceScore: The average score of the data source for the fleet or filtered assets.
• dataSourceScoreCompilation: Sums the total of each score into a bucket.

Data Source Score is a new field that provides a score for the data source of the emissions data per asset. The score is a value between 0 and 100, where 0 is the lowest score and 100 is the highest score. The Data Source Score documentation can be found here.

New Endpoints​

➕ GET: /v2/emissions/period

Get period

➕ POST: /v2/emissions/period

Filter period

➕ GET: /v2/emissions/period/kpis

Get period KPIs

➕ POST: /v2/emissions/period/kpis

Filter period KPIs

➕ POST: /v2/emissions/monthly

Filter monthly

➕ GET: /v2/emissions/monthly/summary

Get monthly summary

➕ POST: /v2/emissions/monthly/summary

Filter monthly summary

➕ POST: /v2/emissions/lifetime

Filter lifetime

➕ GET: /v2/emissions/lifetime/kpis

Get Lifetime KPIs

➕ POST: /v2/emissions/lifetime/kpis

Filter Lifetime KPIs

➕ POST: /v2/emissions/daily

Filter daily

➕ GET: /v2/emissions/daily/summary

Get daily summary

➕ POST: /v2/emissions/daily/summary

Filter daily summary

➕ GET: /v2/emissions/daily/kpis

Get daily KPIs

➕ POST: /v2/emissions/daily/kpis

Filter daily KPIs

➕ GET: /v2/sites/{siteId}/emissions

Get site

In this version of the App SDK, we have upgraded Node to the current LTS version 20.12.2. Make sure to upgrade your workspace to at least Node v20.12.2.

If using volta, you can install the latest LTS version of Node by running:

volta install node@lts

Otherwise, you can download the latest LTS version of Node from the Node.js website.

In this version of our App SDK, we have upgraded NX to v18.3.3. Make sure to upgrade your extensions to the latest version of NX.

npx nx migrate 18.3.3
npx nx migrate --run-migrations

Please refer to Maintaining Your Application for more information.

Released stable version v1 of Customer API as REST and GraphQL endpoint.
For more information, see the documentation and introduction of the endpoints.

➕ Trackunit Iris GraphQL API

Example:

query GetCustomers(
  $before: Cursor
  $after: Cursor
  $last: Int
  $first: Int = 20
) {
  customers(before: $before, after: $after, first: $first, last: $last) {
    edges {
      node {
        id
        name
        type
      }
    }
    pageInfo {
      hasPreviousPage
      hasNextPage
      startCursor
      endCursor
      count
    }
  }
}

See all relevant GQL documentation

REST

Below a list of all available REST endpoints:

Customer:​

➕ GET: /customer/v1/customers/{customerId}

Get customer

➕ GET: /customer/v1/customers

Get customers

➕ POST: /customer/v1/customers

Create customer

➕ PATCH: /customer/v1/customers/{customerId}

Update customer

➕ DELETE: /customer/v1/customers/{customerId}

Delete customer

Customer Contact:​

➕ GET: customer/v1/customers/{customerId}/contacts/{contactId}

Get contact

➕ GET: customer/v1/customers/{customerid}/contacts

Get contacts

➕ POST: customer/v1/customers/{customerid}/contacts

Create contact

➕ PATCH: customer/v1/customers/{customerid}/contacts/{contactId}

Update contact

➕ DELETE: customer/v1/customers/{customerid}/contacts/{contactId}

Delete contact

Customer Asset assignments:​

➕ GET: customer/v1/customers/{customerid}/assets

Get assets

➕ POST: customer/v1/customers/{customerid}/assets

Update assets

Released stable version v1 of Custom Fields API.

The Custom Fields API provides a way to define new fields in the Trackunit data model. Allowing to extend and customize Trackunit Manager. In this version 1 we support extending the data model of assets, accounts, groups and sites with new fields.

Below all available endpoints:

To define a custom field, you first need to add a definition using the API.

➕ GET: /custom-fields/v1/definitions

Get definitions

➕ POST: /custom-fields/v1/definitions

Create definition

➕ PATCH: /custom-fields/v1/definitions/{definitionId}

Update definition

➕ DELETE: /custom-fields/v1/definitions/{definitionId}

Delete definition

Use the Custom Fields Values API to set values on your defined custom fields

➕ GET: /custom-fields/v1/values

Get values

➕ POST: /custom-fields/v1/values

Create value

➕ PATCH: /custom-fields/v1/values/{valueId}

Update value

➕ DELETE: /custom-fields/v1/values/{valueId}

Delete value

Released stable support of webhooks.

With the addition of webhooks, we are extending our Iris capabilities to make it easier to set up meaningful workflows by e.g. triggering actions and notifications in external systems that help you run your business. The Trackunit Iris platform collects and stores data about every event that happened to an asset. Via our webhooks technology you can subscribe to relevant event types and get event data served in real-time.

All available event types in this release:

• alerts.asset.on
• alerts.asset.off
• faults.asset.on
• faults.asset.off
• service-management.service-status.updated
• sites.asset.enter
• sites.asset.leave
• sites.asset.archive

For more information see our Webhooks guide section.

We are aligning pricing plan names with the official pricing plan names. So if you specify installation.pricingPlans in your app manifest you will need to update it when upgrading to this version.