GET
/
component_blueprints
/
{key}
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>"
    }
  ],
  "inputs": [
    {
      "compatible_unit": "<string>",
      "data_shape": "SCALAR",
      "description": "<string>",
      "input_key": "<string>",
      "quantity_kind": "acidity"
    }
  ],
  "key": "<string>",
  "type": "ACTIVITY"
}

Individual component blueprint documentation can be found here

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

​
key
string
required

Response

200
application/json
Successful Response
​
description
string
required
​
display_name
string
required
​
expressions
object[]
required

This field is exposed purely for documentation purposes. It shows how the inputs are processed to arrive at the component's output value.

​
inputs
object[]
required

List of inputs to the component blueprint. It documents what datapoints need to be provided when instantiating a component from it.

​
key
string
required
​
type
enum<string>
required
Available options:
ACTIVITY,
COUNTERFACTUAL,
SEQUESTRATION,
LOSS,
REDUCTION

Was this page helpful?