ARDI Documentation - ardisdk

Integration Addon Development

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Integration Addon Development This section covers the development of one type of ARDI addon - an integration addon. Integration addons allow you to integrate information from 3rd party systems to the ARDI dashboard. Limitations Integration addons are only executed when a user takes a close look at an asset - say by opening the dashboard or viewing an asset in ARDI-VE. They are

/api/addon

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/addon Usage This function checks to see if a particular addon is installed and/or enabled Details DetailValueGroupServerFrom Server Version0.9.0PermissionPublicMethodsGET or POST Parameters ParameterNotesMeaningcodeStringThe short-code (folder name) of the addon

/api/asset/active

anonymous@undisclosed.example.com (Anonymous) — Tue, 13 Jan 2026 23:47:13 +0000

/api/asset/active Usage This function is used to get a list of all of the active alerts in ARDI. Details DetailValueGroupAssetFrom Server Version2025.0.2PermissionGuestMethodsGET or POST Parameters ParameterNotesMeaningformatString (xml)Either 'xml' or 'json'

/api/asset/allalerts

anonymous@undisclosed.example.com (Anonymous) — Tue, 13 Jan 2026 23:45:12 +0000

/api/asset/allalerts Usage This function is used to get a list of all of the alerts in ARDI. Note that this is a list of all alerts, not all active alerts. The alerts are only active if the 'status' property is equal to 1. Details DetailValueGroup

/api/asset/after

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/asset/after Usage Returns a sequence of assets that are downstream (feeding from) an asset along a specific relationship. Details DetailValueGroupAssetFrom Server Version0.9.0PermissionGuestMethodsGET Parameters ParameterNotesMeaningidInteger [Required]

/api/asset/before

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/asset/before Usage Returns a sequence of assets that are upstream (feeding to) an asset along a specific relationship. Details DetailValueGroupAssetFrom Server Version0.9.0PermissionGuestMethodsGET Parameters ParameterNotesMeaningidInteger [Required]

/api/asset/detail

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/asset/detail Usage This function is used to get detailed information about a particular asset. This includes live information, media files and relationships that the asset has with its neighbours. It's the most complete information available about the asset.

/api/asset/effects [DELETE]

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/asset/effects [DELETE] Usage Removes an effect on this asset. Note that deleting an effect by name can cause problems if you have multiple instances of that effect. This function will delete all instances. Details DetailValueGroupAssetFrom Server Version

/api/asset/effects [GET]

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/asset/effects [GET] Usage Returns the list of effects added on this asset. Details DetailValueGroupAssetFrom Server Version0.9.0PermissionGuestMethodsGET Parameters ParameterNotesMeaningidInteger [Required]The ID of the assetformatString (xml)Either 'xml' or 'json'

/api/asset/effects [POST]

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/asset/effects [POST] Usage Adds or replaces an effect on this asset. There are two methods of using this function. Changing a Single Value If you want to change a single attribute on an effect, you can specify the effect, the attribute and

/api/asset/effects

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/asset/effects There are three variants of this function, depending on which type of request you make. GET - Requests the list of effects on an asset. POST - Adds or replaces an effect on an asset. DELETE - Erases an effect from an asset.

/api/asset/id

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/asset/id Usage Return the identity of one or more ARDI assets based on their asset ID. This is primarily intended for allowing applications to show user-friendly names based on saved ARDI asset IDs, as unlike asset IDs, asset names may change during development or the lifespan of a particular asset.

/api/asset/info

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/asset/info Usage This function is used to get property information about a particular asset (specified with 'ID'). You can capture more complete information about an asset using /api/asset/detail, which includes relationship information, effects and media.

/api/asset/media

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/asset/media Usage Returns a list of media items associated with a given ARDI asset. Details DetailValueGroupAssetFrom Server Version0.9.0PermissionGuestMethodsGET or POST Parameters ParameterNotesMeaningidString [Required]The ID of the asset you want to get media for

/api/asset/property [DELETE]

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/asset/property [DELETE] Usage Removes a property from an asset. Details DetailValueGroupAssetFrom Server Version0.9.0PermissionAdminMethodsDELETE Parameters ParameterNotesMeaningidInteger [Required]The ID of the assetpropertyInteger [Required]The ID of the propertyformatString (xml)

/api/asset/property [GET]

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/asset/property [GET] Usage Returns the value of an asset property. Details DetailValueGroupAssetFrom Server Version0.9.0PermissionGuestMethodsGET Parameters ParameterNotesMeaningidInteger [Required]The ID of the assetpropertyInteger [Required]The ID of the propertyformatString (xml)

/api/asset/property [POST]

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/asset/property [POST] Usage Sets the value of an asset property. If you use the node parameter, you can specify the value of the individual property node (ie. you can set the position node of an assets location). If you do not use the node parameter, you will need to ensure you add a 'or-delimited' list of values. For example, if you are placing an asset, you would need to use

/api/asset/property

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/asset/property There are three variants of this function, depending on which type of request you make. GET - Requests the value of a property. POST - Sets the value of a property. DELETE - Erases a property from an asset.

/api/asset/propvalue

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/asset/propvalue Usage Scans the ARDI database and returns a list of property values across all assets. Rather than search every asset for a value, you can request properties from a list of assets using the asset parameter. Note: This function doesn't return the latest live values from properties that are bound to live data. However, it does return the

/api/asset/relate [DELETE]

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/asset/relate [DELETE] Usage Deletes an existing relationship between a given parent and child asset. Details DetailValueGroupAssetFrom Server Version0.9.0PermissionAdminMethodsPOST Parameters ParameterNotesMeaningparentInteger [Required]The ID of the upstream asset.

/api/asset/relate [GET]

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/asset/relate [GET] Usage Returns a list of all relationships that pass through a given asset. While you can request these values for grandchildren and great-grandchildren etc. using the indirect argument, we normally suggest using the more targeted

/api/asset/relate [POST]

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/asset/relate [POST] Usage Creates a relationship between a given parent and child asset. Details DetailValueGroupAssetFrom Server Version0.9.0PermissionAdminMethodsPOST Parameters ParameterNotesMeaningparentInteger [Required]The ID of the upstream asset.

/api/asset/relate

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/asset/relate There are three variants of this function, depending on which type of request you make. GET - Requests a list of the relationships on this asset. POST - Creates a new relationship between two assets. DELETE - Erases a relationship between two assets.

/api/asset/search

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/asset/search Usage This function is used to search for an asset based on a query string. This search follows the same rules as searching in the ARDI web interface, meaning that the system will explore all asset properties - including part numbers, ERNs, names, descriptions etc. - when searching.

/api/asset/set

anonymous@undisclosed.example.com (Anonymous) — Wed, 14 Jan 2026 04:42:00 +0000

/api/asset/set Usage This function is used to set the value of an asset property. Many properties have more than one 'node' (sub-value), such as measurements, which have 'measurement', 'min', 'max', 'units' and 'places'. You can choose to set a specific value by setting the

/api/asset/setlocation

anonymous@undisclosed.example.com (Anonymous) — Wed, 14 Jan 2026 04:56:34 +0000

/api/asset/setlocation Usage This function is used to set the physical location of an asset. You can set any combination of position, rotation and scale. The values must be made up of three floating-point numbers. For position and scale, these are measured in your

/api/asset/show

anonymous@undisclosed.example.com (Anonymous) — Wed, 14 Jan 2026 04:09:02 +0000

/api/asset/show Usage This function is used to search for an asset based on a query string and display a page in the users browser. This is often used when a 3rd party application wants to open ARDI information in a web browser to display to the user.

/api/auth

anonymous@undisclosed.example.com (Anonymous) — Tue, 13 Jan 2026 22:44:24 +0000

/api/auth Usage Authenticates against the ARDI server to allow elevated function execution. Note that you must call this function before calling any other ARDI function other than /api/connect when the server is not in guest mode. Note that this documentation covers the

/api/auth

anonymous@undisclosed.example.com (Anonymous) — Tue, 13 Jan 2026 22:16:59 +0000

/api/auth

anonymous@undisclosed.example.com (Anonymous) — Tue, 13 Jan 2026 22:15:49 +0000

/api/connect

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/connect Usage This function returns details about the ARDI server and its database configuration. Details DetailValueGroupServerFrom Server Version0.9.0PermissionPublicMethodsGET or POST Parameters ParameterNotesMeaningformatString (xml)Either 'xml' or 'json'

/api/getardetails

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/getardetails Usage This function is used to get detailed information about a particular asset. This includes live information, media files and relationships that the asset has with its neighbours. It's the most complete information available about the asset.

/api/getassethome

anonymous@undisclosed.example.com (Anonymous) — Thu, 15 Jan 2026 02:47:17 +0000

/api/getassethome Usage Returns the name and identity of the environment that a specific asset belongs inside. Primarily used for ARDI-VE. Details DetailValueGroupAssetFrom Server Version0.9.0PermissionGuestMethodsGET Parameters ParameterNotesMeaningid

/api/getconfiguration

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/getconfiguration Usage This function returns details about the ARDI database - specifically, information regarding properties, relationships, and detailed instructions on how to display both. Details DetailValueGroupServerFrom Server Version0.9.0

/api/lookuppoints

anonymous@undisclosed.example.com (Anonymous) — Wed, 14 Jan 2026 23:51:40 +0000

/api/lookuppoints Usage This function is used to bulk-convert point names in the asset.property format to point IDs for use with tools such as the live data API. Details DetailValueGroupAssetFrom Server Version2025.0.0PermissionGuestMethodsGET or POST Parameters

/api/metadata/property [DELETE]

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/metadata/property [DELETE] This function is not currently implemented in the ARDI API.

/api/metadata/property [POST]

anonymous@undisclosed.example.com (Anonymous) — Tue, 13 Jan 2026 22:56:08 +0000

/api/metadata/property [POST] Usage Creates a new property, or returns the ID of an existing property if one already exists. Details DetailValueGroupAssetFrom Server Version0.9.0PermissionAdminMethodsPOST Parameters ParameterNotesMeaningnameString [Required]

/api/metadata/property

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/metadata/property There are two variants of this function, depending on which type of request you make. POST - Creates a new property. DELETE - Erases an existing property.

/api/metadata/relation [DELETE]

anonymous@undisclosed.example.com (Anonymous) — Tue, 13 Jan 2026 23:05:09 +0000

/api/metadata/relation [DELETE] This function is not implemented yet, as it may be highly destructive.

/api/metadata/relation [POST]

anonymous@undisclosed.example.com (Anonymous) — Tue, 13 Jan 2026 23:05:43 +0000

/api/metadata/relation [POST] Usage Creates a new relationship, or returns the ID of an existing relationship if one already exists. Details DetailValueGroupAssetFrom Server Version0.9.0PermissionAdminMethodsPOST Parameters ParameterNotesMeaningnameString [Required]

/api/metadata/relation

anonymous@undisclosed.example.com (Anonymous) — Tue, 13 Jan 2026 22:57:32 +0000

/api/metadata/relation There are two variants of this function, depending on which type of request you make. POST - Creates a new relationship. DELETE - Erases an existing relationship.

/api/pins

anonymous@undisclosed.example.com (Anonymous) — Thu, 15 Jan 2026 00:55:12 +0000

/api/pins Usage This function is used to bulk-convert point names in ARDIs internal codes into human readable values. Point codes are made up of the asset id, property id and node delimited by a colon, such as 12:22:measurement. These can be queried one of two ways - with all of the pins in a

/api/search

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

/api/search Usage This function returns the ID numbers of ARDI assets based on text search. NOTE - We suggest the much more powerful selector addon or the use of AQL when searching for assets, as these provide much more data and are significantly more flexible

ARDI APIs

anonymous@undisclosed.example.com (Anonymous) — Tue, 13 Jan 2026 23:29:14 +0000

ARDI APIs You can communicate to ARDI via an extensive range of REST endpoints. Which APIs you use depend on your needs. Data Querying If you're looking for quick and easy access to data, we suggest using our AQL Query Language. This lets you access large amounts of time-synced data across many assets, using relationships to create dynamic, powerful queries.

ARDI Driver Guidelines

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

ARDI Driver Guidelines ARDI historical drivers have a set of guidelines that every history driver is supposed to follow if at all possible. No Point Should Have Overlapping Timestamps History drivers should not produce two values for the exact same timestamp. If there is a transition in a discrete state (ie. a boolean value changing from 'false' to 'true'), these two points should be offset by a small amount of time (ie. 0.1 seconds).

Asset IDs

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Asset IDs Every asset in ARDI has an internal numeric identifier - the Asset ID. In the API, you can discover what the ID for a particular asset is by using the /api/asset/search function.

Autosample

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Autosample The Autosample function of the HistoryFill class is used to dynamically Downsample or Upsample your data. Only use this function on analogue data points, and only if you haven't performed sampling in your driver already (ie. by sending queries that already interpolate or resample the data).

Backfill

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Backfill The Backfill function is part of the HistoryFill class, and is used to 'fill in' the value of a data point that is missing or had no valid values during the query range. This is usually used along-side MissingItems.

Basic Digital Signage Example

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Basic Digital Signage Example Digital signage SVG files use embedded Javascript code to make the SVG image respond to live data updates from ARDI. First, you prepare the image file in the vector image editor of your choice. For those with a limited budget,

Channel Objects

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Channel Objects A Channel object represents a single point of live ARDI data in the Python live data API. A channel contains the following members.. NameDescriptionnameThe name of the point, usually in ' ' format.valueThe value of the channel

PHP Driver Files: configure-source.php

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

PHP Driver Files: configure-source.php This file provides the user with a web user-interface for setting up the address for your data source. Below is an example from the text driver. 2) { $filename = $bits[0]; $delimiter = $bits[1]; $lo…

Creating an ARDI Historical Driver

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Creating an ARDI Historical Driver This tutorial will re-create the ARDI Historical Text driver as an example of how to create your own ARDI driver in Python. Many of the steps are very similar to those from our Creating an ARDI Live Driver tutorial - however the functions that we create are a little different.

Creating an ARDI Live Driver

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Creating an ARDI Live Driver This tutorial will re-create the OSI PI driver as an example of how to create your own ARDI driver in .NET The Sketch To begin, create a new console project in Visual Studio. In your Program.cs, you need to define two classes.

Creating an ARDI Live Driver

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Creating an ARDI Live Driver This tutorial will re-create the ARDI Live Text driver as an example of how to create your own ARDI driver in Python. The Sketch To begin, we will sketch out the basic structure of our Python script. First, create a new folder in

Creating an ARDI Event Driver

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Creating an ARDI Event Driver This tutorial will re-create the ARDI LogFile Event driver as an example of how to create your own ARDI driver in Python. Many of the steps are very similar to those from our Creating an ARDI Live Driver tutorial - however the functions that we create are a little different.

D3.JS API Example

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

D3.JS API Example This example shows how you can use D3s powerful visualisation tools with live ARDI data. The Base Page First, prepare a basic web page that.... * Contains an area for a bar chart, * Includes the required libraries from ARDI, JQuery and D3

ARDI Data Access API

anonymous@undisclosed.example.com (Anonymous) — Mon, 27 Apr 2026 22:47:46 +0000

ARDI Data Access API The two most common types of ARDI request are for live data and historical data. First, you'll need to find the Data Point Names of the properties you're interested in. These can be found using ARDIs query language, or API functions like lookuppoints. Once you've got those, you'll need to call either the

Data Point Names

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Data Point Names ARDI uses data point names, which is a unique identifier for each and every dynamic property. It's a code made up of three pieces separated by colons - the ID of the asset, the ID of the property and the name of the node. You can find the name of an ARDI data point by hovering your mouse over the name of the node in the

Data Points / Point Names

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Data Points / Point Names For every property or alert that is linked to live data, ARDI creates a point name. This is a unique identifier for that particular connection. When you use the live or historical data API, you use these names to find your values.

PHP Driver Files: decode.php

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

PHP Driver Files: decode.php This file is used by the ARDI user interface to convert the saved data link address (generated in encode.php) to something that can be read by human-beings. Below is an example from the text driver. Since there is only a single element in the address, we simply copy

Downsample

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Downsample The Downsample function is part of the HistoryFill class. It's used to decrease the amount of data transmitted to the ARDI server by summarising and/or aggregating data points. This allows users to query large time-periods of data without overwhelming the network or server.

PHP Driver Files:encode.php

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

PHP Driver Files:encode.php This file provides takes all of the choices that the user made in link.php and puts them into a single text string. This is then used as the address for the point and is available via self.core.points in the calls to Connect, Optimise

PHP Driver Files: friendlyname.php

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

PHP Driver Files: friendlyname.php This file is used by the ARDI user interface to convert the saved data source address (generated in saveconfig-source.php) to something that can be read by human-beings. Below is an example from the text driver.

Finish

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Finish The Finish function of the HistoryFill class is used to write all of the resulting history back to the ARDI server. This should be called before calling the Finish function of the Query class. Example history = histhelper.HistoryFill() history.RecordAnalogue('Testing',datetime.datetime.now(),24) history.Finish() return query.Finish()

HistoryFill

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

HistoryFill The histhelper library and its HistoryFill class are designed to make it easy to get ARDI drivers to behave in the expected fashion. Instead of writing directly to the query, you instead write all of the data you extract from the data source to an instance of the

Historical Data API

anonymous@undisclosed.example.com (Anonymous) — Mon, 27 Apr 2026 23:05:44 +0000

Historical Data API The Historical Data API allows you to fetch historical information about ARDI assets. Historical queries are performed using a HTTP GET or POST request on /api/gethistorybulk. Alternatives Please note that each channel of data returned from this function may be at its own unique time resolution. Some data may have sub-second resolution while other points may only update once a minute, or not at all.

PHP Driver Files: info.inc

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

PHP Driver Files: info.inc This file provides ARDI with the human-readable name for your driver. Below is an example from the text driver. :::'; $src['linkformat'] = ''; ?>

ARDI SDK/API

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

ARDI SDK/API ARDI is designed with openness in mind. For that reason, we are happy for our users to connect 3rd party software to ARDI to consume our information. We also want to give you the most flexible driver solution possible, so you can read unusual or unique data sources into ARDI.

Javascript/Digital Signage API

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Javascript/Digital Signage API Although it is still available, you may want to consider Data-Responsive SVG documentation for a more up-to-date and powerful version of this API. ARDI includes a Javascript API to access live data in HTML pages and SVG images. It's quite simple to use (particularly combined with JQuery) and requires only a few lines of code to get working.

Javascript Live Data API

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Javascript Live Data API Location The Javascript API files are actually included in the ARDI installation - they are located in /plugins/optrix/ardiclient.js. Usage The ARDI client class is called ARDIHMI. Below is an example of using the API...

PHP Driver Files: link.php

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

PHP Driver Files: link.php This file provides the user with a web user-interface for setting up the address for your individual data link (the connection between a property and a data source). The structure is very similar to that of configure-source.php. Below is an example from the

Live Data API

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Live Data API Access to live data is via the consolidator - a service that is specifically designed to provide the latest information to clients. The consolidator is accessed with HTTP (REST) calls. You can access live information either though a

MissingItems

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

MissingItems The MissingItems function is part of the HistoryFill class, and is used on those unusual cases where you are requesting data before the data point has any recorded information. Because of this, not all drivers may choose to support the function and instead return empty results.

.NET Driver Developer SDK

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

.NET Driver Developer SDK ARDI includes a library of files to assist in the rapid creation of ARDI drivers. Most drivers built by Optrix are deliberately left open and documented so they can be used as basis for 3rd parties to create their own drivers. They can also be copied and enhanced if your application needs very specific alterations.

API Permission Levels

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

API Permission Levels There are three main permission levels with API functions in ARDI, shown in order of lowest to highest security... * Public * Guest * Admin Public-Access Functions Public access functions are available to everyone without any form of authentication.

Property IDs

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Property IDs Every property in ARDI has an internal numeric identifier - the Property ID. In the API, you can discover what the ID for a particular property is by using the /api/getconfiguration function.

Python Driver Developer SDK

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Python Driver Developer SDK ARDI includes a library of files to assist in the rapid creation of ARDI drivers. Most drivers built by Optrix are deliberately left open and documented so they can be used as basis for 3rd parties to create their own drivers. They can also be copied and enhanced if your application needs very specific alterations.

Python Live Data API

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Python Live Data API This API allows you to create Python applications that utilise ARDI live data. Usage Example from ardi.api.ardiapi as ardiapi #Connnect to the ARDI server ardi = ardiapi.Server("","") if ardi.Connect() == False: sys.exit(0) #Create a live-data session sub = ardiapi.Session(ardi) mychannel = sub.AddChannel('','') def ProcessNewValues(values): echo str(values) sub.Callback(ProcessNewValues) sub.Start() sub…

RecordAnalogue

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

RecordAnalogue The RecordAnalogue function of the HistoryFill class is used to record the history of an analogue point. Parameters ParameterTypeUsageAddressstringThe full address of the data pointDatedatetimeThe UTC date/time of the data pointValuevariesThe value recorded

RecordDiscrete

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

RecordDiscrete The RecordDiscrete function of the HistoryFill class is used to record the history of a discrete point. Parameters ParameterTypeUsageAddressstringThe full address of the data pointDatedatetimeThe UTC date/time of the data pointValuevariesThe value recorded

Relationship IDs

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Relationship IDs Every relationship in ARDI has an internal numeric identifier - the Relationship ID. In the API, you can discover what the ID for a particular relationship is by using the /api/getconfiguration function.

Alert Functions

anonymous@undisclosed.example.com (Anonymous) — Thu, 15 Jan 2026 00:57:08 +0000

Alert Functions /api/asset/allalerts - Get a list of all ARDI alerts and their current state /api/asset/active - Get a list of currently active ARDI alerts Event Functions /api/event/search - Search for Events ---------- See Also Core Asset Metadata Data Point

REST API Flow

anonymous@undisclosed.example.com (Anonymous) — Tue, 13 Jan 2026 23:30:20 +0000

REST API Flow Using the ARDI REST API usually follows a pattern similar to the one found below... /api/connect to connect to the server and discover important details about it. /api/auth (optionally) authorise yourself to call elevated functions, if required You can then call functions from appropriate

Asset Functions

anonymous@undisclosed.example.com (Anonymous) — Thu, 15 Jan 2026 02:29:14 +0000

Asset Functions These are the asset functions that are part of the ARDI REST API. These functions are suitable for products that want to integrate tightly with an ARDI system. If you simply want to query data, we suggest the more powerful selector system and ARDI Query Language. Common Functions

Core Functions

anonymous@undisclosed.example.com (Anonymous) — Thu, 15 Jan 2026 00:55:50 +0000

Core Functions /api/auth - Authenticate yourself with the ARDI server to allow elevated function access. /api/connect - Used to get important data about the ARDI server, and usually the first call you make. /api/getconfiguration - Used to discover the properties and relationships present in an ARDI system

/api/events/search

anonymous@undisclosed.example.com (Anonymous) — Wed, 14 Jan 2026 00:11:34 +0000

/api/events/search Usage This function is used to get a list of events that meet specific criteria. Most commonly, this is a date range, but you can also limit other factors such as the sources of data you want to search through. You can set a number of

REST Function Reference - By Endpoint

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

REST Function Reference - By Endpoint /api/addon - Check to see if a given addon is enabled. /api/auth - Authenticate with the ARDI server to use functions with elevated permissions /api/behaviour - Add or remove asset effects /api/search - Search for assets /api/connect - Confirm the identity of the server and get settings

REST Function Reference - By Type

anonymous@undisclosed.example.com (Anonymous) — Wed, 14 Jan 2026 23:41:36 +0000

REST Function Reference - By Type Core Asset Alert and Event Metadata Data Points

Core API

anonymous@undisclosed.example.com (Anonymous) — Tue, 13 Jan 2026 23:29:38 +0000

Core API The Core REST API for ARDI allows you to integrate 3rd party software with your ARDI system. These libraries are designed to let you create, query and modify ARDI assets and to explore relationships. Note that these addons are focused more on

Metadata Functions

anonymous@undisclosed.example.com (Anonymous) — Thu, 15 Jan 2026 00:56:20 +0000

Metadata Functions All Functions /api/metadata/property - Add, edit and delete property IDs /api/metadata/relation - Add, edit and delete relationship IDs ---------- See Also Core Asset Alert and Event Data Point

Data Point Functions

anonymous@undisclosed.example.com (Anonymous) — Wed, 14 Jan 2026 23:43:38 +0000

Data Point Functions All Functions /api/lookuppoints - Translate point names into IDs /api/pins - Translate point IDs into names ---------- See Also Core Asset Alert and Event Data Point

PHP Driver Files: saveconfig-source.php

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

PHP Driver Files: saveconfig-source.php This file provides takes all of the choices that the user made in configure-source.php and puts them into a single text string. This is then used as the address for the data source and sent to the Python driver in the call to Connect

SetInitialValue

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

SetInitialValue The SetInitialValue function sets the value of a specific data point before the query range begins. It's part of the HistoryFill class, and is used to provide boundary-filling functionality to ARDI drivers. Industrial historians and high-quality time-series databases will often ensure that you get 'bounding values' around the time-range you request. For example, if you query data between 9:12 and 9:50, you'll get values at those times

Signing Your Requests

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Signing Your Requests Because most ARDI instances are installed in secure networks or have strict firewall control, the ARDI API request signing mechanism is currently fairly basic. To sign your request, you simply need to include your authcode (returned from a request to

Snapshot (Live Data API Function)

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Snapshot (Live Data API Function) This function returns a snapshot containing the current values of the Data Points / Point Names you request. The return is very similar to the response you get from subscribe - however, there is no subscription ID. Details URL/snapshotMethodGET or POST

SplitAddresses

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

SplitAddresses The SplitAddresses function of the HistoryFill class is used to split the requested set of addresses into discrete and analogue values. This is because the two types of point should be loaded differently. Discrete values should always be extracted

Subscribe (Live Data API Function)

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Subscribe (Live Data API Function) This function sets up a 'subscription' to the Live Data API. A subscription allows you to poll for updated data with the update function. This will only return the information that has changed since your last call to either

Unsubscribe (Live Data API Function)

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Unsubscribe (Live Data API Function) Closes a subscription created with the subscribe function. Note that subscriptions are automatically closed after a certain amount of time without a call to update. However, where possible it is preferred that you explicitly close your subscription.

Update (Live Data API)

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Update (Live Data API) Returns the values of all Data Points / Point Names that have changed (or no values if there have been no changes within 30 seconds). ARDI uses a long polling model, which means that when you request an update, you might not get an immediate response. Instead, the server may hold your connection open while it waits for fresh data.

Upsample

anonymous@undisclosed.example.com (Anonymous) — Thu, 18 Dec 2025 22:50:17 +0000

Upsample The Upsample function is part of the HistoryFill class. It's used to increase the resolution of low-res data by interpolating between the recorded points. This is useful when you have unusually coarse data - such as hourly figures in a system where most of your data has 1s resolution. As such, this function is often used when bringing in information from