Skip to main content
GET
Get Datapoint

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

id
string
required
Required string length: 20 - 37
Examples:

"dtp_1DVKHKS101S0Q61Q"

"dtp_1DJN8P57VSBXASFX"

Response

Successful Response

description
string | null
required
display_name
string
required
id
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
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.