New

Deployment: 12.09.2019

Webhooks

New support for Webhooks (alarms and datapoints) available.
  • Alarming:
    • Registration: The webhooks will be managed via /Tenants/{id}/AlarmWebhook.
    • Behaviour: Every new alarm from a plant, calls immediately the Webhook callback url.
      A repetition is not available, only new alarms will be reported.
    • Callback URL: The callback contains plant information and alarm informations (similar to GET /Plants/{id}/ActiveAlarms).
  • Datapoints:
    • Registration: The webhooks will be managed via /Tenants/{id}/AlarmWebhook.
      Additionaly must be the new property "webhookEnabled" set to true under /DataPoints/{id}. Only this datapoints will be sent to the callback url.
      No caching or buffering supported.
    • Behaviour: The tenant webhook will be called once for all plants connected to the same virtual machine. If there are plants (from the same tenant) connected to different virtual machines, the webhook will be called more than once.
      The callback URL will be called when the next minute starts.
    • Callback URL: The callback contains all datapoints from all plants which delivers values in this minute. The content is a collection of /DataPoints/Values with plant ID, Datapoint ID, datapoint value and timestamp (UTC).

DataPoints

  • New poperty to enable the datapoint webhook functionality /DataPoints/{id} (POST,PUT)

Tenants

  • New request for alarm webhook funcltionality: /Tenants/{id}/AlarmWebhook (GET,POST,PUT,DELETE)
  • New request for data points webhook funcltionality: /Tenants/{id}/DataPointValuesWebhook (GET,POST,PUT,DELETE)

History

Deployment: 13.02.2018

General

  • Better reprenstation and documentation inside the Managment Portal.

Account

  • Account/RefreshToken (DELETE)
  • Account/Token (POST) Supports now also the refresh token workflow. (refresh_token Included inside the response)

DataPoints

  • New request DataPoints/{id]/EnumerateHistory (GET) Successor of /DataPoints/{id}/History

DeletedPlants

  • New request DeletedPlants (GET)

Devices

  • New request Devices/ActivationKey (GET)

Plants

  • New request Plants//DeletedPlants (GET)

Tenants

  • New request Tenants/{id}/Billing/UssageHistory (GET)
  • New request Tenants/{id}/M2MDevices (GET)
  • New request Tenants/{id}/M2MDevices/{iccid}/State (GET)

Deployment: 15.05.2018

Plants

  • New request /Plants/{id}/Upgrade/Status (GET)
  • New request /Plants/{id}/Upgrade/Commands (GET,POST)
  • New request /Plants/{id}/Upgrade/Automated (GET,POST,PUT)

Deployment: 14.12.2017

ApplicationSets

  • New request ApplicationSets (GET,POST)
  • New request ApplicationSets/{id} (GET,PUT,DELETE))

Files

  • New request Files (GET,POST)
  • New request Files/{id} (GET,PUT;DELETE)
  • New request Files/{id}/Content (GET,PUT;DELETE)

Devices

  • Full implementation available. (GET,PUT,DELETE,POST)
  • Suppots devices via the Northbound API. Only Alarm creation is support, not cloud items.

Enhancements

Plants

  • New Request Plants/{id}/Notifications (PUT)
  • New optional property available "customerPlantId" for Plants and Plants/{id}(GET, PUT, POST).
  • Request Plants (GET) support now for the filterId also the property "customerPlantId".
  • New reference inside "assignedResources" to the device. (GET Plants/{id}). The ID points tp:
    • Climatix, OZW: Contains the id to access the local web server. e.g. https://www.climatixic.com/Site/RemoteWeb/{id}/web/
    • Northboud devices: The id for the corresponding device resource devices/{id}/
  • New Request Plants/{id}/Notifications (PUT).

Tenants

  • New optional properties available for billing Plants and Plants/{id}(GET).
    • billingProductName
    • billingProductType
    • remainingCredits
    • remainingItemUpdates
    • remainingPlants
    • datapointIdForDefaultPlantImsi
    • datapointIdForDefaultPlantCustomerPlantId
  • Request Plants (GET) support now for the filterId also the property "customerPlantId".
  • New reference inside "assignedResources" to the device. (GET Plants/{id}). The ID points tp:
    • Climatix, OZW: Contains the id to access the local web server. e.g. https://www.climatixic.com/Site/RemoteWeb/{id}/web/
    • Northboud devices: The id for the corresponding device resource devices/{id}/
  • New Request Plants/{id}/Notifications (PUT).

Deployment: 12.06.2017

Enhancements

Account API

Allow self registration and Password reset work flow.

Deployment: 01.06.2017

Enhancements

Documentation

  • Full documentation, also of the POST, PUT body.
    Please ignore the documentation of "IsDefined". This Property is not needed and only for internal reasons inside the documentation.

Users

  • Users/me Delivers now the current user (you) back. The ID is not needed, because not known
  • PUT: Users/[id}: Support to change the password without email workflow.

Available

UserRolles

  • Full implementation to access the User roles resource. (GET, PUT, DELETE,POST)

Users

  • Full implementation to access the User resource. (GET, PUT, DELETE,POST)
  • The GET request of a single user contains also a list of accissible plants.
  • Assignment of an User can be done by using Add user to resource. POST/DELTE: /Users/{id}/Assign

DataPoints

Full implementation of the current value DataPoints resource is available (GET, PUT).

ViewNodes

Full implementation of the ViewNode resource.

Tenants

Full implemenation available. (GET,PUT,DELETE,POST)

Plants

  • Full implementation available. (GET,PUT,DELETE,POST)
  • Support of AlarmHistory and AlarmList
  • The GET request of a single plant contains also a list of assigned users.