The Collective object - re.alto Docs

API Reference

Core Resources

Onboarding API

Entity Onboarding
Collective Onboarding
Guided Onboarding

Readings API

Readings
Aggregations

Commands API

Charge Sessions API

GET
List all Charge Sessions

Entity Settings

Features
Locations
Battery Capacity
Heated Area
Disaggregators
Custom Properties

Offboarding API

Offboard Entities

Collectives are created by completing an Collective Onboarding Request.

A Collective

entities

string[] | null

The Entities of the Collective

string

The id of the Collective

name

string | null

The name of the Collective

owner

string

The owner of the Collective

properties

any | null

The custom properties of the Collective

type

enum<string>

Types of a Collective.

Available options:

Community,

Household,

Fleet,

SolarFarm,

WindFarm,

VirtualPowerPlant

tenantId

string

The tenant id the collective belongs to

Was this page helpful?

Remove permissions Retrieve a Collective

{
  "entities": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "properties": "<any>",
  "type": "Community",
  "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}