Documentation

Get Removal Template

curl --request GET \
  --url https://api.sandbox.isometric.com/mrv/v0/projects/{project_id}/removal_templates/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-client-secret: <x-client-secret>'

{
  "display_name": "<string>",
  "groups": [
    {
      "components": [
        {
          "blueprint_key": "<string>",
          "description": "<string>",
          "display_name": "<string>",
          "id": "<string>",
          "inputs": [
            {
              "datapoint_id": "dtp_1DVKHKS101S0Q61Q",
              "display_name": "<string>",
              "input_key": "<string>",
              "quantity_kind": "acidity",
              "type": "fixed"
            }
          ],
          "removal_template_component_group_id": "<string>",
          "removal_template_id": "<string>"
        }
      ],
      "description": "<string>",
      "display_name": "<string>",
      "id": "<string>",
      "key": "<string>"
    }
  ],
  "id": "<string>",
  "project_id": "<string>",
  "supplier_reference_id": "<string>"
}

GET

projects

{project_id}

removal_templates

{id}

Get Removal Template

curl --request GET \
  --url https://api.sandbox.isometric.com/mrv/v0/projects/{project_id}/removal_templates/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-client-secret: <x-client-secret>'

{
  "display_name": "<string>",
  "groups": [
    {
      "components": [
        {
          "blueprint_key": "<string>",
          "description": "<string>",
          "display_name": "<string>",
          "id": "<string>",
          "inputs": [
            {
              "datapoint_id": "dtp_1DVKHKS101S0Q61Q",
              "display_name": "<string>",
              "input_key": "<string>",
              "quantity_kind": "acidity",
              "type": "fixed"
            }
          ],
          "removal_template_component_group_id": "<string>",
          "removal_template_id": "<string>"
        }
      ],
      "description": "<string>",
      "display_name": "<string>",
      "id": "<string>",
      "key": "<string>"
    }
  ],
  "id": "<string>",
  "project_id": "<string>",
  "supplier_reference_id": "<string>"
}

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

Path Parameters

project_id

string

required

string

required

Response

Successful Response

display_name

string

required

groups

RemovalTemplateComponentGroup · object[]

required

Show child attributes

groups.components

RemovalTemplateComponent · object[]

required

Show child attributes

groups.components.blueprint_key

string

required

groups.components.description

string | null

required

groups.components.display_name

string

required

groups.components.id

string

required

Required string length: 20 - 37

groups.components.inputs

RemovalTemplateComponentInput · object[]

required

Inputs for this removal template component based on its component blueprint, including any customized display names and fixed input datapoints.

Show child attributes

groups.components.inputs.datapoint_id

string | null

required

Required string length: 20 - 37

Example:

"dtp_1DVKHKS101S0Q61Q"

groups.components.inputs.display_name

string

required

groups.components.inputs.input_key

string

required

The key which identifies an specific input to the component blueprint.

groups.components.inputs.quantity_kind

enum<string>

required

The type of datapoint value that the input requires. Units compatible with this type can be found in the component blueprint library.

Available options:

acidity,

activity_concentration,

amount_of_substance,

amount_of_substance_concentration,

amount_of_substance_per_mass,

area,

area_carbon_emission_factor,

buffer_ph,

bulk_density,

currency,

currency_carbon_emission_factor,

depth,

diameter,

diameter_at_breast_height,

dimensionless,

dimensionless_ratio,

distance,

distance_carbon_emission_factor,

dose_equivalent_rate,

electric_current,

elevation,

energy,

energy_carbon_emission_factor,

energy_density,

exchangeable_amount_of_substance_per_mass,

fuel_economy,

height,

ionic_strength,

latitude,

longitude,

mass,

mass_carbon,

mass_carbon_emission_factor,

mass_cdr_potential,

mass_concentration,

mass_density,

mass_distance,

mass_distance_carbon_emission_factor,

mass_energy_density,

mass_flow_rate,

mass_fraction,

mass_fraction_dry_basis,

mass_fraction_wet_basis,

mass_per_area,

mass_ratio,

molality_of_solute,

molar_mass,

mole_fraction,

partial_pressure,

particle_diameter,

particle_mass_density,

power,

pressure,

specific_surface_area,

specific_volume,

temperature,

time,

voltage,

volume,

volume_carbon_emission_factor,

volume_distance_carbon_emission_factor,

volume_flow_rate,

volume_fraction,

volume_per_area

groups.components.inputs.type

enum<string>

required

Available options:

fixed,

monitored

groups.components.removal_template_component_group_id

string

required

Required string length: 20 - 37

groups.components.removal_template_id

string

required

Required string length: 20 - 37

groups.description

string

required

groups.display_name

string

required

groups.id

string

required

Required string length: 20 - 37

groups.key

string

required

string

required

Required string length: 20 - 37

project_id

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

Get Removal Templates Get Datapoint Removal Template Components

⌘I

Overview

Certify

Registry

Get Removal Template

Authorizations

Headers

Path Parameters

Response