DemandFlow Support Centre

CARBONPROFILE: Carbon Profile

ReferenceEntity Reference16/04/2026Updated 16/04/2026
A reusable equipment template defining the daily carbon footprint of a role or individual. Lists equipment items with usage rates that sum to a daily kgCO2e total.

CARBONPROFILE: Carbon Profile

A reusable equipment template defining the daily carbon footprint of a role or individual. Lists equipment items with usage rates that sum to a daily kgCO2e total.

Default definition. This article describes the default CARBONPROFILE 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 CARBONPROFILE.

Entity properties

PropertyValue
Entity codeCARBONPROFILE
Display nameCarbon Profile
PluralCarbon Profiles
Level72050

Use cases

Header entity for carbon equipment profiles. Assigned to STF (specific person) or RES (abstract role) via objectLookup. Child entity CARBONPROFILELINE holds the individual equipment items. The workingPattern field helps the recalculate function adjust for office vs site vs hybrid workers. The totalKgCO2ePerDay is a calculated readonly field updated when profile lines change.

Fields

General: Profile Details

FieldTypeRequiredNotes
nametextYesProfile name. Placeholder: e.g. Site Engineer, Office PM, Plant Operator.
descriptiontext (multi-line)Description.
workingPatternenumWorking pattern. Valid ids: site (Site-based), office (Office-based), hybrid (Hybrid), remote (Remote), mobile (Mobile / field).
statusenumStatus. Valid ids: active (Active), archived (Archived).
totalKgCO2ePerDaynumberRead-only. Total kgCO2e per day.

Relationships

  • Related lists: CARBONPROFILELINE (format SUB|CARBONPROFILE).

Creating a Carbon Profile via the API

POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json

{
  "entity":   "CARBONPROFILE",
  "level":    72050,
  "comboKey": "SUB:<your-sub-id>|ENT:",
  "name": "Profile name",
  "description": "Description",
  "workingPattern": "site",
  "status": "active"
}

Listing Carbon Profiles records

GET /v1/entities/CARBONPROFILE/SUB

See also

carbonprofilecarbon profilecarbon profilescarbonprofiles

Was this article helpful?

← Back to Knowledge Base