Sign in

v3

latestOpenAPI 3.1.02026-08-0797185285.8 KB

Patch Removal

Updates a removal in the Isometric system. The removal will be recalculated, if it is are not in an immutable state.

patch/removals/{id}

Path parameters

idstring required
Example:rmv_1EEM6NJXX1S0EXKD

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

started_onstring date nullable

Date in ISO format (YYYY-MM-DD)

completed_onstring date nullable

Date in ISO format (YYYY-MM-DD)

Example request

{
  "delete_component_ids": [
    "cmp_1EP2SB7MZ1S036PY"
  ],
  "add_components": [
    {
      "component_id": "cmp_1EP2SB7MZ1S036PY",
      "removal_template_group_id": "rtg_1EGQ9DZXZ1S05S28",
      "attribution_factor_datapoint_id": "dtp_1DVKHKS101S0Q61Q"
    }
  ],
  "feedstock_type_id": "ftt_1D7KZ1P761S0G7BN"
}

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
co2e_net_removed_kgnumber required

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

co2e_net_removed_without_discount_kgnumber required

The CO₂e removed by this removal 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 removal

ghg_statement_idstring nullable required

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

feedstock_type_idstring nullable required

The feedstock type ID that this removal 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"
}