OverviewCopied!

This page describes the object hieararchy in the Command Console API.

The object hierarchy is relatively important to understand to properly access and update asset data using our API. It describes how to programmatically explore and identify assets.

There is an object query hierarchy and an object ownership hierarchy.

• The query hierarchy is how you are expected to search for and populate lists of assets at various levels.

• The ownership hierarchy dictates which asset types own other asset types internally within Command Console. This is only meaningful for API users informationally as they explore response data (e.g. charger data will include an associated PowerNode ID).

Query HierarchyCopied!

The query hierarchy is outlined below:

• Organization

  • Site

    • PowerNode

    • Charger

    • Transaction

The root object is the organization. You can identify your organization ID using Command Console. Go to the Command Console dashboard, click on API Access, and look for the organization ID as indicated below:

From this, you can query the API for the list of sites associated with the given organization.

And from there, you can query for a site’s chargers, PowerNodes, and transactions.

Ownership HierarchyCopied!

The ownership hierarchy is outlined below:

• Organization

  • Site

    • PowerNode

      • Charger

        • Transaction

As with the query hierarchy, the root object is the organization. However, in terms of asset ownership, a strict order is enforced. Transactions belong to chargers, which in turn belong to PowerNode battery systems, which belong to sites, and so on and so forth.

This is done to ensure proper association for other functions the site performs (for example, a battery system that is reducing grid draw for a set of chargers it is physically connected to).

As an API user, you do not generally need to worry about ownership hierarchy.