CARBONPROFILELINE: Carbon Profile Line
A single equipment item within a carbon profile, defining usage rate per day and the associated carbon factor.
Default definition. This article describes the default
CARBONPROFILELINE definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches CARBONPROFILELINE.Entity properties
| Property | Value |
|---|---|
| Entity code | CARBONPROFILELINE |
| Display name | Carbon Profile Line |
| Plural | Carbon Profile Lines |
| Level | 72060 |
Use cases
Child entity of CARBONPROFILE via SUB|CARBONPROFILE comboKey. Each line represents one piece of equipment (laptop, monitor, van, generator, etc.) with a link to CARBONFACTOR for the emission rate. The kgCO2ePerDay is calculated: usagePerDay x carbonFactor.kgCO2e. The scope is derived from the linked CARBONFACTOR.
Fields
General: Equipment Item
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Equipment description. Placeholder: e.g. Laptop, Company van, Site lighting rig. |
carbonFactor | reference → CARBONFACTOR | Yes | Carbon factor. |
usagePerDay | number | Yes | Number of units consumed per working day (e.g. 8 hrs, 15 litres, 1 day) |
usageUnit | text | Usage unit. Placeholder: e.g. hours, litres, kWh, units. |
General: Calculated Emissions
| Field | Type | Required | Notes |
|---|---|---|---|
scope | enum | Derived from the carbon factor Valid ids: 1 (Scope 1), 2 (Scope 2), 3 (Scope 3). | |
carbonFactorRate | relatedProperty | Factor rate (kgCO2e/unit). | |
kgCO2ePerDay | number | Read-only. Usage per day x carbon factor rate |
Relationships
- Lookups:
carbonFactorpoints at aCARBONFACTORrecord.
Creating a Carbon Profile Line via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "CARBONPROFILELINE",
"level": 72060,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Equipment description",
"carbonFactor": "",
"usagePerDay": 0,
"usageUnit": "Usage unit"
} Listing Carbon Profile Lines records
GET /v1/entities/CARBONPROFILELINE/SUB