ISisometric

Post Datapoint

Changed on

Creates a datapoint in the Isometric system

post/datapoints

Request

  • Base URL
    https://api.isometric.com/mrv/v0
  • URL
    https://api.isometric.com/mrv/v0/datapoints
  • Auth
    HTTP bearer

Headers

x-client-secretstring required

A secret token identifying the client connecting to the API

Example:Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP

Request body

supplier_reference_idstring 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.

display_namestring required
type'CONSTANT' | 'STANDARD_PUBLISHED_VALUE' | 'REPORTED' | 'ASSUMPTION' | 'DERIVED' required
descriptionstring required

A free-text description of the datapoint. Must be at most 500 characters long.

source_idsstring[] required
project_idstring required
measured_atstring date-time nullable
uncertainty_justificationstring nullable

Provide an uncertainty justification where required for inputs identified as sensitive in sensitivity analysis.

Example request

{
  "source_ids": [
    "src_1EBBF4M7X1S06G1Y"
  ],
  "project_id": "prj_1CTWZQGKE1S0VAXA"
}

Response

Successful Response

idstring required
supplier_reference_idstring nullable 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.

display_namestring required
type'CONSTANT' | 'STANDARD_PUBLISHED_VALUE' | 'REPORTED' | 'ASSUMPTION' | 'DERIVED' required
descriptionstring nullable required
source_idsstring[] required
measured_atstring date-time nullable required
project_idstring nullable required
locked_status'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' 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.

uncertainty_justificationstring nullable

Provide an uncertainty justification where required for inputs identified as sensitive in sensitivity analysis.

Example response

{
  "id": "dtp_1DVKHKS101S0Q61Q",
  "source_ids": [
    "src_1EBBF4M7X1S06G1Y"
  ],
  "project_id": "prj_1CTWZQGKE1S0VAXA"
}

Changes

  • a29120dd7406Revision changes
    • breaking

      the / response property's maxLength was increased from 100 to 200 for the response status

    • warning

      the request property's maxLength was set to 500

    • warning

      added the new locked_activity_datapoint enum value to the response property for the response status

    • warning

      added the new locked_forestry_field_measurement_datapoint enum value to the response property for the response status

    • warning

      added the new locked_material_datapoint enum value to the response property for the response status

    • warning

      added the new locked_model_input_datapoint enum value to the response property for the response status

    • warning

      added the new locked_model_output_datapoint enum value to the response property for the response status

    • info

      the request property's maxLength was increased from 100 to 150

    • info

      the request property's maxLength was increased from 100 to 200

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 4f984b6745dbRevision changes
    • breaking

      the response property / became optional for the status

    • breaking

      the response property's maxLength was increased from 36 to 37 for the response status

    • breaking

      the / response property's maxLength was increased from 36 to 37 for the response status

    • breaking

      the / response property's maxLength was increased from 36 to 37 for the response status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      the request property / became optional

    • info

      the request property's maxLength was increased from 36 to 37

    • info

      the / request property's maxLength was increased from 36 to 37

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status