Skip to main content
PATCH
/
components
/
{id}
Patch Component
curl --request PATCH \
  --url https://api.sandbox.isometric.com/mrv/v0/components/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-client-secret: <x-client-secret>' \
  --data '
{
  "allocation_strategy": {
    "__typename": "Undefined"
  },
  "description": {
    "__typename": "Undefined"
  },
  "display_name": {
    "__typename": "Undefined"
  },
  "inputs": {
    "__typename": "Undefined"
  }
}
'
{
  "activity_completed_at": "2023-11-07T05:31:56Z",
  "activity_started_at": "2023-11-07T05:31:56Z",
  "blueprint_key": "<string>",
  "description": "<string>",
  "display_name": "<string>",
  "id": "<string>",
  "inputs": [
    {
      "datapoint_ids": [
        "<string>"
      ],
      "input_key": "<string>",
      "__typename": "ComponentListInput"
    }
  ],
  "scope": "REMOVAL",
  "supplier_reference_id": "<string>",
  "type": "ACTIVITY",
  "allocation_strategy": "ESTIMATED_PROJECT_TONNAGE"
}

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 A secret token identifying the client connecting to the API

Path Parameters

​
id
string
required

Body

application/json
​
allocation_strategy
default:{"__typename":"Undefined"}

Allocation strategy to change the component to. This can only be set on project-scoped components.

Available options:
ESTIMATED_PROJECT_TONNAGE,
MANUAL,
CUSTOM_TIME_PERIOD,
ESTIMATED_PROJECT_LIFETIME
​
description
default:{"__typename":"Undefined"}
​
display_name
default:{"__typename":"Undefined"}
Required string length: 1 - 100
​
inputs

Overwrite existing component inputs

  • CreateComponentListInput
  • CreateComponentScalarInput

Response

Successful Response

​
activity_completed_at
string<date-time> | null
required
​
activity_started_at
string<date-time> | null
required
​
blueprint_key
string
required
​
description
string | null
required
​
display_name
string
required
​
id
string
required
Required string length: 20 - 37
​
inputs
(ComponentListInput · object | ComponentScalarInput · object)[]
required

A list of component inputs. The inputs can be either scalars or list inputs.

  • ComponentListInput
  • ComponentScalarInput
​
scope
enum<string>
required
Available options:
REMOVAL,
GHG_STATEMENT,
PROJECT,
NET_NEGATIVITY
​
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
​
type
enum<string>
required
Available options:
ACTIVITY,
COUNTERFACTUAL,
SEQUESTRATION,
LOSS,
REDUCTION,
UNCERTAINTY_DISCOUNT
​
allocation_strategy
enum<string> | null

Attribution strategy, manages how project-scoped components are distributed across GHG statements; value will be Null if scope is not of scope project

Available options:
ESTIMATED_PROJECT_TONNAGE,
MANUAL,
CUSTOM_TIME_PERIOD,
ESTIMATED_PROJECT_LIFETIME