PATCH
/
removals
/
{id}
/
component_attributions
Patch Removal Components
curl --request PATCH \
  --url https://api.sandbox.isometric.com/mrv/v0/removals/{id}/component_attributions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-client-secret: <x-client-secret>' \
  --data '{
  "components_to_add": [
    {
      "attribution_factor": 1,
      "component_group_key": "bio-oil-storage",
      "component_id": "cmp_1EP2SB7MZ1S036PY"
    }
  ],
  "components_to_remove": [
    "cmp_1EP2SB7MZ1S036PY"
  ]
}'
{
  "co2e_net_removed_kg": 123,
  "co2e_net_removed_standard_deviation_kg": 123,
  "co2e_net_removed_without_discount_kg": 123,
  "completed_on": "2023-12-25",
  "feedstock_type_id": "ftt_1D7KZ1P761S0G7BN",
  "ghg_statement_id": "ggs_1GDQJ99Z51S0DYW9",
  "id": "rmv_1EEM6NJXX1S0EXKD",
  "label_ids": [
    "lbl_1DDK2MJ2D1S0SR6H"
  ],
  "started_on": "2023-12-25",
  "supplier_reference_id": "<string>"
}
Components can be fully or partially attributed to removals via the components_to_add field. To partially attribute the component, provide the attribution_factor as a fraction between 0 and 1. And to fully attribute the component, set the attribution_factor to 1 (or omit it, as it defaults to 1). To update the attribution for an already attributed component, call the endpoint again with the component in the components_to_add field and a new attribution factor. The sum of a component’s attributions across all removals cannot be greater than 1. Components can also be removed from a removal via the components_to_remove field.

Authorizations

​
Authorization
string
header
required

A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>

Headers

​
x-client-secret
string
required

A secret token identifying the client connecting to the API

Examples:

"Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"

Path Parameters

​
id
string
required

Body

application/json
​
components_to_add

Components to be attributed to Removal.

​
components_to_remove

Components to be fully removed from Removal.

Response

Successful Response

​
co2e_net_removed_kg
number
required

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

​
co2e_net_removed_standard_deviation_kg
number | null
required

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

​
co2e_net_removed_without_discount_kg
number
required

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

​
completed_on
string<date>
required
​
feedstock_type_id
string | null
required

The feedstock type ID that this removal is associated with.

Required string length: 20 - 37
Examples:

"ftt_1D7KZ1P761S0G7BN"

"ftt_1CSRJN4HHSBXZ3TK"

​
ghg_statement_id
string | null
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.

Required string length: 20 - 37
Examples:

"ggs_1GDQJ99Z51S0DYW9"

"ggs_1FWVEQRWSSBXK3NB"

​
id
string
required
Required string length: 20 - 37
Examples:

"rmv_1EEM6NJXX1S0EXKD"

"rmv_1E3V4J2EWSBX5E82"

​
label_ids
string[]
required

The label IDs that this removal is associated with.

​
started_on
string<date>
required
​
supplier_reference_id
string | null
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.

Required string length: 1 - 100