Assets

An Asset represents a piece of physical equipment such as a generator, a utility feed, a feeder or a transfer switch. Assets group the Variables that describe the equipment and drive Asset-based features like reports.

Workflow Stage: Integrate

List Assets

GET https://api.controlcomtech.com/primary/v1/<organizationId>/assets

Requires the ReadAssets permission. Multi-value filters repeat the parameter with brackets.

Name
search
Type
string
Description
Case-insensitive filter on the Asset name.
Name
types[]
Type
string[]
Description
Limit to classifications: GENERIC, ELECTRICAL_GENERATOR, ELECTRICAL_UTILITY, ELECTRICAL_FEEDER, ELECTRICAL_ATS.
Name
locationIds[]
Type
string[]
Description
Limit to Assets at these Locations.
Name
skip
Type
integer
Description
Records to skip. See Pagination.
Name
take
Type
integer
Description
Records to return per page.

curl 'https://api.controlcomtech.com/primary/v1/<organizationId>/assets?types[]=ELECTRICAL_GENERATOR&take=25' \
--header 'Authorization: Basic <Base64 encoded key ID and secret>'

Retrieve an Asset

GET https://api.controlcomtech.com/primary/v1/<organizationId>/assets/<assetId>

Requires the ReadAssets permission. Returns the Asset with its bound Variables.

Create an Asset

POST https://api.controlcomtech.com/primary/v1/<organizationId>/assets

Requires the CreateAsset permission.

Name
name
Type
string
Description
Required, 2 to 100 characters.
Name
description
Type
string | null
Description
Optional, up to 500 characters.
Name
classificationType
Type
string
Description
Optional. GENERIC, ELECTRICAL_GENERATOR, ELECTRICAL_UTILITY, ELECTRICAL_FEEDER or ELECTRICAL_ATS.
Name
classificationDetails
Type
object | null
Description
Optional classification-specific settings. A generator, for example, can carry its make, model, rated values and the Variables that track its running hours.
Name
locationId
Type
string | null
Description
Optional. The Location this Asset belongs to.
Name
dashboardId
Type
string | null
Description
Optional. A Dashboard associated with this Asset.
Name
parentId
Type
string | null
Description
Optional. A parent Asset, for building equipment hierarchies.

Update an Asset

PATCH https://api.controlcomtech.com/primary/v1/<organizationId>/assets/<assetId>

Requires the UpdateAsset permission. Accepts the same fields as create, all optional.

Delete an Asset

DELETE https://api.controlcomtech.com/primary/v1/<organizationId>/assets/<assetId>

Requires the DeleteAsset permission.

Bind Variables to an Asset

POST https://api.controlcomtech.com/primary/v1/<organizationId>/assets/<assetId>/bindings

Requires the UpdateAsset permission. Connects a Device Variable to the Asset or disconnects it again.

Name
variableId
Type
string
Description
Required. The Device Variable to connect or disconnect.
Name
action
Type
string
Description
Required. CONNECT or DISCONNECT.

To bind several Variables in one call, POST to /assets/<assetId>/bindings/batch with variableIds (an array) and the same action. Both endpoints return the updated Asset with its Variables.