Documentation

Post Project Component

curl --request POST \
  --url https://api.sandbox.isometric.com/mrv/v0/project_components \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-client-secret: <x-client-secret>' \
  --data '
{
  "component_data": {
    "activity_completed_at": "2023-11-07T05:31:56Z",
    "activity_started_at": "2023-11-07T05:31:56Z",
    "component_blueprint_key": "<string>",
    "display_name": "<string>",
    "inputs": [
      {
        "datapoint_ids": [
          "dtp_1DVKHKS101S0Q61Q"
        ],
        "input_key": "<string>",
        "__typename": "CreateComponentListInput"
      }
    ],
    "project_id": "prj_1CTWZQGKE1S0VAXA",
    "supplier_reference_id": "<string>",
    "description": "<string>"
  }
}
'

import requests

url = "https://api.sandbox.isometric.com/mrv/v0/project_components"

payload = { "component_data": {
        "activity_completed_at": "2023-11-07T05:31:56Z",
        "activity_started_at": "2023-11-07T05:31:56Z",
        "component_blueprint_key": "<string>",
        "display_name": "<string>",
        "inputs": [
            {
                "datapoint_ids": ["dtp_1DVKHKS101S0Q61Q"],
                "input_key": "<string>",
                "__typename": "CreateComponentListInput"
            }
        ],
        "project_id": "prj_1CTWZQGKE1S0VAXA",
        "supplier_reference_id": "<string>",
        "description": "<string>"
    } }
headers = {
    "x-client-secret": "<x-client-secret>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-client-secret': '<x-client-secret>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    component_data: {
      activity_completed_at: '2023-11-07T05:31:56Z',
      activity_started_at: '2023-11-07T05:31:56Z',
      component_blueprint_key: '<string>',
      display_name: '<string>',
      inputs: [
        {
          datapoint_ids: ['dtp_1DVKHKS101S0Q61Q'],
          input_key: '<string>',
          __typename: 'CreateComponentListInput'
        }
      ],
      project_id: 'prj_1CTWZQGKE1S0VAXA',
      supplier_reference_id: '<string>',
      description: '<string>'
    }
  })
};

fetch('https://api.sandbox.isometric.com/mrv/v0/project_components', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.isometric.com/mrv/v0/project_components",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'component_data' => [
        'activity_completed_at' => '2023-11-07T05:31:56Z',
        'activity_started_at' => '2023-11-07T05:31:56Z',
        'component_blueprint_key' => '<string>',
        'display_name' => '<string>',
        'inputs' => [
                [
                                'datapoint_ids' => [
                                                                'dtp_1DVKHKS101S0Q61Q'
                                ],
                                'input_key' => '<string>',
                                '__typename' => 'CreateComponentListInput'
                ]
        ],
        'project_id' => 'prj_1CTWZQGKE1S0VAXA',
        'supplier_reference_id' => '<string>',
        'description' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-client-secret: <x-client-secret>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.isometric.com/mrv/v0/project_components"

	payload := strings.NewReader("{\n  \"component_data\": {\n    \"activity_completed_at\": \"2023-11-07T05:31:56Z\",\n    \"activity_started_at\": \"2023-11-07T05:31:56Z\",\n    \"component_blueprint_key\": \"<string>\",\n    \"display_name\": \"<string>\",\n    \"inputs\": [\n      {\n        \"datapoint_ids\": [\n          \"dtp_1DVKHKS101S0Q61Q\"\n        ],\n        \"input_key\": \"<string>\",\n        \"__typename\": \"CreateComponentListInput\"\n      }\n    ],\n    \"project_id\": \"prj_1CTWZQGKE1S0VAXA\",\n    \"supplier_reference_id\": \"<string>\",\n    \"description\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-client-secret", "<x-client-secret>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.isometric.com/mrv/v0/project_components")
  .header("x-client-secret", "<x-client-secret>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"component_data\": {\n    \"activity_completed_at\": \"2023-11-07T05:31:56Z\",\n    \"activity_started_at\": \"2023-11-07T05:31:56Z\",\n    \"component_blueprint_key\": \"<string>\",\n    \"display_name\": \"<string>\",\n    \"inputs\": [\n      {\n        \"datapoint_ids\": [\n          \"dtp_1DVKHKS101S0Q61Q\"\n        ],\n        \"input_key\": \"<string>\",\n        \"__typename\": \"CreateComponentListInput\"\n      }\n    ],\n    \"project_id\": \"prj_1CTWZQGKE1S0VAXA\",\n    \"supplier_reference_id\": \"<string>\",\n    \"description\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.isometric.com/mrv/v0/project_components")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-client-secret"] = '<x-client-secret>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"component_data\": {\n    \"activity_completed_at\": \"2023-11-07T05:31:56Z\",\n    \"activity_started_at\": \"2023-11-07T05:31:56Z\",\n    \"component_blueprint_key\": \"<string>\",\n    \"display_name\": \"<string>\",\n    \"inputs\": [\n      {\n        \"datapoint_ids\": [\n          \"dtp_1DVKHKS101S0Q61Q\"\n        ],\n        \"input_key\": \"<string>\",\n        \"__typename\": \"CreateComponentListInput\"\n      }\n    ],\n    \"project_id\": \"prj_1CTWZQGKE1S0VAXA\",\n    \"supplier_reference_id\": \"<string>\",\n    \"description\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "activity_completed_at": "2023-11-07T05:31:56Z",
  "activity_started_at": "2023-11-07T05:31:56Z",
  "blueprint_key": "<string>",
  "description": "<string>",
  "display_name": "<string>",
  "ghg_entry_template_component_id": "rtc_1DAA58EDM1S0AMPN",
  "id": "cmp_1EP2SB7MZ1S036PY",
  "inputs": [
    {
      "datapoint_ids": [
        "dtp_1DVKHKS101S0Q61Q"
      ],
      "input_key": "<string>",
      "__typename": "ComponentListInput"
    }
  ],
  "removal_template_component_id": "rtc_1DAA58EDM1S0AMPN",
  "scope": "REMOVAL",
  "supplier_reference_id": "<string>",
  "type": "ACTIVITY",
  "allocation_strategy": "ESTIMATED_PROJECT_TONNAGE"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

POST

project_components

Post Project Component

curl --request POST \
  --url https://api.sandbox.isometric.com/mrv/v0/project_components \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-client-secret: <x-client-secret>' \
  --data '
{
  "component_data": {
    "activity_completed_at": "2023-11-07T05:31:56Z",
    "activity_started_at": "2023-11-07T05:31:56Z",
    "component_blueprint_key": "<string>",
    "display_name": "<string>",
    "inputs": [
      {
        "datapoint_ids": [
          "dtp_1DVKHKS101S0Q61Q"
        ],
        "input_key": "<string>",
        "__typename": "CreateComponentListInput"
      }
    ],
    "project_id": "prj_1CTWZQGKE1S0VAXA",
    "supplier_reference_id": "<string>",
    "description": "<string>"
  }
}
'

import requests

url = "https://api.sandbox.isometric.com/mrv/v0/project_components"

payload = { "component_data": {
        "activity_completed_at": "2023-11-07T05:31:56Z",
        "activity_started_at": "2023-11-07T05:31:56Z",
        "component_blueprint_key": "<string>",
        "display_name": "<string>",
        "inputs": [
            {
                "datapoint_ids": ["dtp_1DVKHKS101S0Q61Q"],
                "input_key": "<string>",
                "__typename": "CreateComponentListInput"
            }
        ],
        "project_id": "prj_1CTWZQGKE1S0VAXA",
        "supplier_reference_id": "<string>",
        "description": "<string>"
    } }
headers = {
    "x-client-secret": "<x-client-secret>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-client-secret': '<x-client-secret>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    component_data: {
      activity_completed_at: '2023-11-07T05:31:56Z',
      activity_started_at: '2023-11-07T05:31:56Z',
      component_blueprint_key: '<string>',
      display_name: '<string>',
      inputs: [
        {
          datapoint_ids: ['dtp_1DVKHKS101S0Q61Q'],
          input_key: '<string>',
          __typename: 'CreateComponentListInput'
        }
      ],
      project_id: 'prj_1CTWZQGKE1S0VAXA',
      supplier_reference_id: '<string>',
      description: '<string>'
    }
  })
};

fetch('https://api.sandbox.isometric.com/mrv/v0/project_components', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.isometric.com/mrv/v0/project_components",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'component_data' => [
        'activity_completed_at' => '2023-11-07T05:31:56Z',
        'activity_started_at' => '2023-11-07T05:31:56Z',
        'component_blueprint_key' => '<string>',
        'display_name' => '<string>',
        'inputs' => [
                [
                                'datapoint_ids' => [
                                                                'dtp_1DVKHKS101S0Q61Q'
                                ],
                                'input_key' => '<string>',
                                '__typename' => 'CreateComponentListInput'
                ]
        ],
        'project_id' => 'prj_1CTWZQGKE1S0VAXA',
        'supplier_reference_id' => '<string>',
        'description' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-client-secret: <x-client-secret>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.isometric.com/mrv/v0/project_components"

	payload := strings.NewReader("{\n  \"component_data\": {\n    \"activity_completed_at\": \"2023-11-07T05:31:56Z\",\n    \"activity_started_at\": \"2023-11-07T05:31:56Z\",\n    \"component_blueprint_key\": \"<string>\",\n    \"display_name\": \"<string>\",\n    \"inputs\": [\n      {\n        \"datapoint_ids\": [\n          \"dtp_1DVKHKS101S0Q61Q\"\n        ],\n        \"input_key\": \"<string>\",\n        \"__typename\": \"CreateComponentListInput\"\n      }\n    ],\n    \"project_id\": \"prj_1CTWZQGKE1S0VAXA\",\n    \"supplier_reference_id\": \"<string>\",\n    \"description\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-client-secret", "<x-client-secret>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.isometric.com/mrv/v0/project_components")
  .header("x-client-secret", "<x-client-secret>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"component_data\": {\n    \"activity_completed_at\": \"2023-11-07T05:31:56Z\",\n    \"activity_started_at\": \"2023-11-07T05:31:56Z\",\n    \"component_blueprint_key\": \"<string>\",\n    \"display_name\": \"<string>\",\n    \"inputs\": [\n      {\n        \"datapoint_ids\": [\n          \"dtp_1DVKHKS101S0Q61Q\"\n        ],\n        \"input_key\": \"<string>\",\n        \"__typename\": \"CreateComponentListInput\"\n      }\n    ],\n    \"project_id\": \"prj_1CTWZQGKE1S0VAXA\",\n    \"supplier_reference_id\": \"<string>\",\n    \"description\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.isometric.com/mrv/v0/project_components")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-client-secret"] = '<x-client-secret>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"component_data\": {\n    \"activity_completed_at\": \"2023-11-07T05:31:56Z\",\n    \"activity_started_at\": \"2023-11-07T05:31:56Z\",\n    \"component_blueprint_key\": \"<string>\",\n    \"display_name\": \"<string>\",\n    \"inputs\": [\n      {\n        \"datapoint_ids\": [\n          \"dtp_1DVKHKS101S0Q61Q\"\n        ],\n        \"input_key\": \"<string>\",\n        \"__typename\": \"CreateComponentListInput\"\n      }\n    ],\n    \"project_id\": \"prj_1CTWZQGKE1S0VAXA\",\n    \"supplier_reference_id\": \"<string>\",\n    \"description\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "activity_completed_at": "2023-11-07T05:31:56Z",
  "activity_started_at": "2023-11-07T05:31:56Z",
  "blueprint_key": "<string>",
  "description": "<string>",
  "display_name": "<string>",
  "ghg_entry_template_component_id": "rtc_1DAA58EDM1S0AMPN",
  "id": "cmp_1EP2SB7MZ1S036PY",
  "inputs": [
    {
      "datapoint_ids": [
        "dtp_1DVKHKS101S0Q61Q"
      ],
      "input_key": "<string>",
      "__typename": "ComponentListInput"
    }
  ],
  "removal_template_component_id": "rtc_1DAA58EDM1S0AMPN",
  "scope": "REMOVAL",
  "supplier_reference_id": "<string>",
  "type": "ACTIVITY",
  "allocation_strategy": "ESTIMATED_PROJECT_TONNAGE"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "ctx": {},
      "input": "<unknown>"
    }
  ]
}

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

Example:

"Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"

Body

application/json

allocation_strategy

enum<string>

required

The strategy that the components emissions are distributed across GHG Statements.

Available options:

ESTIMATED_PROJECT_TONNAGE,

MANUAL,

CUSTOM_TIME_PERIOD,

ESTIMATED_PROJECT_LIFETIME

component_data

CreateComponentRequest · object

required

Data required to create any component

Show child attributes

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

ghg_entry_template_component_id

string | null

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.

Required string length: 20 - 37

Example:

"rtc_1DAA58EDM1S0AMPN"

string

required

Required string length: 20 - 37

Examples:

"cmp_1EP2SB7MZ1S036PY"

"cmp_1EHK4R6QJSBXFC5N"

inputs

(ComponentListInput · object | ComponentScalarInput · object)[]

required

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

ComponentListInput
ComponentScalarInput

Show child attributes

removal_template_component_id

string | null

required

deprecated

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.

Required string length: 20 - 37

Example:

"rtc_1DAA58EDM1S0AMPN"

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 - 200

type

enum<string>

required

Available options:

ACTIVITY,

REMOVAL_COUNTERFACTUAL,

SEQUESTRATION,

LOSS,

ADJUSTMENT,

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

Overview

Certify

Registry

Post Project Component

Authorizations

Headers

Body

Response