ISisometric

Patch Ghg Entry Components

Changed on

Change component attributions for the GHG entry.

patch/ghg_entries/{id}/component_attributions

Request

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

Path parameters

idstring required
Example:rmv_1EEM6NJXX1S0EXKD

Headers

x-client-secretstring required

A secret token identifying the client connecting to the API

Example:Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP

Request body

Example request

{
  "components_to_add": [
    {
      "component_id": "cmp_1EP2SB7MZ1S036PY",
      "component_group_key": "bio-oil-storage"
    }
  ],
  "components_to_remove": [
    "cmp_1EP2SB7MZ1S036PY"
  ]
}

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.

started_onstring date required
completed_onstring date required
credit_type'REDUCTION' | 'REMOVAL' required
co2e_net_removed_kgnumber required

The CO₂e removed by this GHG entry once uncertainty discounting has been applied

co2e_net_removed_without_discount_kgnumber required

The CO₂e removed by this GHG entry before any uncertainty discounting has been applied

co2e_net_removed_standard_deviation_kgnumber nullable required

The standard deviation of the CO₂e net removed and therefore the uncertainty discount applied to the GHG entry

ghg_statement_idstring nullable required

The GHG statement ID that this entry is associated with. If null, the entry is in draft and has not been submitted for verification.

feedstock_type_idstring nullable required

The feedstock type ID that this entry is associated with.

risk_of_reversal_percentagenumber nullable required

The percentage of credits contributed to the buffer pool due to risk of reversal.

Example response

{
  "id": "rmv_1EEM6NJXX1S0EXKD",
  "ghg_statement_id": "ggs_1GDQJ99Z51S0DYW9",
  "feedstock_type_id": "ftt_1D7KZ1P761S0G7BN"
}

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

  • a29120dd7406Revision changes
    • info

      endpoint added