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 integration than they are on data access. If your main goal is to access data (and history in particular), you should instead consider our query language, or addons such as our GraphQL and PowerBI addons.

ARDIs own clients use these REST APIs, along with the selector system and AQL query language.

REST API Flow
REST Function Reference - By Type

Please note that the API currently does not offer endpoints to delete ARDI assets, relationships or the properties themselves.

Properties and relationships can be removed from assets, but not removed all-together from the system.

Assets can be moved and renamed, but not erased.

At the moment, this is intentional.

Because of how destructive removing the incorrect asset or property may be, functions to permanently delete assets/properties/relationships have been designed but have not yet been implemented. If a customer or integrator has a legitimate need for these functions, please let us know and we will be able to prioritise their development.

At the current time, we suggest that solutions that remove assets should place those redundant assets under an out-of-the-way part of the Location hierarchy to be manually deleted at a later date, or re-used when extra assets are needed.

If you want a dynamic set of assets - representing items that only exist temporarily on-site, such as delivery vehicles or outgoing pallets - we suggest creating a pool of assets to draw from, re-using assets as required.

Let's say you're running a warehouse or port and you want to have assets representing each of the trucks/ships in the area, but don't want to keep these assets permanently.

In this case, you could have a section in the Location hierarchy called Stand-By Vehicles. When a new truck/ship comes in, you check to see if there are any assets in the 'Stand By Vehicles' Location. If there is one, you take it, set the values for registration number, name, owner etc, and add it to the appropriate Location on site. If there isn't one, you create a new asset and set all of its details.

When that truck/ship leaves, you remove it from the current Location and place it back into 'Stand By Vehicles'.