cURL
Python
JavaScript
PHP
Go
Java
curl --request GET \
--url https://api.sandbox.isometric.com/mrv/v0/component_blueprints/{ key} \
--header 'Authorization: Bearer <token>' \
--header 'x-client-secret: <x-client-secret>' {
"description" : "<string>" ,
"display_name" : "<string>" ,
"expressions" : [
{
"inputs" : [
{
"data_shape" : "SCALAR" ,
"input_key" : "<string>" ,
"template_key" : "<string>" ,
"type" : "DATAPOINT"
}
] ,
"key" : "<string>" ,
"template" : "<string>"
}
] ,
"id" : "cpb_1D6VTD5C51S01DP6" ,
"inputs" : [
{
"compatible_unit" : "<string>" ,
"data_shape" : "SCALAR" ,
"description" : "<string>" ,
"input_key" : "<string>"
}
] ,
"key" : "<string>" ,
"type" : "ACTIVITY"
} Individual component blueprint documentation can be found here
A JWT Bearer token header for authentication and authorization, in the format Authorization: Bearer <token>
A secret token identifying the client connecting to the API
Example: "Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"
This field is exposed purely for documentation purposes. It shows how the inputs are processed to arrive at the component's output value.
List of inputs to the expression. It documents how variables in the template are interpolated.
expressions.inputs. data_shape
Whether the input is a list of datapoints or just a single datapoint
Available options:
SCALAR,
LIST
expressions.inputs. input_key
Input identifier within other resources of the component. Depending on the type, it will match an input datapoint or another expression, unless it represents a fixed 0 tCO₂e value.
expressions.inputs. template_key
Input identifier within the template string. It will match a template variable wrapped in { & }.
Type of resource pointed at by the input.
Available options:
DATAPOINT,
EXPRESSION_RESULT,
ZERO_TCO2E
Identifier of the expression within the component.
Mathematical formula of the expression.
Required string length: 20 - 36
List of inputs to the component blueprint. It documents what datapoints need to be provided when instantiating a component from it.
An example unit for this blueprint input. The unit provided when creating a component from this blueprint can be different, but must be able to be converted to this unit. If None, the input is dimensionless.
Whether the input is a list of datapoints
Available options:
SCALAR,
LIST
Description of the input variable
When instantiating a component from this blueprint, one of input datapoints must match this key.
Available options:
ACTIVITY,
COUNTERFACTUAL,
SEQUESTRATION,
LOSS,
REDUCTION
