Get Component Blueprint

GET /component_blueprints/{key}

Get Component Blueprint

cURL

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

200

{
  "description": "<string>",
  "display_name": "<string>",
  "expressions": [
    {
      "inputs": [
        {
          "input_key": "<string>",
          "template_key": "<string>"
        }
      ],
      "key": "<string>",
      "template": "<string>"
    }
  ],
  "inputs": [
    {
      "compatible_unit": "<string>",
      "description": "<string>",
      "input_key": "<string>"
    }
  ],
  "key": "<string>"
}

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 · ComponentBlueprintExpression · 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.

Show child attributes

inputs · ComponentBlueprintInput · object[] · required

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

Show child attributes

key · string · required

type · enum<string> · required

Available options: ACTIVITY, REMOVAL_COUNTERFACTUAL, SEQUESTRATION, LOSS, ADJUSTMENT, UNCERTAINTY_DISCOUNT