Documentation

Patch Datapoint

curl --request PATCH \
  --url https://api.sandbox.isometric.com/mrv/v0/datapoints/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-client-secret: <x-client-secret>' \
  --data '
{
  "description": {
    "__typename": "Undefined"
  },
  "display_name": {
    "__typename": "Undefined"
  },
  "quantity": {
    "__typename": "Undefined"
  },
  "source_ids": {
    "__typename": "Undefined"
  },
  "type": {
    "__typename": "Undefined"
  },
  "uncertainty_justification": {
    "__typename": "Undefined"
  }
}
'

import requests

url = "https://api.sandbox.isometric.com/mrv/v0/datapoints/{id}"

payload = {
    "description": { "__typename": "Undefined" },
    "display_name": { "__typename": "Undefined" },
    "quantity": { "__typename": "Undefined" },
    "source_ids": { "__typename": "Undefined" },
    "type": { "__typename": "Undefined" },
    "uncertainty_justification": { "__typename": "Undefined" }
}
headers = {
    "x-client-secret": "<x-client-secret>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'x-client-secret': '<x-client-secret>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    description: {__typename: 'Undefined'},
    display_name: {__typename: 'Undefined'},
    quantity: {__typename: 'Undefined'},
    source_ids: {__typename: 'Undefined'},
    type: {__typename: 'Undefined'},
    uncertainty_justification: {__typename: 'Undefined'}
  })
};

fetch('https://api.sandbox.isometric.com/mrv/v0/datapoints/{id}', 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/datapoints/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => [
        '__typename' => 'Undefined'
    ],
    'display_name' => [
        '__typename' => 'Undefined'
    ],
    'quantity' => [
        '__typename' => 'Undefined'
    ],
    'source_ids' => [
        '__typename' => 'Undefined'
    ],
    'type' => [
        '__typename' => 'Undefined'
    ],
    'uncertainty_justification' => [
        '__typename' => 'Undefined'
    ]
  ]),
  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/datapoints/{id}"

	payload := strings.NewReader("{\n  \"description\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"display_name\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"quantity\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"source_ids\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"type\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"uncertainty_justification\": {\n    \"__typename\": \"Undefined\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.sandbox.isometric.com/mrv/v0/datapoints/{id}")
  .header("x-client-secret", "<x-client-secret>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"display_name\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"quantity\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"source_ids\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"type\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"uncertainty_justification\": {\n    \"__typename\": \"Undefined\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.isometric.com/mrv/v0/datapoints/{id}")

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

request = Net::HTTP::Patch.new(url)
request["x-client-secret"] = '<x-client-secret>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"display_name\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"quantity\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"source_ids\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"type\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"uncertainty_justification\": {\n    \"__typename\": \"Undefined\"\n  }\n}"

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

{
  "description": "<string>",
  "display_name": "<string>",
  "id": "dtp_1DVKHKS101S0Q61Q",
  "locked_status": "not_locked",
  "measured_at": "2023-11-07T05:31:56Z",
  "project_id": "prj_1CTWZQGKE1S0VAXA",
  "quantity": {
    "magnitude": 123,
    "unit": "<string>",
    "standard_deviation": 123
  },
  "source_ids": [
    "src_1EBBF4M7X1S06G1Y"
  ],
  "supplier_reference_id": "<string>",
  "type": "CONSTANT",
  "uncertainty_justification": "<string>"
}

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

PATCH

datapoints

{id}

Patch Datapoint

curl --request PATCH \
  --url https://api.sandbox.isometric.com/mrv/v0/datapoints/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-client-secret: <x-client-secret>' \
  --data '
{
  "description": {
    "__typename": "Undefined"
  },
  "display_name": {
    "__typename": "Undefined"
  },
  "quantity": {
    "__typename": "Undefined"
  },
  "source_ids": {
    "__typename": "Undefined"
  },
  "type": {
    "__typename": "Undefined"
  },
  "uncertainty_justification": {
    "__typename": "Undefined"
  }
}
'

import requests

url = "https://api.sandbox.isometric.com/mrv/v0/datapoints/{id}"

payload = {
    "description": { "__typename": "Undefined" },
    "display_name": { "__typename": "Undefined" },
    "quantity": { "__typename": "Undefined" },
    "source_ids": { "__typename": "Undefined" },
    "type": { "__typename": "Undefined" },
    "uncertainty_justification": { "__typename": "Undefined" }
}
headers = {
    "x-client-secret": "<x-client-secret>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'x-client-secret': '<x-client-secret>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    description: {__typename: 'Undefined'},
    display_name: {__typename: 'Undefined'},
    quantity: {__typename: 'Undefined'},
    source_ids: {__typename: 'Undefined'},
    type: {__typename: 'Undefined'},
    uncertainty_justification: {__typename: 'Undefined'}
  })
};

fetch('https://api.sandbox.isometric.com/mrv/v0/datapoints/{id}', 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/datapoints/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => [
        '__typename' => 'Undefined'
    ],
    'display_name' => [
        '__typename' => 'Undefined'
    ],
    'quantity' => [
        '__typename' => 'Undefined'
    ],
    'source_ids' => [
        '__typename' => 'Undefined'
    ],
    'type' => [
        '__typename' => 'Undefined'
    ],
    'uncertainty_justification' => [
        '__typename' => 'Undefined'
    ]
  ]),
  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/datapoints/{id}"

	payload := strings.NewReader("{\n  \"description\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"display_name\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"quantity\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"source_ids\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"type\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"uncertainty_justification\": {\n    \"__typename\": \"Undefined\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.sandbox.isometric.com/mrv/v0/datapoints/{id}")
  .header("x-client-secret", "<x-client-secret>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"display_name\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"quantity\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"source_ids\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"type\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"uncertainty_justification\": {\n    \"__typename\": \"Undefined\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.isometric.com/mrv/v0/datapoints/{id}")

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

request = Net::HTTP::Patch.new(url)
request["x-client-secret"] = '<x-client-secret>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"display_name\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"quantity\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"source_ids\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"type\": {\n    \"__typename\": \"Undefined\"\n  },\n  \"uncertainty_justification\": {\n    \"__typename\": \"Undefined\"\n  }\n}"

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

{
  "description": "<string>",
  "display_name": "<string>",
  "id": "dtp_1DVKHKS101S0Q61Q",
  "locked_status": "not_locked",
  "measured_at": "2023-11-07T05:31:56Z",
  "project_id": "prj_1CTWZQGKE1S0VAXA",
  "quantity": {
    "magnitude": 123,
    "unit": "<string>",
    "standard_deviation": 123
  },
  "source_ids": [
    "src_1EBBF4M7X1S06G1Y"
  ],
  "supplier_reference_id": "<string>",
  "type": "CONSTANT",
  "uncertainty_justification": "<string>"
}

{
  "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"

Path Parameters

string

required

Required string length: 20 - 37

Examples:

"dtp_1DVKHKS101S0Q61Q"

"dtp_1DJN8P57VSBXASFX"

Body

application/json

description

default:{"__typename":"Undefined"}

A free-text description of the datapoint. Must be at most 500 characters long.

Maximum string length: 500

display_name

default:{"__typename":"Undefined"}

Required string length: 1 - 150

quantity

DatapointQuantityInput · object

DatapointQuantityInput
Undefined

Show child attributes

source_ids

Overwrite existing source IDs

Required string length: 20 - 37

type

default:{"__typename":"Undefined"}

Available options:

CONSTANT,

STANDARD_PUBLISHED_VALUE,

REPORTED,

ASSUMPTION,

DERIVED

uncertainty_justification

default:{"__typename":"Undefined"}

Provide an uncertainty justification where required for inputs identified as sensitive in sensitivity analysis.

Response

Successful Response

description

string | null

required

display_name

string

required

string

required

Required string length: 20 - 37

Examples:

"dtp_1DVKHKS101S0Q61Q"

"dtp_1DJN8P57VSBXASFX"

locked_status

enum<string>

required

Represents the locked status of a Datapoint. Locked Datapoints cannot be updated: if an updated version of a data input is required then a new Datapoint must be created.

Available options:

not_locked,

locked_library_datapoint,

locked_time_series_datapoint,

locked_measurement_sample_datapoint,

locked_forestry_field_measurement_datapoint,

locked_model_output_datapoint,

locked_model_input_datapoint,

locked_material_datapoint,

locked_activity_datapoint,

locked_used_in_verified_removal

measured_at

string<date-time> | null

required

project_id

string | null

required

Required string length: 20 - 37

Example:

"prj_1CTWZQGKE1S0VAXA"

quantity

ScalarQuantity · object

required

Show child attributes

source_ids

string[]

required

Required string length: 20 - 37

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:

CONSTANT,

STANDARD_PUBLISHED_VALUE,

REPORTED,

ASSUMPTION,

DERIVED

uncertainty_justification

string | null

Provide an uncertainty justification where required for inputs identified as sensitive in sensitivity analysis.

Overview

Certify

Registry

Patch Datapoint

Authorizations

Headers

Path Parameters

Body

Response