ISisometric

Patch Component

Changed on

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

patch/components/{id}

Request

  • Base URL
    https://api.isometric.com/mrv/v0
  • URL
    https://api.isometric.com/mrv/v0/components/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required
Example:cmp_1EP2SB7MZ1S036PY

Headers

x-client-secretstring required

A secret token identifying the client connecting to the API

Example:Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP

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' | 'COUNTERFACTUAL' | 'SEQUESTRATION' | 'LOSS' | 'ADJUSTMENT' | 'REDUCTION' | '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_REMOVAL_TONNAGE' | 'MANUAL' | 'CUSTOM_TIME_PERIOD' | 'ESTIMATED_PROJECT_LIFETIME' | 'ESTIMATED_PROJECT_REDUCTION_TONNAGE'

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

ESTIMATED_PROJECT_REMOVAL_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, or 20 years, whichever is shorter.

ESTIMATED_PROJECT_REDUCTION_TONNAGE - Automatic amortization ensuring full amortization in proportion to the project's estimated gross reduction.

Example response

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

Changes

  • e0d342ff70d6Revision changes
    • breaking

      for the path request parameter id, the minLength was increased from 0 to 20

    • warning

      for the path request parameter id, the maxLength was set to 37

    • info

      for the path request parameter id, the type was generalized from no type to string

  • cd935e738ca2Revision changes
    • breaking

      removed the enum value ESTIMATED_PROJECT_TONNAGE of the request property /

    • warning

      added the new ESTIMATED_PROJECT_REMOVAL_TONNAGE enum value to the / response property for the response status

    • info

      added the new ESTIMATED_PROJECT_REMOVAL_TONNAGE enum value to the request property /

    • info

      removed the ESTIMATED_PROJECT_TONNAGE enum value from the / response property for the response status