New

Deployment: 30.03.2023

Attention:

  • This developer portal is now deprecated. You can continue to use it, as per usual, until its retirement in September 2023, when it will not any more accessible.
  • Please check the climatixic.com release notes for the portal migration.

Plants

  • Add support for the new upgrade priority flag for plants
    • Fetch the current state of the upgrade priority using endpoint /Plants/{id} (GET), the state is inside the new property "upgradeFilePriority"
    • Confirm the upgrade priority state by setting the property "acknowledgeUpgradePriority" using endpoint /Plants/{id} (PUT)
  • Add support for plant based mapping file that can be used for controller upgrade
    • Schedule controller with a plant based mapping file can be done by property "objectHandlerMappingFileId" using endpoint /Plants/{id}/Upgrade/Automated (PUT)

Files

  • Add support for the new upgrade priority using the release notes in application sets
    • Add release notes file to an application set using endpoint /Files (POST) by setting the new file type "ReleaseNotesFile"

History

Deployment: 24.11.2022

Account

  • Security enhancements
    • Enforce password change for certain users using endpoint /Account/EnforcePasswordChange (PUT)

Analytics

  • New analytics API
    • Add/Remove definition for plant metadata based on cloud item values using endpoint /Analytics/PlantMetadata (POST/DELETE)
    • Fetch definition for plant metadata based on cloud item values using endpoint /Analytics/PlantMetadata/{id} (GET)

Users

  • New users info API
    • Fetch a list of users defined in plants or systems using endpoint /Users/Info (GET)

Webhhoks

  • DataPoint
    • Content of the datapoint webhhoks extended to include also all COVs, not only the last value for a minute of time

Deployment: 07.07.2022

Plants

  • Support of virtual alarm events
    • Adds one or more virtual alarm events for the device using endpoint /Plants/{id}/ActiveAlarms (POST)
    • Removes an alarm event for the device using endpoint /Plants/{id}/ActiveAlarms/{alarmId} (DELETE)

Deployment: 10.03.2022

Analytics

  • New analytics API
    • Fetch all supported tenants for analytics using endpoint /Analytics/Tenants (GET)
    • Fetch all plants assigned in a tenant for analytics using endpoint /Analytics/Plants (GET)
    • Fetch all cloud items in a plant for analytics using endpoint /Analytics/DataPoints (GET)
    • Fetch all history entries and info for a specific cloud items without pagination using endpoint /Analytics/DataPoints/{id} (GET)

Plants

  • Support of notifications
    • Add/Fetch available alarm notification for a given plant using endpoint /AlarmNotifications (GET, POST)
    • Manage a given alarm notification using endpoint /AlarmNotifications/{id} (GET, PUT, DELETE)
    • Add/Fetch available report notification for a given plant using endpoint /ReportNotifications (GET, POST)
    • Manage a given report notification using endpoint /ReportNotifications/{id} (GET, PUT, DELETE)

Deployment: 09.06.2021

Plants

  • Billing-subscriptions on plant level
    • Fetch available billing subscriptions for a given plant using /Plants/{id}/BillingProducts (GET)
    • Add/fetch billing subscription for a given plant (proprety: billingProductId) using /Plants/{id} (GET, PUT)

Tenants

  • Support of API developer portal accounts
    • Add/Fetch available API developer portal accounts for a given tenant using /Tenants/{id}/ApiAccounts (GET, POST)
    • Manage a given API developer portal account using /Tenants/{id}/ApiAccounts/{apiAccountId} (GET, DELETE)
    • Refresh keys for a single API developer portal account using /Tenants/{id}/ApiAccounts/{apiAccountId}/Refresh[Primary|Secondary]Secret (PUT)

Deployment: 29.09.2020

Plants

  • Climatix device features
    • Add/fetch available licenses for a device using /Plants/Licenses (POST, GET)
    • Add features for a device using /Plants/Licenses/{activationKey} (POST)
    • Get a ready to use license file for a device by calling /Plants/Licenses/{activationKey}/LicenseFile (GET).
  • New command to read device's view nodes
    • Added a new command (16) to fetch mapping structure from device /Plants/{id}/Upgrade/Commands (POST)

Tenants

  • Support of multiple webhooks for Alarms/DataPoints

Deployment: 19.05.2020

Virtual cloud items full support

New support for virtual cloud items commanding available.
  • Webhook definition:
    • Webhook data can be managed under /Tenants/{id}/VirtualCloudItemWriteWebhook (POST, GET, PUT, DELETE)
    • Webhook will be called when the value for virtual cloud item is commanded by
      /DataPoints/{id}/ (PUT).
  • Virtual cloud item command:
    • Command the virtual cloud item by calling /DataPoints/{id} (PUT).

Plants

  • Add alarm entry to a plant via /Plants/{id}/ActiveAlarms (PUT)

Users

  • Send language dependent E-Mail content to user when get assigned via /Users/{id}/Assign (POST)

Deployment: 29.01.2020

Virtual cloud items

New support for virtual cloud items/virtual viewnodes available.
  • Virtual cloud items:
    • Create: The virtual cloud items can be created via /DataPoints (POST), to manage
      the data for a cloud item, use DataPoints/{id} (PUT, DELETE).
    • Add current value: current value can be set using /DataPoints/Values (PUT).
    • Add History data: history data for a virtual cloud item could be added via DataPoints/{id}/EnumerateHistory (PUT).
  • Virtual viewnodes:
    • Create: to create a new virtual viewnode, use /ViewNodes (POST).
    • Manage: to manage a virtual viewnode, use /ViewNodes (PUT, DELETE).

Plants

  • New filter keys for /Plants (GET) added to support filtering via device features or supported privileges.

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)

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: 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: 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.