Sign in

v3

latestOpenAPI 3.1.02026-08-0797185285.8 KB

Patch Component

Updates a component in the Isometric system. Associated GHG entries will be recalculated, if they are not in an immutable state.

patch/components/{id}

Path parameters

idstring required
Example:cmp_1EP2SB7MZ1S036PY

Headers

x-client-secretstring required

A secret token identifying the client connecting to the API

Example:Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP

A secret token identifying the client connecting to the API

Request body

Example request

{
  "inputs": [
    {
      "datapoint_ids": [
        "dtp_1DVKHKS101S0Q61Q"
      ]
    }
  ]
}

Response

Successful Response

idstring required
supplier_reference_idstring nullable required

A string that must be unique for all resources created by a specific supplier. It can be used by a client to identify the correct objects in their system.

type'ACTIVITY' | 'REMOVAL_COUNTERFACTUAL' | 'SEQUESTRATION' | 'LOSS' | 'ADJUSTMENT' | 'UNCERTAINTY_DISCOUNT' required
scope'REMOVAL' | 'GHG_STATEMENT' | 'PROJECT' | 'NET_NEGATIVITY' required
display_namestring required
descriptionstring nullable required
activity_completed_atstring date-time nullable required
activity_started_atstring date-time nullable required
blueprint_keystring required
removal_template_component_idstring nullable required

The ID of the removal template component, if this component was created via a template. May be null if the component was created directly, or if the template has been deleted.

ghg_entry_template_component_idstring nullable required

The ID of the GHG entry template component, if this component was created via a template. May be null if the component was created directly, or if the template has been deleted.

allocation_strategy'ESTIMATED_PROJECT_TONNAGE' | 'MANUAL' | 'CUSTOM_TIME_PERIOD' | 'ESTIMATED_PROJECT_LIFETIME'

Strategies which control how Project Emissions are automatically amortized and attributed to GHG Statement and GHG entries

ESTIMATED_PROJECT_TONNAGE - Automatic amortization ensuring full amortization in proportion to the project's estimated gross removal.

MANUAL - No automatic amortization. All GHG Statement and GHG entry attributions are performed manually.

CUSTOM_TIME_PERIOD - Automatic amortization ensuring full amortization by a specified target date.

ESTIMATED_PROJECT_LIFETIME - Automatic amortization ensuring full amortization over the project's estimated lifetime.

Example response

{
  "id": "cmp_1EP2SB7MZ1S036PY",
  "removal_template_component_id": "rtc_1DAA58EDM1S0AMPN",
  "ghg_entry_template_component_id": "rtc_1DAA58EDM1S0AMPN",
  "inputs": [
    {
      "datapoint_ids": [
        "dtp_1DVKHKS101S0Q61Q"
      ]
    }
  ]
}