Assets API - Introduction

Discover the power of our Assets API, your key to manage the asset domain. By leveraging the Assets API, developers can easily get all assets in a fleet as well as update specifications for an asset. This REST API also allows to manage assets across accounts by enabling the share, transfer, unshare and remove visibility actions. For more information, see the documentation of the endpoints.

📘

IrisX customers can also access data connected to Asset(s) via the GraphQL API

Via the Public GraphQL API, you can utilize query capabilities to fetch data connected to asset(s) and other domains which would be multiple separate calls in the REST APIs. Additionally you can perform mutations to modify data associated with asset(s). Explore the GraphQL schema through our GraphQL Explorer. Learn more about the IrisX subscription.

🚧

No onboarding / offboarding support of machine type assets

The Assets API currently does not support onboarding or offboarding assets with the MACHINE asset type. Furthermore, the telematics devices are currently limited to Bluetooth telematics devices. See the Machine Onboarding API for those operations for now.

Concepts

Assets are core entities that represent various machines, equipment, tools and attachments on the Iris platform. The handles provided in the API's endpoints allow for easy asset management intended for system-to-system integration.

Assets have the following properties:

  • An asset is a trackable piece of equipment divided into several subtypes; machine, equipment, tool or attachment.
  • Assets can have zero to many telematics devices associated with them

Asset Types

TypeDescription
MachineA large powered asset.
EquipmentA non-powered asset.
ToolA small powered asset.
AttachmentA thing which can be added/attached to something else (machine or equipment) in order to make it more useful or versatile.
OtherAnything not fitting into the other asset types.