{ "components": { "schemas": { "AddComponentToRemoval": { "properties": { "attribution_factor_datapoint_id": { "anyOf": [ { "example": "dtp_1DVKHKS101S0Q61Q", "examples": ["dtp_1DVKHKS101S0Q61Q", "dtp_1DJN8P57VSBXASFX"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "description": "A scalar between 0 and 1 for the fraction of the CO2e flux of the component that is to be attributed to this removal. A null input will default to 1.", "title": "Attribution Factor Datapoint Id" }, "component_id": { "description": "ID for component to add to Removal.", "example": "cmp_1EP2SB7MZ1S036PY", "examples": ["cmp_1EP2SB7MZ1S036PY", "cmp_1EHK4R6QJSBXFC5N"], "maxLength": 37, "minLength": 20, "title": "Component Id", "type": "string" }, "process_step_key": { "anyOf": [ { "maxLength": 100, "type": "string" }, { "type": "null" } ], "deprecated": true, "description": "Deprecated, please use removal_template_group_id instead.\n\nProcess step key matching the module the component should be added to.", "title": "Process Step Key" }, "removal_template_group_id": { "anyOf": [ { "example": "rtg_1EGQ9DZXZ1S05S28", "examples": ["rtg_1EGQ9DZXZ1S05S28", "rtg_1CWEFDQ7GSBX1X5C"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "description": "Which group the component should be added to, based on the removal's template structure.", "title": "Removal Template Group Id" } }, "required": ["component_id", "attribution_factor_datapoint_id"], "title": "AddComponentToRemoval", "type": "object" }, "BiocharApplication": { "properties": { "application_date": { "format": "date", "title": "Application Date", "type": "string" }, "average_application_rate": { "$ref": "#/components/schemas/ScalarQuantity" }, "id": { "example": "bse_1F1FDSGPE1S0374B", "examples": ["bse_1F1FDSGPE1S0374B", "bse_1DGG1R6DZSBXACD8"], "maxLength": 37, "minLength": 20, "title": "Id", "type": "string" }, "production_batch_id": { "example": "ptb_1GAFJ4C051S06E0Z", "examples": ["ptb_1GAFJ4C051S06E0Z", "ptb_1FQVMJYTASBXSZT8"], "maxLength": 37, "minLength": 20, "title": "Production Batch Id", "type": "string" }, "removal_id": { "anyOf": [ { "example": "rmv_1EEM6NJXX1S0EXKD", "examples": ["rmv_1EEM6NJXX1S0EXKD", "rmv_1E3V4J2EWSBX5E82"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "title": "Removal Id" }, "storage_location_id": { "example": "slc_1F3PMGVC91S0SBK3", "examples": ["slc_1F3PMGVC91S0SBK3", "slc_1DCY5K78BSBX3XMZ"], "maxLength": 37, "minLength": 20, "title": "Storage Location Id", "type": "string" }, "supplier_reference_id": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Supplier Reference Id" }, "truck_mass_on_arrival": { "$ref": "#/components/schemas/ScalarQuantity" }, "truck_mass_on_departure": { "$ref": "#/components/schemas/ScalarQuantity" }, "uploaded_at": { "format": "date-time", "title": "Uploaded At", "type": "string" } }, "required": [ "id", "storage_location_id", "production_batch_id", "removal_id", "supplier_reference_id", "application_date", "uploaded_at", "truck_mass_on_arrival", "truck_mass_on_departure", "average_application_rate" ], "title": "BiocharApplication", "type": "object" }, "Component": { "properties": { "activity_completed_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Activity Completed At" }, "activity_started_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Activity Started At" }, "allocation_strategy": { "anyOf": [ { "$ref": "#/components/schemas/ProjectComponentAmortizationStrategy" }, { "type": "null" } ], "description": "Attribution strategy, manages how project-scoped components are distributed across GHG statements; value will be Null if scope is not of scope project" }, "blueprint_key": { "title": "Blueprint Key", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "display_name": { "title": "Display Name", "type": "string" }, "id": { "example": "cmp_1EP2SB7MZ1S036PY", "examples": ["cmp_1EP2SB7MZ1S036PY", "cmp_1EHK4R6QJSBXFC5N"], "maxLength": 37, "minLength": 20, "title": "Id", "type": "string" }, "inputs": { "description": "A list of component inputs. The inputs can be either scalars or list inputs.", "items": { "oneOf": [ { "$ref": "#/components/schemas/ComponentListInput" }, { "$ref": "#/components/schemas/ComponentScalarInput" } ] }, "title": "Inputs", "type": "array" }, "removal_template_component_id": { "anyOf": [ { "example": "rtc_1DAA58EDM1S0AMPN", "examples": ["rtc_1DAA58EDM1S0AMPN", "rtc_1CQAKRCVQSBXKKTM"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "description": "The ID of the removal template component, if this component was created via a template. May be null if the component was created directly, or if the template has been deleted.", "title": "Removal Template Component Id" }, "scope": { "$ref": "#/components/schemas/ComponentScope" }, "supplier_reference_id": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Supplier Reference Id" }, "type": { "$ref": "#/components/schemas/ComponentType" } }, "required": [ "id", "supplier_reference_id", "type", "scope", "display_name", "description", "activity_completed_at", "activity_started_at", "blueprint_key", "removal_template_component_id", "inputs" ], "title": "Component", "type": "object" }, "ComponentAttribution": { "properties": { "attribution_factor": { "examples": [1.0, 0.654], "exclusiveMinimum": 0.0, "maximum": 1.0, "title": "Attribution Factor", "type": "number" }, "component_group_key": { "title": "Component Group Key", "type": "string" }, "component_id": { "example": "cmp_1EP2SB7MZ1S036PY", "examples": ["cmp_1EP2SB7MZ1S036PY", "cmp_1EHK4R6QJSBXFC5N"], "maxLength": 37, "minLength": 20, "title": "Component Id", "type": "string" }, "id": { "example": "rvc_1EADHFQHM1S0TVMN", "examples": ["rvc_1EADHFQHM1S0TVMN", "rvc_1EB9G4FR7SBX795D"], "maxLength": 37, "minLength": 20, "title": "Id", "type": "string" }, "removal_id": { "example": "rmv_1EEM6NJXX1S0EXKD", "examples": ["rmv_1EEM6NJXX1S0EXKD", "rmv_1E3V4J2EWSBX5E82"], "maxLength": 37, "minLength": 20, "title": "Removal Id", "type": "string" }, "removal_template_component_id": { "anyOf": [ { "example": "rtc_1DAA58EDM1S0AMPN", "examples": ["rtc_1DAA58EDM1S0AMPN", "rtc_1CQAKRCVQSBXKKTM"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "description": "The ID of the removal template component, if this component was created via a template. May be null if the component was created directly, or if the template has been deleted.", "title": "Removal Template Component Id" } }, "required": [ "id", "removal_id", "component_id", "component_group_key", "removal_template_component_id", "attribution_factor" ], "title": "ComponentAttribution", "type": "object" }, "ComponentBlueprint": { "properties": { "description": { "title": "Description", "type": "string" }, "display_name": { "title": "Display Name", "type": "string" }, "expressions": { "description": "This field is exposed purely for documentation purposes. It shows how the inputs are processed to arrive at the component's output value.", "items": { "$ref": "#/components/schemas/ComponentBlueprintExpression" }, "title": "Expressions", "type": "array" }, "inputs": { "description": "List of inputs to the component blueprint. It documents what datapoints need to be provided when instantiating a component from it.", "items": { "$ref": "#/components/schemas/ComponentBlueprintInput" }, "title": "Inputs", "type": "array" }, "key": { "title": "Key", "type": "string" }, "type": { "$ref": "#/components/schemas/ComponentType" } }, "required": [ "key", "display_name", "description", "type", "inputs", "expressions" ], "title": "ComponentBlueprint", "type": "object" }, "ComponentBlueprintExpression": { "properties": { "inputs": { "description": "List of inputs to the expression. It documents how variables in the template are interpolated.", "items": { "$ref": "#/components/schemas/ComponentBlueprintExpressionInput" }, "title": "Inputs", "type": "array" }, "key": { "description": "Identifier of the expression within the component.", "title": "Key", "type": "string" }, "template": { "description": "Mathematical formula of the expression.", "title": "Template", "type": "string" } }, "required": ["key", "template", "inputs"], "title": "ComponentBlueprintExpression", "type": "object" }, "ComponentBlueprintExpressionInput": { "properties": { "data_shape": { "$ref": "#/components/schemas/InputDataShape", "description": "Whether the input is a list of datapoints or just a single datapoint" }, "input_key": { "description": "Input identifier within other resources of the component. Depending on the type, it will match an input datapoint or another expression, unless it represents a fixed 0 tCO\u2082e value.", "title": "Input Key", "type": "string" }, "template_key": { "description": "Input identifier within the template string. It will match a template variable wrapped in `{` & `}`.", "title": "Template Key", "type": "string" }, "type": { "$ref": "#/components/schemas/ComponentBlueprintExpressionInputType", "description": "Type of resource pointed at by the input." } }, "required": ["template_key", "input_key", "type", "data_shape"], "title": "ComponentBlueprintExpressionInput", "type": "object" }, "ComponentBlueprintExpressionInputType": { "enum": ["DATAPOINT", "EXPRESSION_RESULT", "ZERO_TCO2E"], "title": "ComponentBlueprintExpressionInputType", "type": "string" }, "ComponentBlueprintInput": { "properties": { "compatible_unit": { "description": "An example unit for this blueprint input. The unit provided when creating a component from this blueprint can be different, but must be able to be converted to this unit.", "title": "Compatible Unit", "type": "string" }, "data_shape": { "$ref": "#/components/schemas/InputDataShape", "description": "Whether the input is a list of datapoints" }, "description": { "description": "Description of the input variable", "title": "Description", "type": "string" }, "input_key": { "description": "When instantiating a component from this blueprint, one of input datapoints must match this key.", "title": "Input Key", "type": "string" }, "quantity_kind": { "$ref": "#/components/schemas/QuantityKindType", "description": "The type of datapoint value that the input requires. Units compatible with this type can be found in the component blueprint library." } }, "required": [ "input_key", "description", "data_shape", "quantity_kind", "compatible_unit" ], "title": "ComponentBlueprintInput", "type": "object" }, "ComponentInputType": { "enum": ["fixed", "monitored"], "title": "ComponentInputType", "type": "string" }, "ComponentListInput": { "properties": { "__typename": { "const": "ComponentListInput", "default": "ComponentListInput", "description": "Contains the name of the model (formally, OpenAPI Schema Object). Used to determine the type of data, for example when two different types are unioned.", "title": "Type name", "type": "string" }, "datapoint_ids": { "description": "The Isometric ID of the datapoints assigned to this input", "items": { "example": "dtp_1DVKHKS101S0Q61Q", "examples": ["dtp_1DVKHKS101S0Q61Q", "dtp_1DJN8P57VSBXASFX"], "maxLength": 37, "minLength": 20, "type": "string" }, "title": "Datapoint Ids", "type": "array" }, "input_key": { "description": "Will match an input key in the component blueprint.", "maxLength": 100, "title": "Input Key", "type": "string" } }, "required": ["input_key", "datapoint_ids"], "title": "ComponentListInput", "type": "object" }, "ComponentScalarInput": { "properties": { "__typename": { "const": "ComponentScalarInput", "default": "ComponentScalarInput", "description": "Contains the name of the model (formally, OpenAPI Schema Object). Used to determine the type of data, for example when two different types are unioned.", "title": "Type name", "type": "string" }, "datapoint_id": { "description": "The Isometric ID of the datapoint assigned to this input", "example": "dtp_1DVKHKS101S0Q61Q", "examples": ["dtp_1DVKHKS101S0Q61Q", "dtp_1DJN8P57VSBXASFX"], "maxLength": 37, "minLength": 20, "title": "Datapoint Id", "type": "string" }, "input_key": { "description": "Will match an input key in the component blueprint.", "maxLength": 100, "title": "Input Key", "type": "string" } }, "required": ["input_key", "datapoint_id"], "title": "ComponentScalarInput", "type": "object" }, "ComponentScope": { "enum": ["REMOVAL", "GHG_STATEMENT", "PROJECT", "NET_NEGATIVITY"], "title": "ComponentScope", "type": "string" }, "ComponentToAttribute": { "properties": { "attribution_factor": { "default": 1.0, "description": "A float in range of (0, 1] for the fraction of the CO2e flux of the component that is to be attributed to this removal. 1.0 means all of the component should be attributed. If not supplied, defaults to 1.0.", "exclusiveMinimum": 0.0, "maximum": 1.0, "title": "Attribution Factor", "type": "number" }, "component_group_key": { "description": "Key of a component group that this component should be applied to in the removal.\n\nThe keys of the component groups are the same as the keys of removal template component groups they have been used to create them and they are consistent between projects using the same protocol.", "examples": ["bio-oil-storage", "energy-use", "dac-process"], "title": "Component Group Key", "type": "string" }, "component_id": { "description": "ID of the component to add to the removal.", "example": "cmp_1EP2SB7MZ1S036PY", "examples": ["cmp_1EP2SB7MZ1S036PY", "cmp_1EHK4R6QJSBXFC5N"], "maxLength": 37, "minLength": 20, "title": "Component Id", "type": "string" } }, "required": ["component_id", "component_group_key"], "title": "ComponentToAttribute", "type": "object" }, "ComponentType": { "enum": [ "ACTIVITY", "REMOVAL_COUNTERFACTUAL", "SEQUESTRATION", "LOSS", "ADJUSTMENT", "UNCERTAINTY_DISCOUNT" ], "title": "ComponentType", "type": "string" }, "CreateBiocharApplicationRequest": { "properties": { "application_date": { "description": "Date in ISO format (YYYY-MM-DD)", "format": "date", "title": "Application Date", "type": "string" }, "average_application_rate": { "$ref": "#/components/schemas/ScalarQuantity" }, "production_batch_id": { "example": "ptb_1GAFJ4C051S06E0Z", "examples": ["ptb_1GAFJ4C051S06E0Z", "ptb_1FQVMJYTASBXSZT8"], "maxLength": 37, "minLength": 20, "title": "Production Batch Id", "type": "string" }, "project_id": { "example": "prj_1CTWZQGKE1S0VAXA", "examples": ["prj_1CTWZQGKE1S0VAXA", "prj_1E0QTWB22SBX34D1"], "maxLength": 37, "minLength": 20, "title": "Project Id", "type": "string" }, "source_ids": { "default": [], "items": { "example": "src_1EBBF4M7X1S06G1Y", "examples": ["src_1EBBF4M7X1S06G1Y", "src_1DW1B17VNSBX37N0"], "maxLength": 37, "minLength": 20, "type": "string" }, "title": "Source Ids", "type": "array" }, "storage_site_id": { "example": "slc_1F3PMGVC91S0SBK3", "examples": ["slc_1F3PMGVC91S0SBK3", "slc_1DCY5K78BSBX3XMZ"], "maxLength": 37, "minLength": 20, "title": "Storage Site Id", "type": "string" }, "supplier_reference_id": { "description": "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.", "maxLength": 100, "minLength": 1, "title": "Supplier Reference Id", "type": "string" }, "truck_mass_on_arrival": { "$ref": "#/components/schemas/ScalarQuantity" }, "truck_mass_on_departure": { "$ref": "#/components/schemas/ScalarQuantity" } }, "required": [ "project_id", "storage_site_id", "production_batch_id", "average_application_rate", "application_date", "truck_mass_on_arrival", "truck_mass_on_departure", "supplier_reference_id" ], "title": "CreateBiocharApplicationRequest", "type": "object" }, "CreateComponentListInput": { "properties": { "__typename": { "const": "CreateComponentListInput", "default": "CreateComponentListInput", "description": "Contains the name of the model (formally, OpenAPI Schema Object). Used to determine the type of data, for example when two different types are unioned.", "title": "Type name", "type": "string" }, "datapoint_ids": { "description": "The Isometric IDs of the datapoints that will be used to populate the value of this input", "items": { "example": "dtp_1DVKHKS101S0Q61Q", "examples": ["dtp_1DVKHKS101S0Q61Q", "dtp_1DJN8P57VSBXASFX"], "maxLength": 37, "minLength": 20, "type": "string" }, "title": "Datapoint Ids", "type": "array" }, "input_key": { "description": "Must match an input key in the component blueprint.", "maxLength": 100, "title": "Input Key", "type": "string" } }, "required": ["input_key", "datapoint_ids"], "title": "CreateComponentListInput", "type": "object" }, "CreateComponentRequest": { "properties": { "activity_completed_at": { "description": "The date at which the physical activity related to this component started", "format": "date-time", "title": "Activity Completed At", "type": "string" }, "activity_started_at": { "description": "The date by which the physical activity related to this component finished", "format": "date-time", "title": "Activity Started At", "type": "string" }, "component_blueprint_key": { "description": "The key of the blueprint which we are deriving this component from.", "title": "Component Blueprint Key", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "An optional description that can be used to add more context to the component", "title": "Description" }, "display_name": { "maxLength": 100, "minLength": 1, "title": "Display Name", "type": "string" }, "inputs": { "description": "A list of component inputs. This must match the list of inputs on the component blueprint. See the component-blueprints endpoint.", "items": { "oneOf": [ { "$ref": "#/components/schemas/CreateComponentListInput" }, { "$ref": "#/components/schemas/CreateComponentScalarInput" } ] }, "title": "Inputs", "type": "array" }, "project_id": { "description": "The project in which to create the component", "example": "prj_1CTWZQGKE1S0VAXA", "examples": ["prj_1CTWZQGKE1S0VAXA", "prj_1E0QTWB22SBX34D1"], "maxLength": 37, "minLength": 20, "title": "Project Id", "type": "string" }, "supplier_reference_id": { "description": "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.", "maxLength": 100, "minLength": 1, "title": "Supplier Reference Id", "type": "string" } }, "required": [ "supplier_reference_id", "project_id", "component_blueprint_key", "display_name", "activity_completed_at", "activity_started_at", "inputs" ], "title": "CreateComponentRequest", "type": "object" }, "CreateComponentScalarInput": { "properties": { "__typename": { "const": "CreateComponentScalarInput", "default": "CreateComponentScalarInput", "description": "Contains the name of the model (formally, OpenAPI Schema Object). Used to determine the type of data, for example when two different types are unioned.", "title": "Type name", "type": "string" }, "datapoint_id": { "description": "The Isometric ID of the datapoint that will be used to populate the value of this input", "example": "dtp_1DVKHKS101S0Q61Q", "examples": ["dtp_1DVKHKS101S0Q61Q", "dtp_1DJN8P57VSBXASFX"], "maxLength": 37, "minLength": 20, "title": "Datapoint Id", "type": "string" }, "input_key": { "description": "Must match an input key in the component blueprint.", "maxLength": 100, "title": "Input Key", "type": "string" } }, "required": ["input_key", "datapoint_id"], "title": "CreateComponentScalarInput", "type": "object" }, "CreateDataUploadSubmissionRequest": { "properties": { "facility_id": { "anyOf": [ { "example": "fcl_1G8QT5ZAB1S0XSDW", "examples": ["fcl_1G8QT5ZAB1S0XSDW", "fcl_1E384BDCGSBXNNZZ"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "description": "The ID of the facility the data is associated with.", "title": "Facility Id" }, "file_upload_id": { "description": "The ID of the file upload that contains the data to be processed.", "example": "tfu_1DZPAW31R1S0ZESH", "examples": ["tfu_1DZPAW31R1S0ZESH", "tfu_1CHF4YC38SBX9E20"], "maxLength": 37, "minLength": 20, "title": "File Upload Id", "type": "string" }, "storage_location_id": { "anyOf": [ { "example": "slc_1F3PMGVC91S0SBK3", "examples": ["slc_1F3PMGVC91S0SBK3", "slc_1DCY5K78BSBX3XMZ"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "description": "The ID of the storage location the data is associated with.", "title": "Storage Location Id" }, "submission_type": { "$ref": "#/components/schemas/DataUploadSubmissionType" } }, "required": ["submission_type", "file_upload_id"], "title": "CreateDataUploadSubmissionRequest", "type": "object" }, "CreateDatapointRequest": { "properties": { "description": { "title": "Description", "type": "string" }, "display_name": { "maxLength": 100, "minLength": 1, "title": "Display Name", "type": "string" }, "measured_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Measured At" }, "project_id": { "example": "prj_1CTWZQGKE1S0VAXA", "examples": ["prj_1CTWZQGKE1S0VAXA", "prj_1E0QTWB22SBX34D1"], "maxLength": 37, "minLength": 20, "title": "Project Id", "type": "string" }, "quantity": { "$ref": "#/components/schemas/DatapointQuantityInput" }, "source_ids": { "items": { "example": "src_1EBBF4M7X1S06G1Y", "examples": ["src_1EBBF4M7X1S06G1Y", "src_1DW1B17VNSBX37N0"], "maxLength": 37, "minLength": 20, "type": "string" }, "title": "Source Ids", "type": "array" }, "supplier_reference_id": { "description": "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.", "maxLength": 100, "minLength": 1, "title": "Supplier Reference Id", "type": "string" }, "type": { "$ref": "#/components/schemas/DatapointType" }, "uncertainty_justification": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "\nProvide an uncertainty justification where required for inputs identified as sensitive in sensitivity analysis.\n", "title": "Uncertainty Justification" } }, "required": [ "supplier_reference_id", "display_name", "type", "quantity", "description", "source_ids", "project_id" ], "title": "CreateDatapointRequest", "type": "object" }, "CreateDocumentSourceRequest": { "properties": { "__typename": { "const": "CreateDocumentSourceRequest", "description": "Contains the name of the model (formally, OpenAPI Schema Object). Used to determine the type of data, for example when two different types are unioned.", "title": "Type name", "type": "string" }, "content_length": { "description": "The size (in bytes) of the file that will be uploaded. The pre-signed URL will only accept a file of this size.", "maximum": 50000000.0, "title": "Content Length", "type": "integer" }, "content_type": { "description": "The content type of the file that will be uploaded. This must also be passed as a `Content-Type` header during the upload. The pre-signed URL will only accept a file of this content-type. See the [list of supported filetypes](/api-reference/certify/uploading-sources#supported-filetypes).", "title": "Content Type", "type": "string" }, "display_name": { "maxLength": 100, "minLength": 1, "title": "Display Name", "type": "string" }, "file_name": { "description": "The full name of the file that will be uploaded, including its file extension", "title": "File Name", "type": "string" }, "is_public": { "default": false, "description": "If the source document should be publicly available on the Registry once credits are issued.", "title": "Is Public", "type": "boolean" }, "project_id": { "description": "The ID of the project that the source is associated with.", "example": "prj_1CTWZQGKE1S0VAXA", "examples": ["prj_1CTWZQGKE1S0VAXA", "prj_1E0QTWB22SBX34D1"], "maxLength": 37, "minLength": 20, "title": "Project Id", "type": "string" }, "published_at": { "description": "Date in ISO format (YYYY-MM-DD)", "format": "date", "title": "Published At", "type": "string" }, "supplier_reference_id": { "description": "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.", "maxLength": 100, "minLength": 1, "title": "Supplier Reference Id", "type": "string" } }, "required": [ "supplier_reference_id", "__typename", "display_name", "published_at", "file_name", "content_type", "content_length", "project_id" ], "title": "CreateDocumentSourceRequest", "type": "object" }, "CreateFeedstockBatchRequest": { "properties": { "delivery_date": { "description": "The date the feedstock batch was delivered to a field / to a site etc", "format": "date", "title": "Delivery Date", "type": "string" }, "display_name": { "description": "The display name for this feedstock batch", "maxLength": 100, "minLength": 1, "title": "Display Name", "type": "string" }, "feedstock_type_id": { "description": "The kind of feedstock used to create this feedstock batch", "example": "ftt_1D7KZ1P761S0G7BN", "examples": ["ftt_1D7KZ1P761S0G7BN", "ftt_1CSRJN4HHSBXZ3TK"], "maxLength": 37, "minLength": 20, "title": "Feedstock Type Id", "type": "string" }, "mass": { "$ref": "#/components/schemas/ScalarQuantity" }, "supplier_reference_id": { "description": "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.", "maxLength": 100, "minLength": 1, "title": "Supplier Reference Id", "type": "string" } }, "required": [ "feedstock_type_id", "supplier_reference_id", "display_name", "delivery_date", "mass" ], "title": "CreateFeedstockBatchRequest", "type": "object" }, "CreateFileUploadRequest": { "properties": { "content_length": { "description": "The size (in bytes) of the file that will be uploaded. The pre-signed URL will only accept a file of this size.", "maximum": 100000000.0, "title": "Content Length", "type": "integer" }, "content_type": { "const": "application/vnd.apache.parquet", "description": "The content type of the file that will be uploaded. This must also be passed as a 'content-type' header during the upload. The pre-signed URL will only accept a file of this content-type.", "title": "Content Type", "type": "string" }, "file_name": { "description": "The original filename of the file that will be uploaded. This is used for display purposes only and does not affect the upload process.", "title": "File Name", "type": "string" } }, "required": ["content_type", "content_length", "file_name"], "title": "CreateFileUploadRequest", "type": "object" }, "CreateGhgStatementComponentRequest": { "properties": { "component_data": { "$ref": "#/components/schemas/CreateComponentRequest", "description": "Data required to create any component" }, "ghg_statement_id": { "description": "Isometric ID of the GHG Statement to create the component within and amortize across.", "example": "ggs_1GDQJ99Z51S0DYW9", "examples": ["ggs_1GDQJ99Z51S0DYW9", "ggs_1FWVEQRWSSBXK3NB"], "maxLength": 37, "minLength": 20, "title": "Ghg Statement Id", "type": "string" } }, "required": ["ghg_statement_id", "component_data"], "title": "CreateGhgStatementComponentRequest", "type": "object" }, "CreateGhgStatementRequest": { "properties": { "end_on": { "description": "The inclusive end date of the GHG Statement", "format": "date", "title": "End On", "type": "string" }, "project_id": { "example": "prj_1CTWZQGKE1S0VAXA", "examples": ["prj_1CTWZQGKE1S0VAXA", "prj_1E0QTWB22SBX34D1"], "maxLength": 37, "minLength": 20, "title": "Project Id", "type": "string" } }, "required": ["end_on", "project_id"], "title": "CreateGhgStatementRequest", "type": "object" }, "CreateMeasurementLocationRequest": { "properties": { "latitude": { "maximum": 90.0, "minimum": -90.0, "title": "Latitude", "type": "number" }, "longitude": { "maximum": 180.0, "minimum": -180.0, "title": "Longitude", "type": "number" }, "project_id": { "example": "prj_1CTWZQGKE1S0VAXA", "examples": ["prj_1CTWZQGKE1S0VAXA", "prj_1E0QTWB22SBX34D1"], "maxLength": 37, "minLength": 20, "title": "Project Id", "type": "string" }, "supplier_reference_id": { "description": "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.", "maxLength": 100, "minLength": 1, "title": "Supplier Reference Id", "type": "string" } }, "required": [ "supplier_reference_id", "latitude", "longitude", "project_id" ], "title": "CreateMeasurementLocationRequest", "type": "object" }, "CreateMeasurementSampleRequest": { "properties": { "feedstock_batch_id": { "anyOf": [ { "example": "ftb_1DYYDB3C91S0ZHPX", "examples": ["ftb_1DYYDB3C91S0ZHPX", "ftb_1G59XDK6HSBXCZ9B"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "title": "Feedstock Batch Id" }, "measured_at": { "format": "date-time", "title": "Measured At", "type": "string" }, "measurement_location_id": { "anyOf": [ { "example": "mlc_1CCZASA6Q1S0V8T4", "examples": ["mlc_1CCZASA6Q1S0V8T4", "mlc_1GF73PG90SBXKEX1"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "title": "Measurement Location Id" }, "measurement_type": { "$ref": "#/components/schemas/MeasurementTypeKey" }, "production_batch_id": { "anyOf": [ { "example": "ptb_1GAFJ4C051S06E0Z", "examples": ["ptb_1GAFJ4C051S06E0Z", "ptb_1FQVMJYTASBXSZT8"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "title": "Production Batch Id" }, "project_id": { "example": "prj_1CTWZQGKE1S0VAXA", "examples": ["prj_1CTWZQGKE1S0VAXA", "prj_1E0QTWB22SBX34D1"], "maxLength": 37, "minLength": 20, "title": "Project Id", "type": "string" }, "storage_location_id": { "anyOf": [ { "example": "slc_1F3PMGVC91S0SBK3", "examples": ["slc_1F3PMGVC91S0SBK3", "slc_1DCY5K78BSBX3XMZ"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "title": "Storage Location Id" }, "supplier_reference_id": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Supplier Reference Id" }, "values": { "items": { "$ref": "#/components/schemas/CreateMeasurementSampleValueRequest" }, "title": "Values", "type": "array" } }, "required": [ "supplier_reference_id", "measured_at", "project_id", "feedstock_batch_id", "measurement_location_id", "measurement_type", "values", "storage_location_id" ], "title": "CreateMeasurementSampleRequest", "type": "object" }, "CreateMeasurementSampleValueRequest": { "properties": { "measurement_property": { "$ref": "#/components/schemas/MeasurementProperty" }, "value": { "$ref": "#/components/schemas/DatapointQuantityInput" } }, "required": ["value", "measurement_property"], "title": "CreateMeasurementSampleValueRequest", "type": "object" }, "CreateMonitoringSubmissionRequest": { "properties": { "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Any additional notes or comments.", "examples": ["Pages 14-21"], "title": "Notes" }, "source_id": { "description": "The Isometric ID of the source that the submission is for.", "example": "src_1EBBF4M7X1S06G1Y", "examples": ["src_1EBBF4M7X1S06G1Y", "src_1DW1B17VNSBX37N0"], "maxLength": 37, "minLength": 20, "title": "Source Id", "type": "string" }, "supplier_reference_id": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Supplier provided reference ID.", "title": "Supplier Reference Id" }, "valid_from": { "description": "Signifies the start of the period that the submission is valid for.", "format": "date-time", "title": "Valid From", "type": "string" }, "valid_to": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "Signifies the end of the period that the submission is valid for.", "title": "Valid To" } }, "required": ["source_id", "valid_from"], "title": "CreateMonitoringSubmissionRequest", "type": "object" }, "CreateProductionBatchRequest": { "properties": { "display_name": { "anyOf": [ { "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The display name for this production batch. If not provided, one will be auto-generated from the facility name", "title": "Display Name" }, "ended_at": { "description": "The date and time at which production of this production batch was completed", "format": "date-time", "title": "Ended At", "type": "string" }, "facility_id": { "description": "The facility where the production batch was created", "example": "fcl_1G8QT5ZAB1S0XSDW", "examples": ["fcl_1G8QT5ZAB1S0XSDW", "fcl_1E384BDCGSBXNNZZ"], "maxLength": 37, "minLength": 20, "title": "Facility Id", "type": "string" }, "feedstock_type_ids": { "description": "The kinds of feedstock used to create this production batch", "items": { "example": "ftt_1D7KZ1P761S0G7BN", "examples": ["ftt_1D7KZ1P761S0G7BN", "ftt_1CSRJN4HHSBXZ3TK"], "maxLength": 37, "minLength": 20, "type": "string" }, "title": "Feedstock Type Ids", "type": "array" }, "kind": { "$ref": "#/components/schemas/ProductionBatchKind", "description": "The kind of production batch" }, "mass": { "$ref": "#/components/schemas/ScalarQuantity" }, "started_at": { "description": "The date and time at which production of this production batch was started", "format": "date-time", "title": "Started At", "type": "string" }, "supplier_reference_id": { "description": "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.", "maxLength": 100, "minLength": 1, "title": "Supplier Reference Id", "type": "string" } }, "required": [ "facility_id", "feedstock_type_ids", "supplier_reference_id", "kind", "started_at", "ended_at", "mass" ], "title": "CreateProductionBatchRequest", "type": "object" }, "CreateProjectComponentRequest": { "properties": { "allocation_strategy": { "$ref": "#/components/schemas/ProjectComponentAmortizationStrategy", "description": "The strategy that the components emissions are distributed across GHG Statements." }, "component_data": { "$ref": "#/components/schemas/CreateComponentRequest", "description": "Data required to create any component" } }, "required": ["allocation_strategy", "component_data"], "title": "CreateProjectComponentRequest", "type": "object" }, "CreateRemovalComponentLink": { "properties": { "attribution_factor_datapoint_id": { "anyOf": [ { "example": "dtp_1DVKHKS101S0Q61Q", "examples": ["dtp_1DVKHKS101S0Q61Q", "dtp_1DJN8P57VSBXASFX"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "description": "A scalar between 0 and 1 for the fraction of the CO2e flux of the component that is to be attributed to this removal. A null input will default to 1.", "title": "Attribution Factor Datapoint Id" }, "component_id": { "description": "Isometric ID of the component to include within this removal step", "example": "cmp_1EP2SB7MZ1S036PY", "examples": ["cmp_1EP2SB7MZ1S036PY", "cmp_1EHK4R6QJSBXFC5N"], "maxLength": 37, "minLength": 20, "title": "Component Id", "type": "string" } }, "required": ["component_id"], "title": "CreateRemovalComponentLink", "type": "object" }, "CreateRemovalRequest": { "description": "Input to the POST /removals endpoint that creates a single removal", "properties": { "completed_on": { "description": "The date by which activities related to this removal finished.", "format": "date", "title": "Completed On", "type": "string" }, "feedstock_type_id": { "anyOf": [ { "example": "ftt_1D7KZ1P761S0G7BN", "examples": ["ftt_1D7KZ1P761S0G7BN", "ftt_1CSRJN4HHSBXZ3TK"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "description": "The ID of the feedstock type that will be used for this removal.", "title": "Feedstock Type Id" }, "process_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "deprecated": true, "description": "Deprecated, please use the `removal_template_id` field instead.\n\nThe key of the process to be used. See the processes endpoint for the processes available.", "title": "Process Key" }, "project_id": { "description": "The ID of the project to associate this removal to.", "example": "prj_1CTWZQGKE1S0VAXA", "examples": ["prj_1CTWZQGKE1S0VAXA", "prj_1E0QTWB22SBX34D1"], "maxLength": 37, "minLength": 20, "title": "Project Id", "type": "string" }, "removal_template_components": { "description": "", "items": { "$ref": "#/components/schemas/RemovalTemplateComponentInputs" }, "title": "Removal Template Components", "type": "array" }, "removal_template_id": { "anyOf": [ { "example": "rvt_1EVC8RZFE1S0BAT6", "examples": ["rvt_1EVC8RZFE1S0BAT6", "rvt_1ECDZGE2DSBX88EX"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "description": "This field will become required once the deprecated `process_key` field is removed.\n\nID of the removal template to instantiate the removal from.", "title": "Removal Template Id" }, "started_on": { "description": "The date at which activities related to this removal started.", "format": "date", "title": "Started On", "type": "string" }, "steps": { "anyOf": [ { "items": { "$ref": "#/components/schemas/CreateRemovalStep" }, "type": "array" }, { "type": "null" } ], "deprecated": true, "description": "Deprecated, please use the `removal_template_components` field instead.\n\nA list of steps to be included in the removal. The steps must match the steps defined in the process key. See the /processes endpoint to find which steps must be used.", "title": "Steps" }, "supplier_reference_id": { "description": "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.", "maxLength": 100, "minLength": 1, "title": "Supplier Reference Id", "type": "string" } }, "required": [ "supplier_reference_id", "started_on", "completed_on", "project_id" ], "title": "CreateRemovalRequest", "type": "object" }, "CreateRemovalStep": { "description": "Nested type for the POST /removals endpoint to create a step within a removal", "properties": { "components": { "description": "List of components that represent emissions, counterfactuals or sequestrations", "items": { "$ref": "#/components/schemas/CreateRemovalComponentLink" }, "title": "Components", "type": "array" }, "process_step_key": { "description": "The key of the process step that this model corresponds to", "title": "Process Step Key", "type": "string" } }, "required": ["process_step_key", "components"], "title": "CreateRemovalStep", "type": "object" }, "CreateSensorRequest": { "properties": { "facility_id": { "anyOf": [ { "example": "fcl_1G8QT5ZAB1S0XSDW", "examples": ["fcl_1G8QT5ZAB1S0XSDW", "fcl_1E384BDCGSBXNNZZ"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "description": "The facility where the sensor is installed", "title": "Facility Id" }, "manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The manufacturer of the sensor", "title": "Manufacturer" }, "measurement_property": { "$ref": "#/components/schemas/MeasurementProperty", "description": "The physical quantity this sensor measures" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The model of the sensor", "title": "Model" }, "reference": { "description": "What the supplier refers to this sensor by", "maxLength": 255, "title": "Reference", "type": "string" }, "storage_location_id": { "anyOf": [ { "example": "slc_1F3PMGVC91S0SBK3", "examples": ["slc_1F3PMGVC91S0SBK3", "slc_1DCY5K78BSBX3XMZ"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "description": "The storage location where the sensor is stored", "title": "Storage Location Id" }, "units": { "description": "The units of measurement for this sensor", "title": "Units", "type": "string" } }, "required": ["reference", "measurement_property", "units"], "title": "CreateSensorRequest", "type": "object" }, "CreateSourceResponse": { "properties": { "signed_upload_url": { "description": "A presigned upload URL, which must be used to upload the document associated with this source.", "title": "Signed Upload Url", "type": "string" }, "source": { "$ref": "#/components/schemas/Source" } }, "required": ["source", "signed_upload_url"], "title": "CreateSourceResponse", "type": "object" }, "CreateStorageLocationRequest": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "title": "Description" }, "latitude": { "maximum": 90.0, "minimum": -90.0, "title": "Latitude", "type": "number" }, "longitude": { "maximum": 180.0, "minimum": -180.0, "title": "Longitude", "type": "number" }, "name": { "title": "Name", "type": "string" }, "project_id": { "example": "prj_1CTWZQGKE1S0VAXA", "examples": ["prj_1CTWZQGKE1S0VAXA", "prj_1E0QTWB22SBX34D1"], "maxLength": 37, "minLength": 20, "title": "Project Id", "type": "string" }, "storage_method": { "anyOf": [ { "$ref": "#/components/schemas/StorageMethod" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "title": "Storage Method" }, "supplier_reference_id": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "title": "Supplier Reference Id" } }, "required": ["project_id", "name", "latitude", "longitude"], "title": "CreateStorageLocationRequest", "type": "object" }, "CreateStorageUnitRequest": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "title": "Description" }, "latitude": { "maximum": 90.0, "minimum": -90.0, "title": "Latitude", "type": "number" }, "longitude": { "maximum": 180.0, "minimum": -180.0, "title": "Longitude", "type": "number" }, "name": { "title": "Name", "type": "string" }, "storage_location_id": { "example": "slc_1F3PMGVC91S0SBK3", "examples": ["slc_1F3PMGVC91S0SBK3", "slc_1DCY5K78BSBX3XMZ"], "maxLength": 37, "minLength": 20, "title": "Storage Location Id", "type": "string" }, "supplier_reference_id": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "title": "Supplier Reference Id" } }, "required": ["storage_location_id", "name", "latitude", "longitude"], "title": "CreateStorageUnitRequest", "type": "object" }, "DataUploadSubmission": { "properties": { "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Error message if the submission failed during processing.", "title": "Error Message" }, "facility_id": { "anyOf": [ { "example": "fcl_1G8QT5ZAB1S0XSDW", "examples": ["fcl_1G8QT5ZAB1S0XSDW", "fcl_1E384BDCGSBXNNZZ"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "title": "Facility Id" }, "id": { "example": "dus_1GBBSJ6P91S0R41N", "examples": ["dus_1GBBSJ6P91S0R41N", "dus_1CRY1X1Q3SBX1CY2"], "maxLength": 37, "minLength": 20, "title": "Id", "type": "string" }, "status": { "$ref": "#/components/schemas/DataUploadSubmissionStatus" }, "storage_location_id": { "anyOf": [ { "example": "slc_1F3PMGVC91S0SBK3", "examples": ["slc_1F3PMGVC91S0SBK3", "slc_1DCY5K78BSBX3XMZ"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "title": "Storage Location Id" }, "submission_type": { "$ref": "#/components/schemas/DataUploadSubmissionType" } }, "required": [ "id", "submission_type", "status", "storage_location_id", "facility_id" ], "title": "DataUploadSubmission", "type": "object" }, "DataUploadSubmissionStatus": { "enum": ["pending", "completed", "failed"], "title": "DataUploadSubmissionStatus", "type": "string" }, "DataUploadSubmissionType": { "enum": [ "biochar_pyrolysis_reactor_facility_time_series", "dac_storage_site_time_series", "dac_facility_time_series", "wae_wastewater_treatment_plant_facility_time_series" ], "title": "DataUploadSubmissionType", "type": "string" }, "Datapoint": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "display_name": { "title": "Display Name", "type": "string" }, "id": { "example": "dtp_1DVKHKS101S0Q61Q", "examples": ["dtp_1DVKHKS101S0Q61Q", "dtp_1DJN8P57VSBXASFX"], "maxLength": 37, "minLength": 20, "title": "Id", "type": "string" }, "locked_status": { "$ref": "#/components/schemas/DatapointLockedStatus" }, "measured_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Measured At" }, "project_id": { "anyOf": [ { "example": "prj_1CTWZQGKE1S0VAXA", "examples": ["prj_1CTWZQGKE1S0VAXA", "prj_1E0QTWB22SBX34D1"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "title": "Project Id" }, "quantity": { "$ref": "#/components/schemas/ScalarQuantity" }, "source_ids": { "items": { "example": "src_1EBBF4M7X1S06G1Y", "examples": ["src_1EBBF4M7X1S06G1Y", "src_1DW1B17VNSBX37N0"], "maxLength": 37, "minLength": 20, "type": "string" }, "title": "Source Ids", "type": "array" }, "supplier_reference_id": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Supplier Reference Id" }, "type": { "$ref": "#/components/schemas/DatapointType" }, "uncertainty_justification": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "\nProvide an uncertainty justification where required for inputs identified as sensitive in sensitivity analysis.\n", "title": "Uncertainty Justification" } }, "required": [ "id", "supplier_reference_id", "display_name", "type", "quantity", "description", "source_ids", "measured_at", "project_id", "locked_status" ], "title": "Datapoint", "type": "object" }, "DatapointLockedStatus": { "description": "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.", "enum": [ "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" ], "title": "DatapointLockedStatus", "type": "string" }, "DatapointQuantityInput": { "properties": { "magnitude": { "title": "Magnitude", "type": "number" }, "standard_deviation": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The standard deviation of the datapoint in the same units as the magnitude. Leave null if the datapoint is not to be included in the uncertainty analysis for the removal.", "title": "Standard Deviation" }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unit" } }, "required": ["magnitude", "unit"], "title": "DatapointQuantityInput", "type": "object" }, "DatapointType": { "enum": [ "CONSTANT", "STANDARD_PUBLISHED_VALUE", "REPORTED", "ASSUMPTION", "DERIVED" ], "title": "DatapointType", "type": "string" }, "FeedstockBatch": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "delivery_date": { "format": "date", "title": "Delivery Date", "type": "string" }, "display_name": { "title": "Display Name", "type": "string" }, "feedstock_type_id": { "example": "ftt_1D7KZ1P761S0G7BN", "examples": ["ftt_1D7KZ1P761S0G7BN", "ftt_1CSRJN4HHSBXZ3TK"], "maxLength": 37, "minLength": 20, "title": "Feedstock Type Id", "type": "string" }, "id": { "example": "ftb_1DYYDB3C91S0ZHPX", "examples": ["ftb_1DYYDB3C91S0ZHPX", "ftb_1G59XDK6HSBXCZ9B"], "maxLength": 37, "minLength": 20, "title": "Id", "type": "string" }, "mass": { "anyOf": [ { "$ref": "#/components/schemas/ScalarQuantity" }, { "type": "null" } ] }, "supplier_reference_id": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Supplier Reference Id" } }, "required": [ "id", "feedstock_type_id", "supplier_reference_id", "display_name", "delivery_date", "mass", "created_at" ], "title": "FeedstockBatch", "type": "object" }, "FeedstockType": { "properties": { "id": { "example": "ftt_1D7KZ1P761S0G7BN", "examples": ["ftt_1D7KZ1P761S0G7BN", "ftt_1CSRJN4HHSBXZ3TK"], "maxLength": 37, "minLength": 20, "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "supplier_reference_id": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Supplier Reference Id" } }, "required": ["id", "supplier_reference_id", "name"], "title": "FeedstockType", "type": "object" }, "FileUpload": { "properties": { "id": { "example": "tfu_1DZPAW31R1S0ZESH", "examples": ["tfu_1DZPAW31R1S0ZESH", "tfu_1CHF4YC38SBX9E20"], "maxLength": 37, "minLength": 20, "title": "Id", "type": "string" }, "upload_url": { "description": "A presigned upload URL, which must be used to upload the document associated with this source.", "title": "Upload Url", "type": "string" } }, "required": ["id", "upload_url"], "title": "FileUpload", "type": "object" }, "Frequency": { "enum": [ "na", "once", "optional", "if_needed", "every_1_days", "every_1_months", "every_2_weeks", "every_3_months", "every_6_months", "every_2_years", "every_5_years" ], "title": "Frequency", "type": "string" }, "GhgStatement": { "properties": { "credits_issued_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Credits Issued At" }, "ghg_statement_report_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ghg Statement Report Url" }, "id": { "example": "ggs_1GDQJ99Z51S0DYW9", "examples": ["ggs_1GDQJ99Z51S0DYW9", "ggs_1FWVEQRWSSBXK3NB"], "maxLength": 37, "minLength": 20, "title": "Id", "type": "string" }, "pending_total_co2e_removed_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "If the GHG statement has pending changes, this is the net CO\u2082e removed by the removals in the GHG statement, including any changes that are pending. If the GHG statement has no pending changes, this is None.", "title": "Pending Total Co2E Removed Kg" }, "project_id": { "example": "prj_1CTWZQGKE1S0VAXA", "examples": ["prj_1CTWZQGKE1S0VAXA", "prj_1E0QTWB22SBX34D1"], "maxLength": 37, "minLength": 20, "title": "Project Id", "type": "string" }, "removal_ids": { "items": { "example": "rmv_1EEM6NJXX1S0EXKD", "examples": ["rmv_1EEM6NJXX1S0EXKD", "rmv_1E3V4J2EWSBX5E82"], "maxLength": 37, "minLength": 20, "type": "string" }, "title": "Removal Ids", "type": "array" }, "reporting_period_end_at": { "description": "End date of the reporting period (inclusive)", "format": "date", "title": "Reporting Period End At", "type": "string" }, "reporting_period_start_at": { "description": "Start date of the reporting period (inclusive)", "format": "date", "title": "Reporting Period Start At", "type": "string" }, "status": { "$ref": "#/components/schemas/GhgStatementStatus" }, "submitted_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Submitted At" }, "verifier": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Name of the verifier of the GHG statement", "title": "Verifier" } }, "required": [ "id", "project_id", "verifier", "removal_ids", "ghg_statement_report_url", "status", "reporting_period_start_at", "reporting_period_end_at", "submitted_at", "credits_issued_at", "pending_total_co2e_removed_kg" ], "title": "GhgStatement", "type": "object" }, "GhgStatementStatus": { "enum": [ "DRAFT", "AWAITING_VERIFICATION", "VERIFIED", "CREDITS_ISSUED", "FAILED_VERIFICATION" ], "title": "GhgStatementStatus", "type": "string" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "title": "Detail", "type": "array" } }, "title": "HTTPValidationError", "type": "object" }, "InputDataShape": { "enum": ["SCALAR", "LIST"], "title": "InputDataShape", "type": "string" }, "IsometricIDPathParam_BiocharSpreadEvent_": { "$ref": "#/components/schemas/IsometricIDRequestParam_BiocharSpreadEvent_" }, "IsometricIDPathParam_Component_": { "$ref": "#/components/schemas/IsometricIDRequestParam_Component_" }, "IsometricIDPathParam_DataUploadSubmission_": { "$ref": "#/components/schemas/IsometricIDRequestParam_DataUploadSubmission_" }, "IsometricIDPathParam_Datapoint_": { "$ref": "#/components/schemas/IsometricIDRequestParam_Datapoint_" }, "IsometricIDPathParam_FeedstockBatch_": { "$ref": "#/components/schemas/IsometricIDRequestParam_FeedstockBatch_" }, "IsometricIDPathParam_FeedstockType_": { "$ref": "#/components/schemas/IsometricIDRequestParam_FeedstockType_" }, "IsometricIDPathParam_GhgEntryTemplate_": { "$ref": "#/components/schemas/IsometricIDRequestParam_GhgEntryTemplate_" }, "IsometricIDPathParam_GhgEntry_": { "$ref": "#/components/schemas/IsometricIDRequestParam_GhgEntry_" }, "IsometricIDPathParam_GhgStatement_": { "$ref": "#/components/schemas/IsometricIDRequestParam_GhgStatement_" }, "IsometricIDPathParam_MeasurementLocation_": { "$ref": "#/components/schemas/IsometricIDRequestParam_MeasurementLocation_" }, "IsometricIDPathParam_MonitoringRequirement_": { "$ref": "#/components/schemas/IsometricIDRequestParam_MonitoringRequirement_" }, "IsometricIDPathParam_MonitoringSubmission_": { "$ref": "#/components/schemas/IsometricIDRequestParam_MonitoringSubmission_" }, "IsometricIDPathParam_ProductionBatch_": { "$ref": "#/components/schemas/IsometricIDRequestParam_ProductionBatch_" }, "IsometricIDPathParam_ProjectRequirement_": { "$ref": "#/components/schemas/IsometricIDRequestParam_ProjectRequirement_" }, "IsometricIDPathParam_Project_": { "$ref": "#/components/schemas/IsometricIDRequestParam_Project_" }, "IsometricIDPathParam_Sensor_": { "$ref": "#/components/schemas/IsometricIDRequestParam_Sensor_" }, "IsometricIDPathParam_Source_": { "$ref": "#/components/schemas/IsometricIDRequestParam_Source_" }, "IsometricIDPathParam_StorageLocation_": { "$ref": "#/components/schemas/IsometricIDRequestParam_StorageLocation_" }, "IsometricIDPathParam_StorageUnit_": { "$ref": "#/components/schemas/IsometricIDRequestParam_StorageUnit_" }, "IsometricIDQueryParam_GhgEntryTemplate_": { "$ref": "#/components/schemas/IsometricIDRequestParam_GhgEntryTemplate_" }, "IsometricIDQueryParam_GhgEntry_": { "$ref": "#/components/schemas/IsometricIDRequestParam_GhgEntry_" }, "IsometricIDQueryParam_GhgStatement_": { "$ref": "#/components/schemas/IsometricIDRequestParam_GhgStatement_" }, "IsometricIDQueryParam_MeasurementSample_": { "$ref": "#/components/schemas/IsometricIDRequestParam_MeasurementSample_" }, "IsometricIDQueryParam_Project_": { "$ref": "#/components/schemas/IsometricIDRequestParam_Project_" }, "IsometricIDQueryParam_StorageLocation_": { "$ref": "#/components/schemas/IsometricIDRequestParam_StorageLocation_" }, "IsometricIDQueryParam_StorageUnit_": { "$ref": "#/components/schemas/IsometricIDRequestParam_StorageUnit_" }, "IsometricIDRequestParam_BiocharSpreadEvent_": { "example": "bse_1F1FDSGPE1S0374B", "examples": ["bse_1F1FDSGPE1S0374B", "bse_1DGG1R6DZSBXACD8"], "maxLength": 37, "minLength": 20, "type": "string" }, "IsometricIDRequestParam_Component_": { "example": "cmp_1EP2SB7MZ1S036PY", "examples": ["cmp_1EP2SB7MZ1S036PY", "cmp_1EHK4R6QJSBXFC5N"], "maxLength": 37, "minLength": 20, "type": "string" }, "IsometricIDRequestParam_DataUploadSubmission_": { "example": "dus_1GBBSJ6P91S0R41N", "examples": ["dus_1GBBSJ6P91S0R41N", "dus_1CRY1X1Q3SBX1CY2"], "maxLength": 37, "minLength": 20, "type": "string" }, "IsometricIDRequestParam_Datapoint_": { "example": "dtp_1DVKHKS101S0Q61Q", "examples": ["dtp_1DVKHKS101S0Q61Q", "dtp_1DJN8P57VSBXASFX"], "maxLength": 37, "minLength": 20, "type": "string" }, "IsometricIDRequestParam_FeedstockBatch_": { "example": "ftb_1DYYDB3C91S0ZHPX", "examples": ["ftb_1DYYDB3C91S0ZHPX", "ftb_1G59XDK6HSBXCZ9B"], "maxLength": 37, "minLength": 20, "type": "string" }, "IsometricIDRequestParam_FeedstockType_": { "example": "ftt_1D7KZ1P761S0G7BN", "examples": ["ftt_1D7KZ1P761S0G7BN", "ftt_1CSRJN4HHSBXZ3TK"], "maxLength": 37, "minLength": 20, "type": "string" }, "IsometricIDRequestParam_GhgEntryTemplate_": { "example": "rvt_1EVC8RZFE1S0BAT6", "examples": ["rvt_1EVC8RZFE1S0BAT6", "rvt_1ECDZGE2DSBX88EX"], "maxLength": 37, "minLength": 20, "type": "string" }, "IsometricIDRequestParam_GhgEntry_": { "example": "rmv_1EEM6NJXX1S0EXKD", "examples": ["rmv_1EEM6NJXX1S0EXKD", "rmv_1E3V4J2EWSBX5E82"], "maxLength": 37, "minLength": 20, "type": "string" }, "IsometricIDRequestParam_GhgStatement_": { "example": "ggs_1GDQJ99Z51S0DYW9", "examples": ["ggs_1GDQJ99Z51S0DYW9", "ggs_1FWVEQRWSSBXK3NB"], "maxLength": 37, "minLength": 20, "type": "string" }, "IsometricIDRequestParam_MeasurementLocation_": { "example": "mlc_1CCZASA6Q1S0V8T4", "examples": ["mlc_1CCZASA6Q1S0V8T4", "mlc_1GF73PG90SBXKEX1"], "maxLength": 37, "minLength": 20, "type": "string" }, "IsometricIDRequestParam_MeasurementSample_": { "example": "mts_1D7HS15KD1S03M0Z", "examples": ["mts_1D7HS15KD1S03M0Z", "mts_1FN0MEX2ZSBX40DT"], "maxLength": 37, "minLength": 20, "type": "string" }, "IsometricIDRequestParam_MonitoringRequirement_": { "example": "mnr_1DJJQY5C61S0R519", "examples": ["mnr_1DJJQY5C61S0R519", "mnr_1EKAZQMAZSBXDV59"], "maxLength": 37, "minLength": 20, "type": "string" }, "IsometricIDRequestParam_MonitoringSubmission_": { "example": "mns_1D46WGW6A1S03FRG", "examples": ["mns_1D46WGW6A1S03FRG", "mns_1DCRH1P6JSBX480H"], "maxLength": 37, "minLength": 20, "type": "string" }, "IsometricIDRequestParam_ProductionBatch_": { "example": "ptb_1GAFJ4C051S06E0Z", "examples": ["ptb_1GAFJ4C051S06E0Z", "ptb_1FQVMJYTASBXSZT8"], "maxLength": 37, "minLength": 20, "type": "string" }, "IsometricIDRequestParam_ProjectRequirement_": { "example": "pfx_1HQTSP3RX1S0Y2RG", "examples": ["pfx_1HQTSP3RX1S0Y2RG", "pfx_1FFWQZH4HSBX6F9N"], "maxLength": 37, "minLength": 20, "type": "string" }, "IsometricIDRequestParam_Project_": { "example": "prj_1CTWZQGKE1S0VAXA", "examples": ["prj_1CTWZQGKE1S0VAXA", "prj_1E0QTWB22SBX34D1"], "maxLength": 37, "minLength": 20, "type": "string" }, "IsometricIDRequestParam_Sensor_": { "example": "sns_1GJ82BEMB1S0FBFV", "examples": ["sns_1GJ82BEMB1S0FBFV", "sns_1CCYZYWFWSBXYG38"], "maxLength": 37, "minLength": 20, "type": "string" }, "IsometricIDRequestParam_Source_": { "example": "src_1EBBF4M7X1S06G1Y", "examples": ["src_1EBBF4M7X1S06G1Y", "src_1DW1B17VNSBX37N0"], "maxLength": 37, "minLength": 20, "type": "string" }, "IsometricIDRequestParam_StorageLocation_": { "example": "slc_1F3PMGVC91S0SBK3", "examples": ["slc_1F3PMGVC91S0SBK3", "slc_1DCY5K78BSBX3XMZ"], "maxLength": 37, "minLength": 20, "type": "string" }, "IsometricIDRequestParam_StorageUnit_": { "example": "sgu_1E844FWM71S0E0TM", "examples": ["sgu_1E844FWM71S0E0TM", "sgu_1DTBHQEBGSBXBCZV"], "maxLength": 37, "minLength": 20, "type": "string" }, "MeasurementLocation": { "properties": { "id": { "example": "mlc_1CCZASA6Q1S0V8T4", "examples": ["mlc_1CCZASA6Q1S0V8T4", "mlc_1GF73PG90SBXKEX1"], "maxLength": 37, "minLength": 20, "title": "Id", "type": "string" }, "latitude": { "maximum": 90.0, "minimum": -90.0, "title": "Latitude", "type": "number" }, "longitude": { "maximum": 180.0, "minimum": -180.0, "title": "Longitude", "type": "number" }, "supplier_reference_id": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Supplier Reference Id" } }, "required": ["id", "latitude", "longitude", "supplier_reference_id"], "title": "MeasurementLocation", "type": "object" }, "MeasurementProperty": { "properties": { "qualifier": { "anyOf": [ { "$ref": "#/components/schemas/QuantityKindQualifierType" }, { "type": "null" } ] }, "quantity_kind": { "$ref": "#/components/schemas/QuantityKindType" } }, "required": ["quantity_kind", "qualifier"], "title": "MeasurementProperty", "type": "object" }, "MeasurementSample": { "properties": { "id": { "example": "mts_1D7HS15KD1S03M0Z", "examples": ["mts_1D7HS15KD1S03M0Z", "mts_1FN0MEX2ZSBX40DT"], "maxLength": 37, "minLength": 20, "title": "Id", "type": "string" }, "measured_at": { "format": "date", "title": "Measured At", "type": "string" }, "measurement_location_id": { "anyOf": [ { "example": "mlc_1CCZASA6Q1S0V8T4", "examples": ["mlc_1CCZASA6Q1S0V8T4", "mlc_1GF73PG90SBXKEX1"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "title": "Measurement Location Id" }, "production_batch_id": { "anyOf": [ { "example": "ptb_1GAFJ4C051S06E0Z", "examples": ["ptb_1GAFJ4C051S06E0Z", "ptb_1FQVMJYTASBXSZT8"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "title": "Production Batch Id" }, "supplier_reference_id": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Supplier Reference Id" }, "values": { "items": { "$ref": "#/components/schemas/MeasurementValue" }, "title": "Values", "type": "array" } }, "required": [ "id", "supplier_reference_id", "values", "measured_at", "measurement_location_id", "production_batch_id" ], "title": "MeasurementSample", "type": "object" }, "MeasurementTypeKey": { "enum": [ "biochar_production_batch", "biochar_soil", "pyrolysis_reactor", "ew_soil", "ew_porewater", "ew_field_biomass", "ew_mineral_feedstock", "ew_ion_exchange_resin" ], "title": "MeasurementTypeKey", "type": "string" }, "MeasurementValue": { "properties": { "datapoint_id": { "example": "dtp_1DVKHKS101S0Q61Q", "examples": ["dtp_1DVKHKS101S0Q61Q", "dtp_1DJN8P57VSBXASFX"], "maxLength": 37, "minLength": 20, "title": "Datapoint Id", "type": "string" }, "measurement_property": { "$ref": "#/components/schemas/MeasurementProperty" }, "value": { "$ref": "#/components/schemas/ScalarQuantity" } }, "required": ["datapoint_id", "value", "measurement_property"], "title": "MeasurementValue", "type": "object" }, "MonitoringPhase": { "enum": ["pre_op", "operation", "post_op", "feedstock"], "title": "MonitoringPhase", "type": "string" }, "MonitoringSubmission": { "properties": { "id": { "example": "mns_1D46WGW6A1S03FRG", "examples": ["mns_1D46WGW6A1S03FRG", "mns_1DCRH1P6JSBX480H"], "maxLength": 37, "minLength": 20, "title": "Id", "type": "string" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes" }, "project_monitoring_requirement_id": { "anyOf": [ { "example": "pfx_1HQTSP3RX1S0Y2RG", "examples": ["pfx_1HQTSP3RX1S0Y2RG", "pfx_1FFWQZH4HSBX6F9N"], "maxLength": 37, "minLength": 20, "type": "string" }, { "example": "mnr_1DJJQY5C61S0R519", "examples": ["mnr_1DJJQY5C61S0R519", "mnr_1EKAZQMAZSBXDV59"], "maxLength": 37, "minLength": 20, "type": "string" } ], "title": "Project Monitoring Requirement Id" }, "source_id": { "example": "src_1EBBF4M7X1S06G1Y", "examples": ["src_1EBBF4M7X1S06G1Y", "src_1DW1B17VNSBX37N0"], "maxLength": 37, "minLength": 20, "title": "Source Id", "type": "string" }, "supplier_reference_id": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Supplier Reference Id" }, "valid_from": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Valid From" }, "valid_to": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Valid To" } }, "required": [ "id", "project_monitoring_requirement_id", "source_id", "valid_from", "valid_to", "supplier_reference_id", "notes" ], "title": "MonitoringSubmission", "type": "object" }, "Organisation": { "properties": { "id": { "example": "org_1GB56M1ST1S0GVNA", "examples": ["org_1GB56M1ST1S0GVNA", "org_1CP8EQDNQSBXTMR2"], "maxLength": 37, "minLength": 20, "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "required": ["id", "name"], "title": "Organisation", "type": "object" }, "PageInfo": { "properties": { "end_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Cursor" }, "has_next_page": { "title": "Has Next Page", "type": "boolean" }, "has_previous_page": { "title": "Has Previous Page", "type": "boolean" }, "start_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Cursor" } }, "required": [ "has_previous_page", "start_cursor", "has_next_page", "end_cursor" ], "title": "PageInfo", "type": "object" }, "PaginatedListResource_BiocharApplication_": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/BiocharApplication" }, "title": "Nodes", "type": "array" }, "page_info": { "$ref": "#/components/schemas/PageInfo" }, "total_count": { "title": "Total Count", "type": "integer" } }, "required": ["nodes", "total_count", "page_info"], "title": "PaginatedListResource[BiocharApplication]", "type": "object" }, "PaginatedListResource_ComponentAttribution_": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/ComponentAttribution" }, "title": "Nodes", "type": "array" }, "page_info": { "$ref": "#/components/schemas/PageInfo" }, "total_count": { "title": "Total Count", "type": "integer" } }, "required": ["nodes", "total_count", "page_info"], "title": "PaginatedListResource[ComponentAttribution]", "type": "object" }, "PaginatedListResource_ComponentBlueprint_": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/ComponentBlueprint" }, "title": "Nodes", "type": "array" }, "page_info": { "$ref": "#/components/schemas/PageInfo" }, "total_count": { "title": "Total Count", "type": "integer" } }, "required": ["nodes", "total_count", "page_info"], "title": "PaginatedListResource[ComponentBlueprint]", "type": "object" }, "PaginatedListResource_Component_": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/Component" }, "title": "Nodes", "type": "array" }, "page_info": { "$ref": "#/components/schemas/PageInfo" }, "total_count": { "title": "Total Count", "type": "integer" } }, "required": ["nodes", "total_count", "page_info"], "title": "PaginatedListResource[Component]", "type": "object" }, "PaginatedListResource_DataUploadSubmission_": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/DataUploadSubmission" }, "title": "Nodes", "type": "array" }, "page_info": { "$ref": "#/components/schemas/PageInfo" }, "total_count": { "title": "Total Count", "type": "integer" } }, "required": ["nodes", "total_count", "page_info"], "title": "PaginatedListResource[DataUploadSubmission]", "type": "object" }, "PaginatedListResource_Datapoint_": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/Datapoint" }, "title": "Nodes", "type": "array" }, "page_info": { "$ref": "#/components/schemas/PageInfo" }, "total_count": { "title": "Total Count", "type": "integer" } }, "required": ["nodes", "total_count", "page_info"], "title": "PaginatedListResource[Datapoint]", "type": "object" }, "PaginatedListResource_FeedstockBatch_": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/FeedstockBatch" }, "title": "Nodes", "type": "array" }, "page_info": { "$ref": "#/components/schemas/PageInfo" }, "total_count": { "title": "Total Count", "type": "integer" } }, "required": ["nodes", "total_count", "page_info"], "title": "PaginatedListResource[FeedstockBatch]", "type": "object" }, "PaginatedListResource_FeedstockType_": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/FeedstockType" }, "title": "Nodes", "type": "array" }, "page_info": { "$ref": "#/components/schemas/PageInfo" }, "total_count": { "title": "Total Count", "type": "integer" } }, "required": ["nodes", "total_count", "page_info"], "title": "PaginatedListResource[FeedstockType]", "type": "object" }, "PaginatedListResource_GhgStatement_": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/GhgStatement" }, "title": "Nodes", "type": "array" }, "page_info": { "$ref": "#/components/schemas/PageInfo" }, "total_count": { "title": "Total Count", "type": "integer" } }, "required": ["nodes", "total_count", "page_info"], "title": "PaginatedListResource[GhgStatement]", "type": "object" }, "PaginatedListResource_MeasurementLocation_": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/MeasurementLocation" }, "title": "Nodes", "type": "array" }, "page_info": { "$ref": "#/components/schemas/PageInfo" }, "total_count": { "title": "Total Count", "type": "integer" } }, "required": ["nodes", "total_count", "page_info"], "title": "PaginatedListResource[MeasurementLocation]", "type": "object" }, "PaginatedListResource_MeasurementSample_": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/MeasurementSample" }, "title": "Nodes", "type": "array" }, "page_info": { "$ref": "#/components/schemas/PageInfo" }, "total_count": { "title": "Total Count", "type": "integer" } }, "required": ["nodes", "total_count", "page_info"], "title": "PaginatedListResource[MeasurementSample]", "type": "object" }, "PaginatedListResource_MonitoringSubmission_": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/MonitoringSubmission" }, "title": "Nodes", "type": "array" }, "page_info": { "$ref": "#/components/schemas/PageInfo" }, "total_count": { "title": "Total Count", "type": "integer" } }, "required": ["nodes", "total_count", "page_info"], "title": "PaginatedListResource[MonitoringSubmission]", "type": "object" }, "PaginatedListResource_Process_": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/Process" }, "title": "Nodes", "type": "array" }, "page_info": { "$ref": "#/components/schemas/PageInfo" }, "total_count": { "title": "Total Count", "type": "integer" } }, "required": ["nodes", "total_count", "page_info"], "title": "PaginatedListResource[Process]", "type": "object" }, "PaginatedListResource_ProductionBatch_": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/ProductionBatch" }, "title": "Nodes", "type": "array" }, "page_info": { "$ref": "#/components/schemas/PageInfo" }, "total_count": { "title": "Total Count", "type": "integer" } }, "required": ["nodes", "total_count", "page_info"], "title": "PaginatedListResource[ProductionBatch]", "type": "object" }, "PaginatedListResource_ProjectMonitoringRequirement_": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/ProjectMonitoringRequirement" }, "title": "Nodes", "type": "array" }, "page_info": { "$ref": "#/components/schemas/PageInfo" }, "total_count": { "title": "Total Count", "type": "integer" } }, "required": ["nodes", "total_count", "page_info"], "title": "PaginatedListResource[ProjectMonitoringRequirement]", "type": "object" }, "PaginatedListResource_Project_": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/Project" }, "title": "Nodes", "type": "array" }, "page_info": { "$ref": "#/components/schemas/PageInfo" }, "total_count": { "title": "Total Count", "type": "integer" } }, "required": ["nodes", "total_count", "page_info"], "title": "PaginatedListResource[Project]", "type": "object" }, "PaginatedListResource_RemovalTemplateComponent_": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/RemovalTemplateComponent" }, "title": "Nodes", "type": "array" }, "page_info": { "$ref": "#/components/schemas/PageInfo" }, "total_count": { "title": "Total Count", "type": "integer" } }, "required": ["nodes", "total_count", "page_info"], "title": "PaginatedListResource[RemovalTemplateComponent]", "type": "object" }, "PaginatedListResource_RemovalTemplate_": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/RemovalTemplate" }, "title": "Nodes", "type": "array" }, "page_info": { "$ref": "#/components/schemas/PageInfo" }, "total_count": { "title": "Total Count", "type": "integer" } }, "required": ["nodes", "total_count", "page_info"], "title": "PaginatedListResource[RemovalTemplate]", "type": "object" }, "PaginatedListResource_Removal_": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/Removal" }, "title": "Nodes", "type": "array" }, "page_info": { "$ref": "#/components/schemas/PageInfo" }, "total_count": { "title": "Total Count", "type": "integer" } }, "required": ["nodes", "total_count", "page_info"], "title": "PaginatedListResource[Removal]", "type": "object" }, "PaginatedListResource_Sensor_": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/Sensor" }, "title": "Nodes", "type": "array" }, "page_info": { "$ref": "#/components/schemas/PageInfo" }, "total_count": { "title": "Total Count", "type": "integer" } }, "required": ["nodes", "total_count", "page_info"], "title": "PaginatedListResource[Sensor]", "type": "object" }, "PaginatedListResource_Source_": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/Source" }, "title": "Nodes", "type": "array" }, "page_info": { "$ref": "#/components/schemas/PageInfo" }, "total_count": { "title": "Total Count", "type": "integer" } }, "required": ["nodes", "total_count", "page_info"], "title": "PaginatedListResource[Source]", "type": "object" }, "PaginatedListResource_StorageLocation_": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/StorageLocation" }, "title": "Nodes", "type": "array" }, "page_info": { "$ref": "#/components/schemas/PageInfo" }, "total_count": { "title": "Total Count", "type": "integer" } }, "required": ["nodes", "total_count", "page_info"], "title": "PaginatedListResource[StorageLocation]", "type": "object" }, "PaginatedListResource_StorageUnit_": { "properties": { "nodes": { "items": { "$ref": "#/components/schemas/StorageUnit" }, "title": "Nodes", "type": "array" }, "page_info": { "$ref": "#/components/schemas/PageInfo" }, "total_count": { "title": "Total Count", "type": "integer" } }, "required": ["nodes", "total_count", "page_info"], "title": "PaginatedListResource[StorageUnit]", "type": "object" }, "PatchComponentRequest": { "properties": { "allocation_strategy": { "anyOf": [ { "$ref": "#/components/schemas/ProjectComponentAmortizationStrategy" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "description": "Allocation strategy to change the component to. This can only be set on project-scoped components.", "title": "Allocation Strategy" }, "description": { "anyOf": [ { "type": "string" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "title": "Description" }, "display_name": { "anyOf": [ { "maxLength": 100, "minLength": 1, "type": "string" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "title": "Display Name" }, "inputs": { "anyOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/CreateComponentListInput" }, { "$ref": "#/components/schemas/CreateComponentScalarInput" } ] }, "type": "array" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "description": "Overwrite existing component inputs", "title": "Inputs" } }, "title": "PatchComponentRequest", "type": "object" }, "PatchDatapointRequest": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "title": "Description" }, "display_name": { "anyOf": [ { "maxLength": 100, "minLength": 1, "type": "string" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "title": "Display Name" }, "quantity": { "anyOf": [ { "$ref": "#/components/schemas/DatapointQuantityInput" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "title": "Quantity" }, "source_ids": { "anyOf": [ { "items": { "example": "src_1EBBF4M7X1S06G1Y", "examples": ["src_1EBBF4M7X1S06G1Y", "src_1DW1B17VNSBX37N0"], "maxLength": 37, "minLength": 20, "type": "string" }, "type": "array" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "description": "Overwrite existing source IDs", "title": "Source Ids" }, "type": { "anyOf": [ { "$ref": "#/components/schemas/DatapointType" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "title": "Type" }, "uncertainty_justification": { "anyOf": [ { "type": "string" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "description": "\nProvide an uncertainty justification where required for inputs identified as sensitive in sensitivity analysis.\n", "title": "Uncertainty Justification" } }, "title": "PatchDatapointRequest", "type": "object" }, "PatchFeedstockType": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "title": "Name" }, "supplier_reference_id": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "title": "Supplier Reference Id" } }, "title": "PatchFeedstockType", "type": "object" }, "PatchRemovalComponentAttributionsRequest": { "properties": { "components_to_add": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ComponentToAttribute" }, "type": "array" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "description": "Components to be attributed to Removal.", "title": "Components To Add" }, "components_to_remove": { "anyOf": [ { "items": { "example": "cmp_1EP2SB7MZ1S036PY", "examples": ["cmp_1EP2SB7MZ1S036PY", "cmp_1EHK4R6QJSBXFC5N"], "maxLength": 37, "minLength": 20, "type": "string" }, "type": "array" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "description": "Components to be fully removed from Removal.", "title": "Components To Remove" } }, "title": "PatchRemovalComponentAttributionsRequest", "type": "object" }, "PatchRemovalRequest": { "properties": { "add_components": { "anyOf": [ { "items": { "$ref": "#/components/schemas/AddComponentToRemoval" }, "type": "array" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "deprecated": true, "description": "Deprecated, please use `PATCH /removal/{id}/component_attributions` instead.\n\nComponents to be attributed to the removal.", "title": "Add Components" }, "completed_on": { "anyOf": [ { "description": "Date in ISO format (YYYY-MM-DD)", "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date by which activities related to this removal finished.", "title": "Completed On" }, "delete_component_ids": { "anyOf": [ { "items": { "example": "cmp_1EP2SB7MZ1S036PY", "examples": ["cmp_1EP2SB7MZ1S036PY", "cmp_1EHK4R6QJSBXFC5N"], "maxLength": 37, "minLength": 20, "type": "string" }, "type": "array" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "deprecated": true, "description": "Deprecated, please use `PATCH /removal/{id}/component_attributions` instead.\n\nIDs for components to delete from the removal.", "title": "Delete Component Ids" }, "feedstock_type_id": { "anyOf": [ { "example": "ftt_1D7KZ1P761S0G7BN", "examples": ["ftt_1D7KZ1P761S0G7BN", "ftt_1CSRJN4HHSBXZ3TK"], "maxLength": 37, "minLength": 20, "type": "string" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "description": "ID of the feedstock type for the removal.", "title": "Feedstock Type Id" }, "started_on": { "anyOf": [ { "description": "Date in ISO format (YYYY-MM-DD)", "format": "date", "type": "string" }, { "type": "null" } ], "description": "The date at which activities related to this removal started.", "title": "Started On" } }, "title": "PatchRemovalRequest", "type": "object" }, "PatchSourceRequest": { "properties": { "display_name": { "anyOf": [ { "maxLength": 100, "minLength": 1, "type": "string" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "title": "Display Name" }, "is_public": { "anyOf": [ { "type": "boolean" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "description": "If the source document should be publicly available on the Registry once credits are issued.", "title": "Is Public" }, "published_at": { "anyOf": [ { "description": "Date in ISO format (YYYY-MM-DD)", "format": "date", "type": "string" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "title": "Published At" }, "supplier_reference_id": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "title": "Supplier Reference Id" } }, "title": "PatchSourceRequest", "type": "object" }, "PatchStorageLocationRequest": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "title": "Description" }, "latitude": { "anyOf": [ { "maximum": 90.0, "minimum": -90.0, "type": "number" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "title": "Latitude" }, "longitude": { "anyOf": [ { "maximum": 180.0, "minimum": -180.0, "type": "number" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "title": "Longitude" }, "name": { "anyOf": [ { "type": "string" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "title": "Name" }, "storage_method": { "anyOf": [ { "$ref": "#/components/schemas/StorageMethod" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "title": "Storage Method" }, "supplier_reference_id": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "$ref": "#/components/schemas/Undefined" } ], "default": { "__typename": "Undefined" }, "title": "Supplier Reference Id" } }, "title": "PatchStorageLocationRequest", "type": "object" }, "Process": { "properties": { "display_name": { "title": "Display Name", "type": "string" }, "key": { "title": "Key", "type": "string" }, "steps": { "items": { "$ref": "#/components/schemas/ProcessStep" }, "title": "Steps", "type": "array" } }, "required": ["key", "display_name", "steps"], "title": "Process", "type": "object" }, "ProcessStep": { "properties": { "description": { "title": "Description", "type": "string" }, "display_name": { "title": "Display Name", "type": "string" }, "key": { "title": "Key", "type": "string" } }, "required": ["key", "display_name", "description"], "title": "ProcessStep", "type": "object" }, "ProductionBatch": { "properties": { "display_name": { "title": "Display Name", "type": "string" }, "ended_at": { "format": "date-time", "title": "Ended At", "type": "string" }, "facility_id": { "example": "fcl_1G8QT5ZAB1S0XSDW", "examples": ["fcl_1G8QT5ZAB1S0XSDW", "fcl_1E384BDCGSBXNNZZ"], "maxLength": 37, "minLength": 20, "title": "Facility Id", "type": "string" }, "feedstock_type_ids": { "items": { "example": "ftt_1D7KZ1P761S0G7BN", "examples": ["ftt_1D7KZ1P761S0G7BN", "ftt_1CSRJN4HHSBXZ3TK"], "maxLength": 37, "minLength": 20, "type": "string" }, "title": "Feedstock Type Ids", "type": "array" }, "id": { "example": "ptb_1GAFJ4C051S06E0Z", "examples": ["ptb_1GAFJ4C051S06E0Z", "ptb_1FQVMJYTASBXSZT8"], "maxLength": 37, "minLength": 20, "title": "Id", "type": "string" }, "kind": { "$ref": "#/components/schemas/ProductionBatchKind" }, "mass": { "$ref": "#/components/schemas/ScalarQuantity" }, "started_at": { "format": "date-time", "title": "Started At", "type": "string" }, "supplier_reference_id": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Supplier Reference Id" }, "uploaded_at": { "format": "date-time", "title": "Uploaded At", "type": "string" } }, "required": [ "id", "facility_id", "feedstock_type_ids", "supplier_reference_id", "kind", "started_at", "ended_at", "uploaded_at", "display_name", "mass" ], "title": "ProductionBatch", "type": "object" }, "ProductionBatchKind": { "enum": ["biochar"], "title": "ProductionBatchKind", "type": "string" }, "Project": { "properties": { "country_code": { "title": "Country Code", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "id": { "example": "prj_1CTWZQGKE1S0VAXA", "examples": ["prj_1CTWZQGKE1S0VAXA", "prj_1E0QTWB22SBX34D1"], "maxLength": 37, "minLength": 20, "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "process_key": { "title": "Process Key", "type": "string" }, "risk_of_reversal": { "anyOf": [ { "$ref": "#/components/schemas/RiskOfReversal" }, { "type": "null" } ] }, "short_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Short Description" } }, "required": [ "id", "name", "country_code", "process_key", "description", "short_description", "risk_of_reversal" ], "title": "Project", "type": "object" }, "ProjectComponentAmortizationStrategy": { "description": "Strategies which control how Project Emissions are automatically amortized and attributed to GHG Statement and Removals\n\nESTIMATED_PROJECT_TONNAGE - Automatic amortization ensuring full amortization in proportion to the project's estimated gross removal.\n\nMANUAL - No automatic amortization. All GHG Statement and Removal attributions are performed manually.\n\nCUSTOM_TIME_PERIOD - Automatic amortization ensuring full amortization by a specified target date.\n\nESTIMATED_PROJECT_LIFETIME - Automatic amortization ensuring full amortization over the project's estimated lifetime.", "enum": [ "ESTIMATED_PROJECT_TONNAGE", "MANUAL", "CUSTOM_TIME_PERIOD", "ESTIMATED_PROJECT_LIFETIME" ], "title": "ProjectComponentAmortizationStrategy", "type": "string" }, "ProjectMonitoringRequirement": { "properties": { "display_name": { "title": "Display Name", "type": "string" }, "frequency": { "$ref": "#/components/schemas/Frequency" }, "id": { "anyOf": [ { "example": "pfx_1HQTSP3RX1S0Y2RG", "examples": ["pfx_1HQTSP3RX1S0Y2RG", "pfx_1FFWQZH4HSBX6F9N"], "maxLength": 37, "minLength": 20, "type": "string" }, { "example": "mnr_1DJJQY5C61S0R519", "examples": ["mnr_1DJJQY5C61S0R519", "mnr_1EKAZQMAZSBXDV59"], "maxLength": 37, "minLength": 20, "type": "string" } ], "title": "Id" }, "monitoring_phase": { "$ref": "#/components/schemas/MonitoringPhase" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes" }, "project_id": { "example": "prj_1CTWZQGKE1S0VAXA", "examples": ["prj_1CTWZQGKE1S0VAXA", "prj_1E0QTWB22SBX34D1"], "maxLength": 37, "minLength": 20, "title": "Project Id", "type": "string" }, "storage_location_id": { "anyOf": [ { "example": "slc_1F3PMGVC91S0SBK3", "examples": ["slc_1F3PMGVC91S0SBK3", "slc_1DCY5K78BSBX3XMZ"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "title": "Storage Location Id" }, "storage_unit_id": { "anyOf": [ { "example": "sgu_1E844FWM71S0E0TM", "examples": ["sgu_1E844FWM71S0E0TM", "sgu_1DTBHQEBGSBXBCZV"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "title": "Storage Unit Id" } }, "required": [ "id", "project_id", "storage_location_id", "storage_unit_id", "display_name", "monitoring_phase", "frequency", "notes" ], "title": "ProjectMonitoringRequirement", "type": "object" }, "QuantityKindQualifierType": { "enum": [ "base_saturation_ca_2plus", "base_saturation_k_plus", "base_saturation_mg_2plus", "base_saturation_na_plus", "base_saturation_major_cations", "max_limit", "min_limit", "flue_stack_emissions", "pyrolysis_reactor_emissions", "high_boiling_residue", "material_condition_dry", "material_condition_wet", "hydrogen_to_organic_carbon_ratio", "inertinite_fraction", "poorly_carbonized_fraction", "semi_inertinite_fraction", "mass_transferred", "aggregated_container_contents", "approximate_quantity_recovered", "ash_content", "loss_on_ignition", "nameplate_charge", "porosity", "volatile_matter", "radiation_normalization_method_gamma_activity_concentration_idx", "cation_exchange_capacity", "potential_acidity", "capacity", "gross_alpha", "gross_beta", "radiation_normalization_method_ec_rp112_standard_room_model", "anion_cl_1minus", "anion_no3_1minus", "anion_po4_3minus", "anion_so4_2minus", "cation_ca_2plus", "cation_k_1plus", "cation_mg_2plus", "cation_na_1plus", "heptacdd_1234678", "heptacdf_1234678", "heptacdf_1234789", "hexacdd_123478", "hexacdf_123478", "hexacdd_123678", "hexacdf_123678", "hexacdd_123789", "hexacdf_123789", "pentacdd_12378", "pentacdf_12378", "hexacdf_234678", "pentacdf_23478", "tetracdd_2378", "tetracdf_2378", "compound_ch4", "compound_co", "compound_co2", "compound_cao", "compound_h2", "compound_h2o", "compound_h2s", "compound_k2o", "compound_mgo", "compound_n2", "compound_n2o", "compound_na2o", "compound_o2", "compound_p2o5", "compound_so4", "acenaphthene", "acenaphthylene", "anthracene", "benz_a_anthracene", "benzo_a_pyrene", "benzo_b_fluoranthene", "benzo_e_pyrene", "benzo_ghi_perylene", "benzo_j_fluoranthene", "benzo_k_fluoranthene", "cfc_11", "cfc_111", "cfc_1112", "cfc_1112a", "cfc_112", "cfc_112a", "cfc_113", "cfc_113a", "cfc_114", "cfc_114a", "cfc_115", "cfc_12", "cfc_13", "cfc_211", "cfc_212", "cfc_213", "cfc_214", "cfc_215", "cfc_216", "cfc_217", "chrysene", "dibenz_ah_anthracene", "e_r316c", "fluoranthene", "fluorene", "hcfc_121", "hcfc_122", "hcfc_122a", "hcfc_123", "hcfc_123a", "hcfc_124", "hcfc_124a", "hcfc_131", "hcfc_132", "hcfc_132a", "hcfc_132c", "hcfc_133", "hcfc_133a", "hcfc_141", "hcfc_141b", "hcfc_142", "hcfc_142b", "hcfc_151", "hcfc_21", "hcfc_22", "hcfc_221", "hcfc_222", "hcfc_223", "hcfc_224", "hcfc_225", "hcfc_225ca", "hcfc_225cb", "hcfc_226", "hcfc_231", "hcfc_232", "hcfc_233", "hcfc_234", "hcfc_235", "hcfc_241", "hcfc_242", "hcfc_243", "hcfc_244", "hcfc_251", "hcfc_252", "hcfc_253", "hcfc_261", "hcfc_262", "hcfc_271", "hcfc_31", "hcfo_1233zd_e", "hcfo_1233zd_z", "hfc_125", "hfc_134", "hfc_134a", "hfc_143", "hfc_143a", "hfc_152", "hfc_152a", "hfc_161", "hfc_227ca", "hfc_227ea", "hfc_23", "hfc_236cb", "hfc_236ea", "hfc_236fa", "hfc_245ca", "hfc_245cb", "hfc_245ea", "hfc_245eb", "hfc_245fa", "hfc_263fb", "hfc_272ca", "hfc_32", "hfc_329p", "hfc_365mfc", "hfc_41", "hfc_43_10mee", "indeno_123_cd_pyrene", "naphthalene", "octacdd", "octacdf", "pcb_101", "pcb_105", "pcb_114", "pcb_118", "pcb_123", "pcb_126", "pcb_138", "pcb_153", "pcb_156", "pcb_157", "pcb_167", "pcb_169", "pcb_180", "pcb_189", "pcb_28", "pcb_52", "pcb_77", "pcb_81", "phenanthrene", "pyrene", "z_r316c", "cfc", "hcfc", "hfc", "i_teq_nato_ccms_lower_bound", "i_teq_nato_ccms_upper_bound", "total_16_epa_pah_excl_loq", "total_6_ndl_pcb_lower_bound", "total_6_ndl_pcb_upper_bound", "total_7_indicator_pcb_lower_bound", "total_7_indicator_pcb_upper_bound", "total_8_efsa_pah_excl_loq", "who_2005_pcb_teq_lower_bound", "who_2005_pcb_teq_upper_bound", "who_2005_pcdd_f_pcb_teq_lower_bound", "who_2005_pcdd_f_pcb_teq_upper_bound", "who_2005_pcdd_f_teq_lower_bound", "who_2005_pcdd_f_teq_upper_bound", "element_al", "element_as", "element_b", "element_ba", "element_ca", "element_cd", "element_ce", "element_co", "element_cr", "element_cs", "element_cu", "element_eu", "element_fe", "element_h", "element_hf", "element_hg", "element_k", "element_la", "element_lu", "element_mg", "element_mn", "element_mo", "element_n", "element_na", "element_nb", "element_nd", "element_ni", "element_o", "element_p", "element_pb", "element_rb", "element_s", "element_sb", "element_sc", "element_se", "element_si", "element_sn", "element_sr", "element_ta", "element_tb", "element_th", "element_ti", "element_tl", "element_u", "element_v", "element_w", "element_y", "element_yb", "element_zn", "element_zr", "alkalinity", "dissolved_inorganic_carbon", "dissolved_organic_carbon", "fixed_carbon", "particulate_inorganic_carbon", "particulate_organic_carbon", "soil_inorganic_carbon", "soil_organic_carbon", "soil_organic_matter", "total_carbon", "total_inorganic_carbon", "total_organic_carbon", "ghg_aggregate_co2e", "biochar", "crop_yield", "mineral_albite", "mineral_andesine", "mineral_augite", "mineral_diopside", "mineral_hematite", "mineral_labradorite", "mineral_maghemite", "mineral_montmorillonite", "mineral_orthoclase", "mineral_pigeonite", "mineral_quartz", "mineral_rutile", "mineral_category_asbestiform", "mineral_category_asbestos", "clay", "sand", "silt", "fullness_empty", "fullness_filled", "genus_abarema", "genus_acacia", "genus_albizia", "genus_amaioua", "genus_ambelania", "genus_anacardium", "genus_andira", "genus_aniba", "genus_annona", "genus_apeiba", "genus_aspidosperma", "genus_astrocaryum", "genus_attalea", "genus_bactris", "genus_banara", "genus_bauhinia", "genus_bellucia", "genus_bombax", "genus_bowdichia", "genus_brosimum", "genus_brunfelsia", "genus_buchenavia", "genus_byrsonima", "genus_caraipa", "genus_cariniana", "genus_caryocar", "genus_casearia", "genus_cassia", "genus_cecropia", "genus_cheiloclinium", "genus_clarisia", "genus_clitoria", "genus_clusia", "genus_coccoloba", "genus_combretum", "genus_commiphora", "genus_copaifera", "genus_cordia", "genus_couepia", "genus_couma", "genus_couratari", "genus_croton", "genus_cupania", "genus_cybianthus", "genus_dimorphandra", "genus_dinizia", "genus_diospyros", "genus_diplotropis", "genus_duguetia", "genus_duroia", "genus_emmotum", "genus_endopleura", "genus_erisma", "genus_erythroxylum", "genus_eschweilera", "genus_eugenia", "genus_euphorbia", "genus_faramea", "genus_ficus", "genus_garcinia", "genus_gardenia", "genus_genipa", "genus_goupia", "genus_guarea", "genus_guatteria", "genus_handroanthus", "genus_heisteria", "genus_himatanthus", "genus_hirtella", "genus_hymenaea", "genus_inga", "genus_iryanthera", "genus_isertia", "genus_jacaranda", "genus_lacmellea", "genus_lecythis", "genus_licania", "genus_licaria", "genus_lonchocarpus", "genus_luehea", "genus_mabea", "genus_machaerium", "genus_macoubea", "genus_macrolobium", "genus_manilkara", "genus_maprounea", "genus_maquira", "genus_margaritaria", "genus_matayba", "genus_miconia", "genus_micrandra", "genus_micropholis", "genus_mouriri", "genus_myrcia", "genus_myrciaria", "genus_naucleopsis", "genus_nectandra", "genus_neea", "genus_ocotea", "genus_ormosia", "genus_ouratea", "genus_pachira", "genus_pagamea", "genus_palicourea", "genus_parahancornia", "genus_parkia", "genus_perebea", "genus_philocosmos", "genus_piper", "genus_piptadenia", "genus_platonia", "genus_pourouma", "genus_pouteria", "genus_pradosia", "genus_protium", "genus_pseudobombax", "genus_pseudolmedia", "genus_pseudopiptadenia", "genus_psychotria", "genus_pterocarpus", "genus_rauvolfia", "genus_rhabdodendron", "genus_rinorea", "genus_rinoreocarpus", "genus_sacoglottis", "genus_salix", "genus_samanea", "genus_senegalia", "genus_senna", "genus_simaba", "genus_siparuna", "genus_sloanea", "genus_solanum", "genus_sorocea", "genus_sparattosperma", "genus_sterculia", "genus_stryphnodendron", "genus_swartzia", "genus_tabebuia", "genus_tabernaemontana", "genus_tachigali", "genus_talisia", "genus_tapirira", "genus_terminalia", "genus_ternstroemia", "genus_theobroma", "genus_toulicia", "genus_tovomita", "genus_trattinnickia", "genus_trichilia", "genus_triplaris", "genus_unonopsis", "genus_vatairea", "genus_vernonia", "genus_virola", "genus_vismia", "genus_vitex", "genus_vochysia", "genus_xylopia", "genus_zygia", "species_abarema_cochleata", "species_abuta_grandifolia", "species_acacia_mangium", "species_acacia_polyacantha", "species_acridocarpus_katangensis", "species_afzelia_quanzensis", "species_albizia_antunesiana", "species_albizia_versicolor", "species_alchornea_glandulosa", "species_alexa_grandiflora", "species_alibertia_edulis", "species_allantoma_lineata", "species_allophylus_africanus", "species_amaioua_guianensis", "species_ambelania_acida", "species_anacardium_giganteum", "species_anacardium_parvifolium", "species_anadenanthera_colubrina", "species_andira_inermis", "species_andira_surinamensis", "species_anisophyllea_boehmii", "species_annona_exsucca", "species_annona_glabra", "species_annona_senegalensis", "species_antidesma_venosum", "species_aparisthmium_cordatum", "species_apeiba_echinata", "species_apeiba_membranacea", "species_apeiba_petoumo", "species_apeiba_tibourbou", "species_apuleia_leiocarpa", "species_aspidosperma_album", "species_aspidosperma_nitidum", "species_aspidosperma_oblongum", "species_astrocaryum_aculeatum", "species_astronium_fraxinifolium", "species_astronium_graveolens", "species_astronium_lecointei", "species_attalea_maripa", "species_azanza_garckeana", "species_bactris_major", "species_bactris_maraja", "species_bagassa_guianensis", "species_balanites_aegyptiaca", "species_banara_guianensis", "species_bauhinia_longipedicellata", "species_bauhinia_petersiana", "species_bauhinia_ungulata", "species_bertholletia_excelsa", "species_bixa_arborea", "species_bixa_orellana", "species_bobgunnia_madagascariensis", "species_boscia_angustifolia", "species_bowdichia_nitida", "species_brachystegia_boehmii", "species_brachystegia_bussei", "species_brachystegia_gossweileri", "species_brachystegia_microphylla", "species_brachystegia_spiciformis", "species_brachystegia_stipulata", "species_brachystegia_taxifolia", "species_brachystegia_wangermeeana", "species_bridelia_cathartica", "species_bridelia_duvigneaudii", "species_brosimum_guianense", "species_brosimum_lactescens", "species_brosimum_rubescens", "species_buchenavia_tomentosa", "species_byrsonima_arthropoda", "species_byrsonima_coccolobifolia", "species_byrsonima_crassifolia", "species_byrsonima_crispa", "species_byrsonima_poeppigiana", "species_byrsonima_stipulacea", "species_calophyllum_brasiliense", "species_calycophyllum_spruceanum", "species_caraipa_densifolia", "species_caraipa_punctulata", "species_carapa_guianensis", "species_carapa_procera", "species_carica_papaya", "species_cariniana_micrantha", "species_carya_cordiformis", "species_caryocar_glabrum", "species_caryocar_villosum", "species_casearia_arborea", "species_casearia_decandra", "species_casearia_sylvestris", "species_cassia_fastuosa", "species_cassia_grandis", "species_cassia_leiandra", "species_cassia_lucens", "species_cassia_spruceana", "species_castanea_mollissima", "species_cecropia_distachya", "species_cecropia_obtusa", "species_cecropia_pachystachya", "species_cecropia_purpurascens", "species_cecropia_sciadophylla", "species_cedrela_fissilis", "species_cedrela_odorata", "species_ceiba_pentandra", "species_ceiba_samauma", "species_ceiba_speciosa", "species_cenostigma_tocantinum", "species_chloroleucon_tortum", "species_chrysophyllum_sparsiflorum", "species_clarisia_biflora", "species_clarisia_racemosa", "species_clitoria_fairchildiana", "species_clusia_grandiflora", "species_colubrina_glandulosa", "species_combretum_adenogonium", "species_combretum_collinum", "species_combretum_molle", "species_combretum_zeyheri", "species_commiphora_glandulosa", "species_connarus_perrottetii", "species_copaifera_langsdorffii", "species_copaifera_martii", "species_copaifera_reticulata", "species_cordia_alliodora", "species_cordia_nodosa", "species_cordia_superba", "species_couepia_bracteosa", "species_couepia_glabra", "species_couma_utilis", "species_couratari_guianensis", "species_couratari_macrosperma", "species_couratari_multiflora", "species_couroupita_guianensis", "species_couroupita_subsessilis", "species_coussapoa_latifolia", "species_coutarea_hexandra", "species_craterosiphon_quarrei", "species_croton_matourensis", "species_croton_urucurana", "species_cupania_latifolia", "species_cupania_scrobiculata", "species_dalbergia_boehmii", "species_dalbergia_nitidula", "species_dendrobangia_boliviana", "species_dendropanax_cuneatus", "species_dialium_guianense", "species_dichrostachys_cinerea", "species_didymopanax_morototoni", "species_dinizia_excelsa", "species_diospyros_bacotana", "species_diospyros_capreifolia", "species_diospyros_katangensis", "species_diospyros_mespiliformis", "species_diospyros_mweroensis", "species_diplorhynchus_condylocarpon", "species_dipteryx_alata", "species_dipteryx_odorata", "species_drypetes_variabilis", "species_ecclinusa_guianensis", "species_ecclinusa_ramiflora", "species_ekebergia_benguelensis", "species_emmotum_fagifolium", "species_enterolobium_contortisiliquum", "species_enterolobium_schomburgkii", "species_enterolobium_timbouva", "species_eriotheca_globosa", "species_erisma_bicolor", "species_erisma_calcaratum", "species_erisma_uncinatum", "species_erythrina_abyssinica", "species_erythrina_africana", "species_erythrina_falcata", "species_erythrophleum_africanum", "species_eschweilera_coriacea", "species_eschweilera_ovata", "species_eugenia_cupulata", "species_eugenia_flavescens", "species_eugenia_punicifolia", "species_euplassa_inaequalis", "species_euterpe_oleracea", "species_ficus_amazonica", "species_ficus_anthelmintica", "species_ficus_dekdekena", "species_ficus_insipida", "species_ficus_mathewsii", "species_ficus_maxima", "species_ficus_sansibarica", "species_ficus_stuhlmannii", "species_ficus_sur", "species_ficus_trigona", "species_fusaea_longifolia", "species_galipea_trifoliata", "species_garcinia_huillensis", "species_garcinia_macrophylla", "species_garcinia_pachyclada", "species_geissospermum_sericeum", "species_genipa_americana", "species_glycydendron_amazonicum", "species_goupia_glabra", "species_guapira_opposita", "species_guapira_venosa", "species_guarea_guidonia", "species_guarea_kunthiana", "species_guatteria_foliosa", "species_guatteria_punctata", "species_guatteria_schomburgkiana", "species_guatteria_sellowiana", "species_guazuma_ulmifolia", "species_gustavia_augusta", "species_handroanthus_impetiginosus", "species_handroanthus_ochraceus", "species_handroanthus_serratifolius", "species_haplocoelum_foliolosum", "species_helicostylis_tomentosa", "species_hevea_brasiliensis", "species_hexalobus_monopetalus", "species_himatanthus_articulatus", "species_hirtella_glandulosa", "species_homalolepis_cedron", "species_humiria_balsamifera", "species_hydrochorea_pedicellaris", "species_hymenaea_courbaril", "species_hymenaea_intermedia", "species_hymenaea_parvifolia", "species_hymenocardia_acida", "species_hymenolobium_petraeum", "species_hymenopus_heteromorphus", "species_inga_alba", "species_inga_cayennensis", "species_inga_disticha", "species_inga_edulis", "species_inga_heterophylla", "species_inga_lateriflora", "species_inga_laurina", "species_inga_marginata", "species_inga_paraensis", "species_inga_sessilis", "species_inga_stenoptera", "species_inga_thibaudiana", "species_inga_vera", "species_iryanthera_juruensis", "species_isoberlinia_angolensis", "species_jacaranda_copaia", "species_jacaratia_spinosa", "species_juglans_nigra", "species_julbernardia_globiflora", "species_julbernardia_paniculata", "species_kigelia_africana", "species_lacistema_pubescens", "species_lacmellea_gracilis", "species_laetia_procera", "species_lafoensia_pacari", "species_lannea_discolor", "species_lannea_versicolor", "species_lecythis_lurida", "species_lecythis_pisonis", "species_lecythis_zabucajo", "species_libidibia_ferrea", "species_licania_apetala", "species_licania_canescens", "species_licania_egleri", "species_licania_heteromorpha", "species_licania_octandra", "species_lindackeria_paludosa", "species_lophanthera_lactescens", "species_luehea_speciosa", "species_mabea_fistulifera", "species_mabea_nitida", "species_mabea_speciosa", "species_machaerium_acutifolium", "species_macrolobium_acaciifolium", "species_macrolobium_angustifolium", "species_maesopsis_eminii", "species_manilkara_bidentata", "species_maprounea_guianensis", "species_maquira_guianensis", "species_margaritaria_nobilis", "species_markhamia_obtusifolia", "species_matayba_arborescens", "species_matayba_guianensis", "species_mezilaurus_itauba", "species_miconia_cuspidata", "species_miconia_dispar", "species_miconia_ferruginata", "species_miconia_minutiflora", "species_micropholis_egensis", "species_minquartia_guianensis", "species_monotes_adenophyllus", "species_monotes_glandulosus", "species_monotes_katangensis", "species_monteverdia_guyanensis", "species_moquilea_minutiflora", "species_mouriri_acutiflora", "species_multidentia_crassa", "species_myrcia_cuprea", "species_myrcia_splendens", "species_myrcia_sylvatica", "species_myrsine_umbellata", "species_nectandra_cuspidata", "species_ochna_schweinfurthiana", "species_ochroma_pyramidale", "species_ocotea_glomerata", "species_ocotea_guianensis", "species_oenocarpus_bacaba", "species_oenocarpus_distichus", "species_olax_obtusifolia", "species_ormosia_coccinea", "species_ormosia_coutinhoi", "species_ormosia_nobilis", "species_ormosia_paraensis", "species_ouratea_castaneifolia", "species_ouratea_discophora", "species_ouratea_racemiformis", "species_pachira_aquatica", "species_palicourea_rigida", "species_panopsis_sessilifolia", "species_parahancornia_fasciculata", "species_parinari_curatellifolia", "species_parkia_gigantocarpa", "species_parkia_multijuga", "species_parkia_nitida", "species_parkia_pendula", "species_parkia_platycephala", "species_peltogyne_venosa", "species_peltophorum_dubium", "species_pericopsis_angolensis", "species_philocosmos_mwelerianus", "species_piliostigma_thonningii", "species_piptadenia_gonoacantha", "species_pithecolobium_tortum", "species_platymiscium_trinitatis", "species_platypodium_elegans", "species_poeppigia_procera", "species_populus_hybrid", "species_pourouma_guianensis", "species_pourouma_minor", "species_pourouma_mollis", "species_pouteria_caimito", "species_pouteria_cladantha", "species_pouteria_macrophylla", "species_pouteria_pachyphylla", "species_pouteria_reticulata", "species_pouteria_venosa", "species_protium_altissimum", "species_protium_hebetatum", "species_protium_heptaphyllum", "species_protium_robustum", "species_pseudobombax_munguba", "species_pseudolachnostylis_maprouneifolia", "species_pseudolmedia_macrophylla", "species_pseudopiptadenia_contorta", "species_psidium_guajava", "species_psorospermum_febrifugum", "species_pterocarpus_angolensis", "species_pterocarpus_rohrii", "species_pterocarpus_rotundifolius", "species_pterocarpus_santalinoides", "species_pterocarpus_tinctorius", "species_qualea_paraensis", "species_quercus_bicolor", "species_rauvolfia_paraensis", "species_rinoreocarpus_ulei", "species_robinia_pseudoacacia", "species_rothmannia_engleriana", "species_sacoglottis_guianensis", "species_samanea_tubulosa", "species_sapindus_saponaria", "species_sapium_glandulosum", "species_sapium_marmieri", "species_schizolobium_amazonicum", "species_schizolobium_parahyba", "species_sclerocarya_birrea", "species_securidaca_longipedunculata", "species_senegalia_polyphylla", "species_senna_alata", "species_senna_macrophylla", "species_senna_multijuga", "species_simaba_guianensis", "species_simarouba_amara", "species_socratea_exorrhiza", "species_sorocea_guilleminiana", "species_spondias_mombin", "species_sterculia_apetala", "species_sterculia_striata", "species_stryphnodendron_pulcherrimum", "species_swartzia_laurifolia", "species_swartzia_psilonema", "species_swietenia_macrophylla", "species_symmeria_paniculata", "species_symphonia_globulifera", "species_syzygium_cumini", "species_tabebuia_roseoalba", "species_tachigali_alba", "species_tachigali_aurea", "species_tachigali_glauca", "species_talisia_mollis", "species_talisia_veraluciana", "species_tapirira_guianensis", "species_terminalia_congesta", "species_terminalia_corrugata", "species_terminalia_grandis", "species_terminalia_lucida", "species_terminalia_tetraphylla", "species_theobroma_speciosum", "species_thyrsodium_spruceanum", "species_tovomita_fructipendula", "species_trattinnickia_burserifolia", "species_trattinnickia_rhoifolia", "species_trema_micrantha", "species_triplaris_americana", "species_triplaris_weigeltiana", "species_unknown", "species_vatairea_erythrocarpa", "species_vatairea_fusca", "species_vatairea_guianensis", "species_vatairea_macrocarpa", "species_virola_multinervia", "species_virola_sebifera", "species_virola_surinamensis", "species_vismia_guianensis", "species_xylopia_frutescens", "species_zanthoxylum_rhoifolium", "percentile_10", "percentile_50", "percentile_80", "percentile_90", "percentile_97" ], "title": "QuantityKindQualifierType", "type": "string" }, "QuantityKindType": { "enum": [ "acidity", "activity_concentration", "amount_of_substance", "amount_of_substance_concentration", "amount_of_substance_per_mass", "area", "area_carbon_emission_factor", "buffer_ph", "bulk_density", "count", "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", "time_emission_factor", "voltage", "volume", "volume_carbon_emission_factor", "volume_distance_carbon_emission_factor", "volume_flow_rate", "volume_fraction", "volume_per_area" ], "title": "QuantityKindType", "type": "string" }, "Removal": { "properties": { "co2e_net_removed_kg": { "description": "The CO\u2082e removed by this removal once uncertainty discounting has been applied", "title": "Co2E Net Removed Kg", "type": "number" }, "co2e_net_removed_standard_deviation_kg": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "The standard deviation of the CO\u2082e net removed and therefore the uncertainty discount applied to the removal", "title": "Co2E Net Removed Standard Deviation Kg" }, "co2e_net_removed_without_discount_kg": { "description": "The CO\u2082e removed by this removal before any uncertainty discounting has been applied", "title": "Co2E Net Removed Without Discount Kg", "type": "number" }, "completed_on": { "format": "date", "title": "Completed On", "type": "string" }, "feedstock_type_id": { "anyOf": [ { "example": "ftt_1D7KZ1P761S0G7BN", "examples": ["ftt_1D7KZ1P761S0G7BN", "ftt_1CSRJN4HHSBXZ3TK"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "description": "The feedstock type ID that this removal is associated with.", "title": "Feedstock Type Id" }, "ghg_statement_id": { "anyOf": [ { "example": "ggs_1GDQJ99Z51S0DYW9", "examples": ["ggs_1GDQJ99Z51S0DYW9", "ggs_1FWVEQRWSSBXK3NB"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "description": "The GHG statement ID that this removal is associated with. If null, the removal is in draft and has not been submitted for verification.", "title": "Ghg Statement Id" }, "id": { "example": "rmv_1EEM6NJXX1S0EXKD", "examples": ["rmv_1EEM6NJXX1S0EXKD", "rmv_1E3V4J2EWSBX5E82"], "maxLength": 37, "minLength": 20, "title": "Id", "type": "string" }, "started_on": { "format": "date", "title": "Started On", "type": "string" }, "supplier_reference_id": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Supplier Reference Id" } }, "required": [ "id", "supplier_reference_id", "started_on", "completed_on", "co2e_net_removed_kg", "co2e_net_removed_without_discount_kg", "co2e_net_removed_standard_deviation_kg", "ghg_statement_id", "feedstock_type_id" ], "title": "Removal", "type": "object" }, "RemovalTemplate": { "properties": { "display_name": { "title": "Display Name", "type": "string" }, "groups": { "items": { "$ref": "#/components/schemas/RemovalTemplateComponentGroup" }, "title": "Groups", "type": "array" }, "id": { "example": "rvt_1EVC8RZFE1S0BAT6", "examples": ["rvt_1EVC8RZFE1S0BAT6", "rvt_1ECDZGE2DSBX88EX"], "maxLength": 37, "minLength": 20, "title": "Id", "type": "string" }, "project_id": { "example": "prj_1CTWZQGKE1S0VAXA", "examples": ["prj_1CTWZQGKE1S0VAXA", "prj_1E0QTWB22SBX34D1"], "maxLength": 37, "minLength": 20, "title": "Project Id", "type": "string" }, "supplier_reference_id": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Supplier Reference Id" } }, "required": [ "id", "supplier_reference_id", "display_name", "project_id", "groups" ], "title": "RemovalTemplate", "type": "object" }, "RemovalTemplateComponent": { "properties": { "blueprint_key": { "title": "Blueprint Key", "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "display_name": { "title": "Display Name", "type": "string" }, "id": { "example": "rtc_1DAA58EDM1S0AMPN", "examples": ["rtc_1DAA58EDM1S0AMPN", "rtc_1CQAKRCVQSBXKKTM"], "maxLength": 37, "minLength": 20, "title": "Id", "type": "string" }, "inputs": { "description": "Inputs for this removal template component based on its component blueprint, including any customized display names and fixed input datapoints.", "items": { "$ref": "#/components/schemas/RemovalTemplateComponentInput" }, "title": "Inputs", "type": "array" }, "removal_template_component_group_id": { "example": "rtg_1EGQ9DZXZ1S05S28", "examples": ["rtg_1EGQ9DZXZ1S05S28", "rtg_1CWEFDQ7GSBX1X5C"], "maxLength": 37, "minLength": 20, "title": "Removal Template Component Group Id", "type": "string" }, "removal_template_id": { "example": "rvt_1EVC8RZFE1S0BAT6", "examples": ["rvt_1EVC8RZFE1S0BAT6", "rvt_1ECDZGE2DSBX88EX"], "maxLength": 37, "minLength": 20, "title": "Removal Template Id", "type": "string" } }, "required": [ "id", "display_name", "description", "blueprint_key", "removal_template_id", "removal_template_component_group_id", "inputs" ], "title": "RemovalTemplateComponent", "type": "object" }, "RemovalTemplateComponentGroup": { "properties": { "components": { "items": { "$ref": "#/components/schemas/RemovalTemplateComponent" }, "title": "Components", "type": "array" }, "description": { "title": "Description", "type": "string" }, "display_name": { "title": "Display Name", "type": "string" }, "id": { "example": "rtg_1EGQ9DZXZ1S05S28", "examples": ["rtg_1EGQ9DZXZ1S05S28", "rtg_1CWEFDQ7GSBX1X5C"], "maxLength": 37, "minLength": 20, "title": "Id", "type": "string" }, "key": { "title": "Key", "type": "string" } }, "required": ["id", "key", "display_name", "description", "components"], "title": "RemovalTemplateComponentGroup", "type": "object" }, "RemovalTemplateComponentInput": { "properties": { "datapoint_id": { "anyOf": [ { "example": "dtp_1DVKHKS101S0Q61Q", "examples": ["dtp_1DVKHKS101S0Q61Q", "dtp_1DJN8P57VSBXASFX"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "title": "Datapoint Id" }, "display_name": { "title": "Display Name", "type": "string" }, "input_key": { "description": "The key which identifies an specific input to the component blueprint.", "title": "Input Key", "type": "string" }, "quantity_kind": { "$ref": "#/components/schemas/QuantityKindType", "description": "The type of datapoint value that the input requires. Units compatible with this type can be found in the component blueprint library." }, "type": { "$ref": "#/components/schemas/ComponentInputType" } }, "required": [ "input_key", "datapoint_id", "display_name", "type", "quantity_kind" ], "title": "RemovalTemplateComponentInput", "type": "object" }, "RemovalTemplateComponentInputs": { "properties": { "inputs": { "description": "A list of values for component inputs. Inputs and their keys can be found on the removal template at the `GET /projects/{project_id}/removal_templates` endpoint.", "items": { "oneOf": [ { "$ref": "#/components/schemas/CreateComponentListInput" }, { "$ref": "#/components/schemas/CreateComponentScalarInput" } ] }, "title": "Inputs", "type": "array" }, "removal_template_component_id": { "description": "The ID of the removal template component to provide", "example": "rtc_1DAA58EDM1S0AMPN", "examples": ["rtc_1DAA58EDM1S0AMPN", "rtc_1CQAKRCVQSBXKKTM"], "maxLength": 37, "minLength": 20, "title": "Removal Template Component Id", "type": "string" } }, "required": ["removal_template_component_id", "inputs"], "title": "RemovalTemplateComponentInputs", "type": "object" }, "ResubmitGhgStatementRequest": { "properties": { "ghg_statement_report_url": { "description": "The URL of the GHG statement report. This should be accessible to the verifier.", "title": "Ghg Statement Report Url", "type": "string" }, "summary_of_changes": { "description": "A high-level summary of what's changed since the previous submission of this GHG statement.", "title": "Summary Of Changes", "type": "string" } }, "required": ["ghg_statement_report_url", "summary_of_changes"], "title": "ResubmitGhgStatementRequest", "type": "object" }, "RiskOfReversal": { "enum": [ "no_observable_risk", "very_low_v2", "very_low", "low", "medium", "high", "risk_assessment_driven" ], "title": "RiskOfReversal", "type": "string" }, "ScalarQuantity": { "properties": { "magnitude": { "title": "Magnitude", "type": "number" }, "standard_deviation": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Standard Deviation" }, "unit": { "minLength": 1, "title": "Unit", "type": "string" } }, "required": ["magnitude", "unit"], "title": "ScalarQuantity", "type": "object" }, "Sensor": { "properties": { "id": { "example": "sns_1GJ82BEMB1S0FBFV", "examples": ["sns_1GJ82BEMB1S0FBFV", "sns_1CCYZYWFWSBXYG38"], "maxLength": 37, "minLength": 20, "title": "Id", "type": "string" }, "manufacturer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Manufacturer" }, "measurement_property": { "$ref": "#/components/schemas/MeasurementProperty" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "project_id": { "title": "Project Id", "type": "string" }, "reference": { "title": "Reference", "type": "string" }, "units": { "title": "Units", "type": "string" } }, "required": [ "id", "project_id", "reference", "measurement_property", "units", "manufacturer", "model" ], "title": "Sensor", "type": "object" }, "SignedUploadUrlRequest": { "properties": { "content_length": { "description": "The size (in bytes) of the file that will be uploaded. The pre-signed URL will only accept a file of this size.", "maximum": 50000000.0, "title": "Content Length", "type": "integer" }, "content_type": { "description": "The content type of the file that will be uploaded. This must also be passed as a 'content-type' header during the upload. The pre-signed URL will only accept a file of this content-type.", "title": "Content Type", "type": "string" } }, "required": ["content_type", "content_length"], "title": "SignedUploadUrlRequest", "type": "object" }, "Source": { "properties": { "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "id": { "example": "src_1EBBF4M7X1S06G1Y", "examples": ["src_1EBBF4M7X1S06G1Y", "src_1DW1B17VNSBX37N0"], "maxLength": 37, "minLength": 20, "title": "Id", "type": "string" }, "is_public": { "description": "This field indicates Whether or not this source document will be public on the Registry once Credits are issued referencing it.", "title": "Is Public", "type": "boolean" }, "original_filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Original Filename" }, "project_id": { "anyOf": [ { "example": "prj_1CTWZQGKE1S0VAXA", "examples": ["prj_1CTWZQGKE1S0VAXA", "prj_1E0QTWB22SBX34D1"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "description": "The ID of the project that the source is associated with.", "title": "Project Id" }, "published_at": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Published At" }, "supplier_reference_id": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Supplier Reference Id" }, "type": { "$ref": "#/components/schemas/SourceType" }, "url_info": { "anyOf": [ { "discriminator": { "mapping": { "SourcePrivateUrlInfo": "#/components/schemas/SourcePrivateUrlInfo", "SourcePublicUrlInfo": "#/components/schemas/SourcePublicUrlInfo" }, "propertyName": "__typename" }, "oneOf": [ { "$ref": "#/components/schemas/SourcePublicUrlInfo" }, { "$ref": "#/components/schemas/SourcePrivateUrlInfo" } ] }, { "type": "null" } ], "description": "URL info for the source, that varies depending on if it is public or private", "title": "Url Info" } }, "required": [ "id", "supplier_reference_id", "display_name", "original_filename", "type", "published_at", "url_info", "is_public", "project_id" ], "title": "Source", "type": "object" }, "SourcePrivateUrlInfo": { "properties": { "__typename": { "const": "SourcePrivateUrlInfo", "default": "SourcePrivateUrlInfo", "description": "Contains the name of the model (formally, OpenAPI Schema Object). Used to determine the type of data, for example when two different types are unioned.", "title": "Type name", "type": "string" }, "is_accessible": { "description": "This field indicates whether or not a private source visible to the caller. If it is, to get a temporary pre-signed url that will allow the caller to view the source, make a request to the \"/sources/{id}/private_url\" endpoint.", "title": "Is Accessible", "type": "boolean" } }, "required": ["is_accessible"], "title": "SourcePrivateUrlInfo", "type": "object" }, "SourcePublicUrlInfo": { "properties": { "__typename": { "const": "SourcePublicUrlInfo", "default": "SourcePublicUrlInfo", "description": "Contains the name of the model (formally, OpenAPI Schema Object). Used to determine the type of data, for example when two different types are unioned.", "title": "Type name", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": ["url"], "title": "SourcePublicUrlInfo", "type": "object" }, "SourceType": { "enum": ["DOCUMENT", "WEBSITE"], "title": "SourceType", "type": "string" }, "StorageLocation": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the storage location", "title": "Description" }, "id": { "example": "slc_1F3PMGVC91S0SBK3", "examples": ["slc_1F3PMGVC91S0SBK3", "slc_1DCY5K78BSBX3XMZ"], "maxLength": 37, "minLength": 20, "title": "Id", "type": "string" }, "latitude": { "anyOf": [ { "maximum": 90.0, "minimum": -90.0, "type": "number" }, { "type": "null" } ], "description": "The latitude coordinate of the storage location", "title": "Latitude" }, "longitude": { "anyOf": [ { "maximum": 180.0, "minimum": -180.0, "type": "number" }, { "type": "null" } ], "description": "The longitude coordinate of the storage location", "title": "Longitude" }, "name": { "description": "The name of the storage location", "maxLength": 100, "title": "Name", "type": "string" }, "project_id": { "description": "The ID of the project this storage location belongs to", "example": "prj_1CTWZQGKE1S0VAXA", "examples": ["prj_1CTWZQGKE1S0VAXA", "prj_1E0QTWB22SBX34D1"], "maxLength": 37, "minLength": 20, "title": "Project Id", "type": "string" }, "storage_method": { "$ref": "#/components/schemas/StorageMethod", "description": "The method of storage by the storage location" }, "supplier_id": { "description": "The ID of the supplier this storage location belongs to", "example": "spl_1CC712KFS1S0YKPS", "examples": ["spl_1CC712KFS1S0YKPS", "spl_1FJBMMGR3SBXKDME"], "maxLength": 37, "minLength": 20, "title": "Supplier Id", "type": "string" }, "supplier_reference_id": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Optional supplier-specific reference ID for the storage location", "title": "Supplier Reference Id" } }, "required": [ "id", "name", "project_id", "supplier_id", "storage_method" ], "title": "StorageLocation", "type": "object" }, "StorageMethod": { "enum": [ "biochar_field", "biochar_landfill", "biomass_injection_well", "biomass_subsurface", "saline_aquifer", "in_situ_mineralization" ], "title": "StorageMethod", "type": "string" }, "StorageUnit": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Optional description of the storage unit", "title": "Description" }, "id": { "example": "sgu_1E844FWM71S0E0TM", "examples": ["sgu_1E844FWM71S0E0TM", "sgu_1DTBHQEBGSBXBCZV"], "maxLength": 37, "minLength": 20, "title": "Id", "type": "string" }, "latitude": { "anyOf": [ { "maximum": 90.0, "minimum": -90.0, "type": "number" }, { "type": "null" } ], "description": "The latitude coordinate of the storage unit", "title": "Latitude" }, "longitude": { "anyOf": [ { "maximum": 180.0, "minimum": -180.0, "type": "number" }, { "type": "null" } ], "description": "The longitude coordinate of the storage unit", "title": "Longitude" }, "name": { "description": "The name of the storage unit", "maxLength": 100, "title": "Name", "type": "string" }, "storage_location_id": { "description": "The ID of the storage location this storage unit belongs to", "example": "slc_1F3PMGVC91S0SBK3", "examples": ["slc_1F3PMGVC91S0SBK3", "slc_1DCY5K78BSBX3XMZ"], "maxLength": 37, "minLength": 20, "title": "Storage Location Id", "type": "string" }, "supplier_id": { "description": "The ID of the supplier this storage location belongs to", "example": "spl_1CC712KFS1S0YKPS", "examples": ["spl_1CC712KFS1S0YKPS", "spl_1FJBMMGR3SBXKDME"], "maxLength": 37, "minLength": 20, "title": "Supplier Id", "type": "string" }, "supplier_reference_id": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Optional supplier-specific reference ID for the storage location", "title": "Supplier Reference Id" } }, "required": ["id", "name", "storage_location_id", "supplier_id"], "title": "StorageUnit", "type": "object" }, "SubmitGhgStatementRequest": { "properties": { "ghg_statement_report_url": { "description": "The URL of the GHG statement report. This should be accessible to the verifier.", "title": "Ghg Statement Report Url", "type": "string" } }, "required": ["ghg_statement_report_url"], "title": "SubmitGhgStatementRequest", "type": "object" }, "Undefined": { "additionalProperties": false, "description": "An explicit representation of an undefined value in the Isometric REST API. Used, for example, to distinguish between explicit null inputs that clear a property, and not provided inputs which leave the property as is.", "properties": { "__typename": { "const": "Undefined", "default": "Undefined", "description": "Contains the name of the model (formally, OpenAPI Schema Object). Used to determine the type of data, for example when two different types are unioned.", "title": "Type name", "type": "string" } }, "title": "Undefined", "type": "object" }, "UpdateProjectComponentRemovalAttributionRequest": { "properties": { "attribution_factor": { "anyOf": [ { "exclusiveMinimum": 0.0, "maximum": 1.0, "type": "number" }, { "type": "null" } ], "description": "A scalar between 0 and 1 for the fraction of the CO2e flux of the project component that is to be attributed to this removal.", "title": "Attribution Factor" }, "attribution_factor_datapoint_id": { "anyOf": [ { "example": "dtp_1DVKHKS101S0Q61Q", "examples": ["dtp_1DVKHKS101S0Q61Q", "dtp_1DJN8P57VSBXASFX"], "maxLength": 37, "minLength": 20, "type": "string" }, { "type": "null" } ], "deprecated": true, "description": "Deprecated, please use `attribution_factor` instead.\n\nA scalar between 0 and 1 for the fraction of the CO2e flux of the project component that is to be attributed to this removal.", "title": "Attribution Factor Datapoint Id" }, "removal_id": { "description": "ID of Removal to attribute the project component to.", "example": "rmv_1EEM6NJXX1S0EXKD", "examples": ["rmv_1EEM6NJXX1S0EXKD", "rmv_1E3V4J2EWSBX5E82"], "maxLength": 37, "minLength": 20, "title": "Removal Id", "type": "string" } }, "required": ["removal_id"], "title": "UpdateProjectComponentRemovalAttributionRequest", "type": "object" }, "ValidationError": { "properties": { "ctx": { "title": "Context", "type": "object" }, "input": { "title": "Input" }, "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "title": "Location", "type": "array" }, "msg": { "title": "Message", "type": "string" }, "type": { "title": "Error Type", "type": "string" } }, "required": ["loc", "msg", "type"], "title": "ValidationError", "type": "object" } }, "securitySchemes": { "HTTPBearer": { "bearerFormat": "JWT", "description": "A JWT Bearer token header for authentication and authorization, in the format `Authorization: Bearer `", "scheme": "bearer", "type": "http" } } }, "info": { "description": "# Standards\n\n## Versioning\n\nThis API will be safely versioned using root path versioning, in the format `/v{major}`. For example, `/registry/v0/supplier`.\n\n### Compatibility\n\nWe won't make breaking changes to existing API services or endpoints for API versions higher than `v0`. If breaking changes are necessary, we'll release a new major version.\nWe may deprecate APIs that have been replaced by a newer version. When doing so, we will expect\nintegrated partners to manage a transition to new resources within the deprecation timeline of old ones.\n\nWe will make the following sort of changes we do not consider to be breaking:\n\n- Adding new endpoints\n- Adding optional query parameters to API endpoints\n- Adding new properties to existing API responses\n- Reordering properties in existing API responses\n\nIt is important that clients are built to be robust to these changes.\n\n## Pagination\n\nOur API is based on the [Relay](https://relay.dev/docs/tutorial/connections-pagination/) pagination spec. Paginated endpoints\nwill return a `PaginatedListResource` which contains:\n\n- `page_info` - Containing information regarding pagination cursors and the total number of entities.\n- `nodes` - Each node is a paginated entity.\n- `total_count` - The total size of the list across all pages.\n\n### Pagination Parameters\n\nPaginated endpoints also accepted a standard set of query parameters:\n\n- `last` - An integer number of items to retrieve **before** the item represented by the cursor passed in the `before` parameter. Defaults to 10 with a maximum value of 50.\n- `before` - An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page's `start_cursor` here when paginated backwards.\n- `first` - An integer number of items to retrieve **after** the item represented by the cursor passed in the `after` parameter. Defaults to 10 with a maximum value of 50.\n- `after` - An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page's `end_cursor` here when paginated forwards.\n\nFor example, querying `/registry/v0/beneficiaries` will return a `PaginatedListResource` of the first page of 10 items:\n\n```json\n{\n \"page_info\": {\n \"has_previous_page\": false,\n \"start_cursor\": ...,\n \"has_next_page\": true,\n \"end_cursor\": \"mpG5kcuoFBYtlH\",\n },\n \"nodes\": [{\n \"id\": \"org_12345iso678\",\n \"name\": \"My Org\",\n ...\n }],\n \"total_count\": 100\n}\n```\n\nThen querying `/registry/v0/beneficiaries?first=15&after=mpG5kcuoFBYtlH` will return a `PaginatedListResource` of the next 15 items.\n\n## Dates\n\nDatetime fields in the APIs conform to the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time format in UTC. For example: `2024-01-22T11:56:48.520641Z`.\n\n## Country Codes\n\nCountries are identified in the APIs via [ISO 3166-1 Alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) codes. For example: `GBR` and `USA`.\n# Authentication\n\nMost API requests will need to authenticate against the Isometric API in two ways simultaneously:\n\n- By passing a **client secret** in the `X-Client-Secret` header to identify the system integrating with the API.\n- By passing an **access token** in the `Authorization` header to authenticate as a specific organization, in order to gain access to its private data.\n\n### Client Authentication\n\nEvery API call to Isometric must include a **client secret** identifying the client application.\n\nThis client secret is tied to a particular environment - sandbox or production.\n\nThe client secret should be submitted on every API request via the `X-Client-Secret` header. For example `X-Client-Secret: uPrO...wxAh`.\n\n### Organization Authentication\n\nIn addition, a large number of API requests will require an **access token** in order for the caller to identify themselves and act as a specific Organization.\n\nTo authenticate as an Organization you will need to submit a JWT bearer access token via the `Authorization` header. For example: `Authorization: Bearer eyJh...sw5c`.\nIf you are going to be acting on behalf of other Organizations, they will need to generate the access token and pass it securely to you.\nAccess tokens should be treated as highly sensitive, kept secret and stored accordingly.\n\nAccess tokens are scoped to a single Organization - so if you are acting on behalf of multiple particular organizations, you will need to submit the appropriate access token on each request.\n\n### Managing Credentials\n\nCredentials can be managed through Certify UI in the [Team settings](https://registry.isometric.com/account/team-settings) section. Access tokens will expire after 1 year from generation. When you are approaching expiry, a new token will need to be generated.\n\nBoth client secrets and access tokens can be created and invalidated through UI.\nClient secrets do not expire and do not need to be rotated.\nIf either secret becomes compromised, it should be invalidated through the UI.\n# Key Certify Concepts\n\nThis page defines concepts used in Certify, and the [Certify API](/api-reference/certify/certify-introduction), which are helpful to understand when submitting information for verification via Certify. For a broader understanding of Isometric's verification processes on the Isometric Registry, please refer to the [Isometric Standard](https://isometric.com/standard).\n\n## Resource visibility\n\n- Until resources are submitted as part of a GHG statement, they are visible only to members of your organization.\n- After statement submission, they are visible to the verifier assigned to the GHG statement.\n- Once credits have been issued, removals are added to the [public registry](https://registry.isometric.com), and associated resources are visible publicly, with the exception of source documents.\n- Sources uploaded in the Certify platform are kept private by default once published on the Isometric registry (file names will be displayed). Contact Isometric to update public source visibility. Sources [added via the API](/api-reference/certify/post-source) can be set `public` on submission.\n\n## Resources\n\nThe main resources used in Certify are sources, datapoints, components and removals.\n\n### Sources\n\n- Sources represent a piece of evidence for a particular datapoint used in carbon accounting calculations.\n- Source documents are private, and only shared with the verifier assigned to a related removal.\n- Other information associated with a source, such as its display name, is visible publicly once the removal is on the public registry.\n- Verifiers are not notified when new sources are added to datapoints in a submitted removal, but they will immediately have access to the source documentation. Please notify the Isometric Registry Operations team when sources are added on a verifier's request so that we can ensure that the verifier is aware.\n\n### Datapoints\n\n- Datapoints represent any value used in carbon accounting calculations.\n- When creating datapoints, sources should be referenced to provide evidence for the value used.\n- A standard deviation should be provided if the datapoint is to be included in the variance propagation method of uncertainty analysis.\n- All datapoints are considered statistically independent for the purpose of variance propagation, although if a datapoint is used twice within a removal calculation, this dependence is captured.\n\n### Components\n\n- Components represent physical activities whose CO\u2082e flux needs to be accounted for.\n- Components are created from [component blueprints](/user-guides/certify/component-blueprint-library) that contain sets of equations used to calculate a transfer of CO\u2082e into or out of the atmosphere.\n- A blueprint defines a set of inputs that are the datapoints to be used in the calculation. For instance, a transport emissions blueprints would ask for datapoints representing a distance, mass and carbon intensity.\n- When creating a component from a blueprint, the blueprint must be specified, as well as a list of datapoints for the expected blueprint inputs. Learn more about components in [Identifying Components](/user-guides/certify/identifying-components).\n\n### Removals\n\n- Removals represent a series of activities that result in CO\u2082e being removed from the atmosphere.\n- The carbon accounting of a removal typically contains sequestrations, counterfactuals and activities (emissions).\n- Removals are structured using a template, [defined in your LCA](/user-guides/certify/lca).\n- Templates are divided into component groups. For instance, a biochar template may contain a `Feedstock sourcing` group.\n- Groups can contain multiple components.\n- Components can also be partially attributed to removals, if the activity the component represents contributed to multiple removals.\n- The final uncertainty discounting is done on the removal level - the API will return the CO\u2082e removed with and without discounting.\n- See the [Create a removal](/user-guides/certify/removal) guide for more details.\n\n### Feedstock types\n\n- Many carbon removal methods involve a feedstock, for instance biomass feedstock in BiCRS or silicate rock in enhanced weathering.\n- Feedstock types are used to describe the feedstock used in a removal.\n- When creating a removal, a feedstock type can be optionally specified so that Isometric and verifiers can see which removals use which feedstocks.\n- This is important if different feedstocks are used in a single GHG statement.\n- See the [Add feedstock](/user-guides/certify/add-feedstock) guide for more details.\n", "title": "Isometric Certify Data Ingestion API", "version": "v0" }, "openapi": "3.1.0", "paths": { "/biochar_applications": { "get": { "description": "Lists biochar applications in the Isometric system.", "operationId": "get_biochar_applications_biochar_applications_get", "parameters": [ { "in": "query", "name": "last", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "Last", "type": "integer" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page\u2019s start_cursor here when paginated backwards.", "title": "Before" } }, { "in": "query", "name": "first", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "First", "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page\u2019s end_cursor here when paginated forwards.", "title": "After" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_BiocharApplication_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Biochar Applications" }, "post": { "description": "Creates a biochar application in the Isometric system", "operationId": "post_biochar_application_biochar_applications_post", "parameters": [ { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBiocharApplicationRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BiocharApplication" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Post Biochar Application" } }, "/biochar_applications/{id}": { "delete": { "description": "Deletes a biochar application in the Isometric system", "operationId": "delete_biochar_application_biochar_applications__id__delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_BiocharSpreadEvent_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Delete Biochar Application" }, "get": { "description": "Get a single biochar application in the Isometric system", "operationId": "get_biochar_application_biochar_applications__id__get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_BiocharSpreadEvent_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BiocharApplication" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Biochar Application" } }, "/component_blueprints": { "get": { "description": "Lists component blueprints in the Isometric system", "operationId": "get_component_blueprints_component_blueprints_get", "parameters": [ { "in": "query", "name": "last", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "Last", "type": "integer" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page\u2019s start_cursor here when paginated backwards.", "title": "Before" } }, { "in": "query", "name": "first", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "First", "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page\u2019s end_cursor here when paginated forwards.", "title": "After" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_ComponentBlueprint_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Component Blueprints" } }, "/component_blueprints/{key}": { "get": { "operationId": "get_component_blueprint_component_blueprints__key__get", "parameters": [ { "in": "path", "name": "key", "required": true, "schema": { "title": "Key", "type": "string" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComponentBlueprint" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Component Blueprint" } }, "/components": { "get": { "description": "Lists components in the Isometric system", "operationId": "get_components_components_get", "parameters": [ { "in": "query", "name": "supplier_reference_id", "required": false, "schema": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Supplier Reference Id" } }, { "in": "query", "name": "scope", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComponentScope" }, { "type": "null" } ], "title": "Scope" } }, { "in": "query", "name": "ghg_statement_id", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/IsometricIDQueryParam_GhgStatement_" }, { "type": "null" } ], "title": "Ghg Statement Id" } }, { "in": "query", "name": "project_id", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/IsometricIDQueryParam_Project_" }, { "type": "null" } ], "title": "Project Id" } }, { "in": "query", "name": "removal_id", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/IsometricIDQueryParam_GhgEntry_" }, { "type": "null" } ], "title": "Removal Id" } }, { "in": "query", "name": "last", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "Last", "type": "integer" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page\u2019s start_cursor here when paginated backwards.", "title": "Before" } }, { "in": "query", "name": "first", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "First", "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page\u2019s end_cursor here when paginated forwards.", "title": "After" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_Component_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Components" }, "post": { "description": "Creates a component in the Isometric system", "operationId": "post_component_components_post", "parameters": [ { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateComponentRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Component" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Post Component" } }, "/components/{id}": { "delete": { "description": "Delete a component resource. Will fail if the component is in use by a verified removal.", "operationId": "delete_component_components__id__delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Component_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Delete Component" }, "get": { "description": "Get a single component in the Isometric system", "operationId": "get_component_components__id__get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Component_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Component" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Component" }, "patch": { "description": "Creates a component in the Isometric system. Associated removals will be recalculated, if they are not in an immutable state.", "operationId": "patch_component_components__id__patch", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Component_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchComponentRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Component" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Patch Component" } }, "/data-upload-submissions": { "get": { "description": "List data upload jobs with optional status filtering", "operationId": "get_data_upload_submissions_data_upload_submissions_get", "parameters": [ { "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/DataUploadSubmissionStatus" }, { "type": "null" } ], "title": "Status" } }, { "in": "query", "name": "last", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "Last", "type": "integer" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page\u2019s start_cursor here when paginated backwards.", "title": "Before" } }, { "in": "query", "name": "first", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "First", "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page\u2019s end_cursor here when paginated forwards.", "title": "After" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_DataUploadSubmission_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Data Upload Submissions" }, "post": { "operationId": "post_data_upload_submission_data_upload_submissions_post", "parameters": [ { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDataUploadSubmissionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataUploadSubmission" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Post Data Upload Submission" } }, "/data-upload-submissions/{id}": { "get": { "description": "Get a specific data upload job by ID", "operationId": "get_data_upload_submission_data_upload_submissions__id__get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_DataUploadSubmission_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataUploadSubmission" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Data Upload Submission" } }, "/datapoints": { "get": { "description": "Lists datapoints in the Isometric system", "operationId": "get_datapoints_datapoints_get", "parameters": [ { "in": "query", "name": "supplier_reference_id", "required": false, "schema": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Supplier Reference Id" } }, { "in": "query", "name": "display_name_contains", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name Contains" } }, { "in": "query", "name": "project_id", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/IsometricIDQueryParam_Project_" }, { "type": "null" } ], "title": "Project Id" } }, { "in": "query", "name": "quantity_kind", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/QuantityKindType" }, { "type": "null" } ], "title": "Quantity Kind" } }, { "in": "query", "name": "measurement_sample_id", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/IsometricIDQueryParam_MeasurementSample_" }, { "type": "null" } ], "title": "Measurement Sample Id" } }, { "in": "query", "name": "used_in_removal", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/IsometricIDQueryParam_GhgEntry_" }, { "type": "null" } ], "title": "Used In Removal" } }, { "in": "query", "name": "used_in_ghg_statement", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/IsometricIDQueryParam_GhgStatement_" }, { "type": "null" } ], "title": "Used In Ghg Statement" } }, { "in": "query", "name": "used_in_removal_template", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/IsometricIDQueryParam_GhgEntryTemplate_" }, { "type": "null" } ], "title": "Used In Removal Template" } }, { "in": "query", "name": "used_in_scope", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/ComponentScope" }, { "type": "null" } ], "title": "Used In Scope" } }, { "in": "query", "name": "last", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "Last", "type": "integer" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page\u2019s start_cursor here when paginated backwards.", "title": "Before" } }, { "in": "query", "name": "first", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "First", "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page\u2019s end_cursor here when paginated forwards.", "title": "After" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_Datapoint_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Datapoints" }, "post": { "description": "Creates a datapoint in the Isometric system", "operationId": "post_datapoint_datapoints_post", "parameters": [ { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDatapointRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Datapoint" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Post Datapoint" } }, "/datapoints/{id}": { "delete": { "description": "Delete a datapoint resource. Will fail if the datapoint is in use by a component.", "operationId": "delete_datapoint_datapoints__id__delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Datapoint_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Delete Datapoint" }, "get": { "description": "Returns a single datapoint in the Isometric system", "operationId": "get_datapoint_datapoints__id__get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Datapoint_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Datapoint" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Datapoint" }, "patch": { "description": "Updates a datapoint in the Isometric system. Associated components and removals will be recalculated, if they are not in an immutable state.", "operationId": "patch_datapoint_datapoints__id__patch", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Datapoint_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchDatapointRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Datapoint" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Patch Datapoint" } }, "/datapoints/{id}/components": { "get": { "description": "Lists components associated with a datapoint in the Isometric system", "operationId": "get_datapoint_components_datapoints__id__components_get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Datapoint_" } }, { "in": "query", "name": "last", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "Last", "type": "integer" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page\u2019s start_cursor here when paginated backwards.", "title": "Before" } }, { "in": "query", "name": "first", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "First", "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page\u2019s end_cursor here when paginated forwards.", "title": "After" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_Component_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Datapoint Components" } }, "/datapoints/{id}/removal_template_components": { "get": { "description": "Lists removal template components that use this datapoint", "operationId": "get_datapoint_removal_template_components_datapoints__id__removal_template_components_get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Datapoint_" } }, { "in": "query", "name": "last", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "Last", "type": "integer" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page\u2019s start_cursor here when paginated backwards.", "title": "Before" } }, { "in": "query", "name": "first", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "First", "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page\u2019s end_cursor here when paginated forwards.", "title": "After" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_RemovalTemplateComponent_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Datapoint Removal Template Components" } }, "/feedstock_batches": { "post": { "description": "Creates a feedstock batch in the Isometric system", "operationId": "post_feedstock_batch_feedstock_batches_post", "parameters": [ { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFeedstockBatchRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedstockBatch" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Post Feedstock Batch" } }, "/feedstock_batches/{id}": { "delete": { "description": "Deletes a feedstock batch in the Isometric system.", "operationId": "delete_feedstock_batch_feedstock_batches__id__delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_FeedstockBatch_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Delete Feedstock Batch" }, "get": { "description": "Get a single feedstock batch in the Isometric system.", "operationId": "get_feedstock_batch_feedstock_batches__id__get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_FeedstockBatch_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedstockBatch" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Feedstock Batch" } }, "/feedstock_types": { "get": { "description": "Lists feedstock types in the Isometric system. Feedstock types can only be created via the Certify UI.", "operationId": "get_feedstock_types_feedstock_types_get", "parameters": [ { "in": "query", "name": "supplier_reference_id", "required": false, "schema": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Supplier Reference Id" } }, { "in": "query", "name": "last", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "Last", "type": "integer" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page\u2019s start_cursor here when paginated backwards.", "title": "Before" } }, { "in": "query", "name": "first", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "First", "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page\u2019s end_cursor here when paginated forwards.", "title": "After" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_FeedstockType_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Feedstock Types" } }, "/feedstock_types/{feedstock_type_id}/feedstock_batches": { "get": { "description": "Lists feedstock batches in the Isometric system.", "operationId": "get_feedstock_batches_feedstock_types__feedstock_type_id__feedstock_batches_get", "parameters": [ { "in": "path", "name": "feedstock_type_id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_FeedstockType_" } }, { "in": "query", "name": "last", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "Last", "type": "integer" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page\u2019s start_cursor here when paginated backwards.", "title": "Before" } }, { "in": "query", "name": "first", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "First", "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page\u2019s end_cursor here when paginated forwards.", "title": "After" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_FeedstockBatch_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Feedstock Batches" } }, "/feedstock_types/{id}": { "delete": { "description": "Deletes a feedstock type in the Isometric system. Feedstock types can only be created via the Certify UI.", "operationId": "delete_feedstock_type_feedstock_types__id__delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_FeedstockType_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Delete Feedstock Type" }, "get": { "description": "Get a single feedstock type in the Isometric system. Feedstock types can only be created via the Certify UI.", "operationId": "get_feedstock_type_feedstock_types__id__get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_FeedstockType_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedstockType" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Feedstock Type" }, "patch": { "description": "Updates a feedstock type in the Isometric system. Feedstock types can only be created via the Certify UI.", "operationId": "patch_feedstock_type_feedstock_types__id__patch", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_FeedstockType_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchFeedstockType" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedstockType" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Patch Feedstock Type" } }, "/file-uploads": { "post": { "operationId": "post_file_upload_file_uploads_post", "parameters": [ { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFileUploadRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileUpload" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Post File Upload" } }, "/ghg_statement_components": { "post": { "description": "Creates a component that will be automatically and evenly attributed to all removals with the GHG Statement.", "operationId": "post_ghg_statement_component_ghg_statement_components_post", "parameters": [ { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGhgStatementComponentRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Component" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Post Ghg Statement Component" } }, "/ghg_statements": { "get": { "description": "Lists GHG statements in the Isometric system", "operationId": "get_ghg_statements_ghg_statements_get", "parameters": [ { "in": "query", "name": "last", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "Last", "type": "integer" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page\u2019s start_cursor here when paginated backwards.", "title": "Before" } }, { "in": "query", "name": "first", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "First", "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page\u2019s end_cursor here when paginated forwards.", "title": "After" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_GhgStatement_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Ghg Statements" }, "post": { "description": "Submits a series of removals for verification", "operationId": "post_ghg_statement_ghg_statements_post", "parameters": [ { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGhgStatementRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GhgStatement" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Post Ghg Statement" } }, "/ghg_statements/{id}": { "get": { "description": "Get a single GHG statement", "operationId": "get_ghg_statement_ghg_statements__id__get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_GhgStatement_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GhgStatement" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Ghg Statement" } }, "/ghg_statements/{id}/submit": { "post": { "operationId": "post_ghg_statement_submit_ghg_statements__id__submit_post", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_GhgStatement_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SubmitGhgStatementRequest" }, { "$ref": "#/components/schemas/ResubmitGhgStatementRequest" } ], "title": "Ghg Statement Request" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GhgStatement" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Post Ghg Statement Submit" } }, "/measurement_locations": { "get": { "description": "Lists measurement locations in the Isometric system", "operationId": "get_measurement_locations_measurement_locations_get", "parameters": [ { "in": "query", "name": "supplier_reference_id", "required": false, "schema": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Supplier Reference Id" } }, { "in": "query", "name": "last", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "Last", "type": "integer" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page\u2019s start_cursor here when paginated backwards.", "title": "Before" } }, { "in": "query", "name": "first", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "First", "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page\u2019s end_cursor here when paginated forwards.", "title": "After" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_MeasurementLocation_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Measurement Locations" }, "post": { "operationId": "post_measurement_locations_measurement_locations_post", "parameters": [ { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMeasurementLocationRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementLocation" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Post Measurement Locations" } }, "/measurement_locations/{id}": { "delete": { "description": "Deletes a measurement location in the Isometric system", "operationId": "delete_measurement_location_measurement_locations__id__delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_MeasurementLocation_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Delete Measurement Location" }, "get": { "description": "Get a single measurement location in the Isometric system", "operationId": "get_measurement_location_measurement_locations__id__get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_MeasurementLocation_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementLocation" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Measurement Location" } }, "/measurement_samples": { "get": { "operationId": "get_measurement_samples_measurement_samples_get", "parameters": [ { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_MeasurementSample_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Measurement Samples" }, "post": { "operationId": "post_measurement_samples_measurement_samples_post", "parameters": [ { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMeasurementSampleRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MeasurementSample" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Post Measurement Samples" } }, "/organisation": { "get": { "description": "Gets the organisation associated with the client", "operationId": "get_current_organisation_organisation_get", "parameters": [ { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organisation" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Current Organisation" } }, "/processes": { "get": { "deprecated": true, "description": "**Deprecated**. Please use `GET /projects/{project_id}/removal_templates` instead.\n\nLists processes in the Isometric system", "operationId": "get_processes_processes_get", "parameters": [ { "in": "query", "name": "last", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "Last", "type": "integer" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page\u2019s start_cursor here when paginated backwards.", "title": "Before" } }, { "in": "query", "name": "first", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "First", "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page\u2019s end_cursor here when paginated forwards.", "title": "After" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_Process_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Processes" } }, "/production_batches": { "get": { "description": "Lists production batches in the Isometric system.", "operationId": "get_production_batches_production_batches_get", "parameters": [ { "in": "query", "name": "last", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "Last", "type": "integer" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page\u2019s start_cursor here when paginated backwards.", "title": "Before" } }, { "in": "query", "name": "first", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "First", "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page\u2019s end_cursor here when paginated forwards.", "title": "After" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_ProductionBatch_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Production Batches" }, "post": { "description": "Creates a production batch in the Isometric system", "operationId": "post_production_batch_production_batches_post", "parameters": [ { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProductionBatchRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductionBatch" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Post Production Batch" } }, "/production_batches/{id}": { "delete": { "description": "Deletes a production batch in the Isometric system", "operationId": "delete_production_batch_production_batches__id__delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_ProductionBatch_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Delete Production Batch" }, "get": { "description": "Get a single production batch in the Isometric system", "operationId": "get_production_batch_production_batches__id__get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_ProductionBatch_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductionBatch" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Production Batch" } }, "/project_components": { "post": { "description": "Creates a component that will be automatically attributed to GHG statements in the project based on the provided allocation strategy.", "operationId": "post_project_component_project_components_post", "parameters": [ { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectComponentRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Component" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Post Project Component" } }, "/project_components/{component_id}/removal_attributions/{removal_id}": { "delete": { "description": "Removes all attribution of a project component to a removal.", "operationId": "delete_project_component_removal_attribution_project_components__component_id__removal_attributions__removal_id__delete", "parameters": [ { "in": "path", "name": "component_id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Component_" } }, { "in": "path", "name": "removal_id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_GhgEntry_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Delete Project Component Removal Attribution" } }, "/project_components/{id}/removal_attributions": { "post": { "description": "Manually attributes or removes attribution of a project component to a removal.", "operationId": "post_project_component_removal_attribution_project_components__id__removal_attributions_post", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Component_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProjectComponentRemovalAttributionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Removal" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Post Project Component Removal Attribution" } }, "/projects": { "get": { "description": "Lists projects in the Isometric system", "operationId": "get_projects_projects_get", "parameters": [ { "in": "query", "name": "last", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "Last", "type": "integer" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page\u2019s start_cursor here when paginated backwards.", "title": "Before" } }, { "in": "query", "name": "first", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "First", "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page\u2019s end_cursor here when paginated forwards.", "title": "After" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_Project_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Projects" } }, "/projects/{id}/monitoring_requirements": { "get": { "description": "Lists all monitoring requirements for a project.", "operationId": "get_project_monitoring_requirements_projects__id__monitoring_requirements_get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Project_" } }, { "in": "query", "name": "storage_location_id", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/IsometricIDQueryParam_StorageLocation_" }, { "type": "null" } ], "title": "Storage Location Id" } }, { "in": "query", "name": "storage_unit_id", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/IsometricIDQueryParam_StorageUnit_" }, { "type": "null" } ], "title": "Storage Unit Id" } }, { "in": "query", "name": "last", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "Last", "type": "integer" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page\u2019s start_cursor here when paginated backwards.", "title": "Before" } }, { "in": "query", "name": "first", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "First", "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page\u2019s end_cursor here when paginated forwards.", "title": "After" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_ProjectMonitoringRequirement_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Project Monitoring Requirements" } }, "/projects/{project_id}/monitoring_requirements/{id}/submissions": { "get": { "description": "Lists all monitoring submissions for a project monitoring requirement", "operationId": "get_monitoring_submissions_projects__project_id__monitoring_requirements__id__submissions_get", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Project_" } }, { "in": "path", "name": "id", "required": true, "schema": { "anyOf": [ { "$ref": "#/components/schemas/IsometricIDPathParam_MonitoringRequirement_" }, { "$ref": "#/components/schemas/IsometricIDPathParam_ProjectRequirement_" } ], "title": "Id" } }, { "in": "query", "name": "last", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "Last", "type": "integer" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page\u2019s start_cursor here when paginated backwards.", "title": "Before" } }, { "in": "query", "name": "first", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "First", "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page\u2019s end_cursor here when paginated forwards.", "title": "After" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_MonitoringSubmission_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Monitoring Submissions" }, "post": { "description": "Creates a monitoring submission for a project monitoring requirement.\n\nThe submission is associated with a previously uploaded source document (see [Post Source](/mrv/post-source)).\nOne source may be used to create multiple submissions.", "operationId": "post_monitoring_submission_projects__project_id__monitoring_requirements__id__submissions_post", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Project_" } }, { "in": "path", "name": "id", "required": true, "schema": { "anyOf": [ { "$ref": "#/components/schemas/IsometricIDPathParam_MonitoringRequirement_" }, { "$ref": "#/components/schemas/IsometricIDPathParam_ProjectRequirement_" } ], "title": "Id" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMonitoringSubmissionRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitoringSubmission" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Post Monitoring Submission" } }, "/projects/{project_id}/monitoring_requirements/{monitoring_requirement_id}/submissions/{id}": { "delete": { "description": "Deletes a monitoring submission for a project monitoring requirement", "operationId": "delete_monitoring_submission_projects__project_id__monitoring_requirements__monitoring_requirement_id__submissions__id__delete", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Project_" } }, { "in": "path", "name": "monitoring_requirement_id", "required": true, "schema": { "anyOf": [ { "$ref": "#/components/schemas/IsometricIDPathParam_MonitoringRequirement_" }, { "$ref": "#/components/schemas/IsometricIDPathParam_ProjectRequirement_" } ], "title": "Monitoring Requirement Id" } }, { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_MonitoringSubmission_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Delete Monitoring Submission" } }, "/projects/{project_id}/monitoring_requirements/{requirement_id}": { "get": { "description": "Get a specific monitoring requirement within a project.", "operationId": "get_project_monitoring_requirement_projects__project_id__monitoring_requirements__requirement_id__get", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Project_" } }, { "in": "path", "name": "requirement_id", "required": true, "schema": { "anyOf": [ { "$ref": "#/components/schemas/IsometricIDPathParam_MonitoringRequirement_" }, { "$ref": "#/components/schemas/IsometricIDPathParam_ProjectRequirement_" } ], "title": "Requirement Id" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectMonitoringRequirement" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Project Monitoring Requirement" } }, "/projects/{project_id}/removal_templates": { "get": { "description": "Lists all removal templates within the given project", "operationId": "get_removal_templates_projects__project_id__removal_templates_get", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Project_" } }, { "in": "query", "name": "last", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "Last", "type": "integer" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page\u2019s start_cursor here when paginated backwards.", "title": "Before" } }, { "in": "query", "name": "first", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "First", "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page\u2019s end_cursor here when paginated forwards.", "title": "After" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_RemovalTemplate_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Removal Templates" } }, "/projects/{project_id}/removal_templates/{id}": { "get": { "description": "Gets a single removal template within the given project", "operationId": "get_removal_template_projects__project_id__removal_templates__id__get", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Project_" } }, { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_GhgEntryTemplate_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemovalTemplate" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Removal Template" } }, "/projects/{project_id}/storage_locations": { "get": { "description": "Gets storage locations for a project.", "operationId": "get_storage_locations_projects__project_id__storage_locations_get", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Project_" } }, { "in": "query", "name": "last", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "Last", "type": "integer" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page\u2019s start_cursor here when paginated backwards.", "title": "Before" } }, { "in": "query", "name": "first", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "First", "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page\u2019s end_cursor here when paginated forwards.", "title": "After" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_StorageLocation_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Storage Locations" }, "post": { "description": "Creates a storage location for a project in the Isometric system.", "operationId": "post_storage_location_projects__project_id__storage_locations_post", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Project_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateStorageLocationRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StorageLocation" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Post Storage Location" } }, "/projects/{project_id}/storage_locations/{id}": { "delete": { "description": "Deletes a storage location for a project", "operationId": "delete_storage_location_projects__project_id__storage_locations__id__delete", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Project_" } }, { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_StorageLocation_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Delete Storage Location" }, "get": { "description": "Gets storage location for a project.", "operationId": "get_storage_location_projects__project_id__storage_locations__id__get", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Project_" } }, { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_StorageLocation_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StorageLocation" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Storage Location" }, "patch": { "description": "Patches storage location in the Isometric system.", "operationId": "patch_storage_location_projects__project_id__storage_locations__id__patch", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Project_" } }, { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_StorageLocation_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchStorageLocationRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StorageLocation" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Patch Storage Location" } }, "/projects/{project_id}/storage_locations/{id}/monitoring_requirements": { "get": { "description": "Lists all monitoring requirements for a project storage location.", "operationId": "get_project_storage_location_monitoring_requirements_projects__project_id__storage_locations__id__monitoring_requirements_get", "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Project_" } }, { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_StorageLocation_" } }, { "in": "query", "name": "last", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "Last", "type": "integer" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page\u2019s start_cursor here when paginated backwards.", "title": "Before" } }, { "in": "query", "name": "first", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "First", "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page\u2019s end_cursor here when paginated forwards.", "title": "After" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_ProjectMonitoringRequirement_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Project Storage Location Monitoring Requirements" } }, "/removals": { "get": { "operationId": "get_removals_removals_get", "parameters": [ { "in": "query", "name": "supplier_reference_id", "required": false, "schema": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Supplier Reference Id" } }, { "in": "query", "name": "last", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "Last", "type": "integer" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page\u2019s start_cursor here when paginated backwards.", "title": "Before" } }, { "in": "query", "name": "first", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "First", "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page\u2019s end_cursor here when paginated forwards.", "title": "After" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_Removal_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Removals" }, "post": { "operationId": "post_removal_removals_post", "parameters": [ { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRemovalRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Removal" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Post Removal" } }, "/removals/{id}": { "delete": { "description": "This endpoint deletes a removal - this is irreversible and the removal cannot be recovered.\n\nIt will return an error if the removal is not in DRAFT status.", "operationId": "delete_removal_removals__id__delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_GhgEntry_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Delete Removal" }, "get": { "operationId": "get_removal_removals__id__get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_GhgEntry_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Removal" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Removal" }, "patch": { "description": "Updates a removal in the Isometric system. The removal will be recalculated, if it is are not in an immutable state.", "operationId": "patch_removal_removals__id__patch", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_GhgEntry_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchRemovalRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Removal" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Patch Removal" } }, "/removals/{id}/component_attributions": { "get": { "operationId": "get_removal_components_removals__id__component_attributions_get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_GhgEntry_" } }, { "in": "query", "name": "last", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "Last", "type": "integer" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page\u2019s start_cursor here when paginated backwards.", "title": "Before" } }, { "in": "query", "name": "first", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "First", "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page\u2019s end_cursor here when paginated forwards.", "title": "After" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_ComponentAttribution_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Removal Components" }, "patch": { "description": "Change component attributions for the removal.", "operationId": "patch_removal_components_removals__id__component_attributions_patch", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_GhgEntry_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchRemovalComponentAttributionsRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Removal" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Patch Removal Components" } }, "/sensors": { "get": { "description": "Gets all sensors.", "operationId": "get_sensors_sensors_get", "parameters": [ { "in": "query", "name": "project_id", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/IsometricIDQueryParam_Project_" }, { "type": "null" } ], "title": "Project Id" } }, { "in": "query", "name": "reference", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reference" } }, { "in": "query", "name": "last", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "Last", "type": "integer" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page\u2019s start_cursor here when paginated backwards.", "title": "Before" } }, { "in": "query", "name": "first", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "First", "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page\u2019s end_cursor here when paginated forwards.", "title": "After" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_Sensor_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Sensors" }, "post": { "description": "Creates a sensor in the Isometric system.", "operationId": "post_sensors_sensors_post", "parameters": [ { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSensorRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sensor" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Post Sensors" } }, "/sensors/{id}": { "get": { "description": "Gets sensor by ID.", "operationId": "get_sensor_sensors__id__get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Sensor_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sensor" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Sensor" } }, "/sources": { "get": { "description": "Lists sources in the Isometric system", "operationId": "get_sources_sources_get", "parameters": [ { "in": "query", "name": "supplier_reference_id", "required": false, "schema": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Supplier Reference Id" } }, { "in": "query", "name": "project_id", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/IsometricIDQueryParam_Project_" }, { "type": "null" } ], "title": "Project Id" } }, { "in": "query", "name": "last", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "Last", "type": "integer" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page\u2019s start_cursor here when paginated backwards.", "title": "Before" } }, { "in": "query", "name": "first", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "First", "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page\u2019s end_cursor here when paginated forwards.", "title": "After" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_Source_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Sources" }, "post": { "description": "Creates a source in the Isometric system. The client is provided with a presigned\nupload URL which must be used to upload the document associated with this source.\nSource documents are private, but other fields will be visible publicly once\ncredits are issued for an associated removal, moving it to the public registry.", "operationId": "post_source_sources_post", "parameters": [ { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDocumentSourceRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSourceResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Post Source" } }, "/sources/{id}": { "delete": { "description": "Deletes a source in the Isometric system. This is irreversible and the source cannot be recovered.", "operationId": "delete_source_sources__id__delete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Source_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Delete Source" }, "get": { "description": "Get single source", "operationId": "get_source_sources__id__get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Source_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Source" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Source" }, "patch": { "description": "Patches metadata associated with a source in the Isometric system.", "operationId": "patch_source_sources__id__patch", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Source_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchSourceRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Source" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Patch Source" } }, "/sources/{id}/private_url": { "get": { "description": "Returns a short-lived signed URL to download a source document from. This query will fail if\nthe source does not have a private URL or if the authenticated user does not have\naccess to it. That's why you need to first check the `urlInfo` field on the source\nobject, to ensure that you can safely use this query.", "operationId": "get_source_private_url_sources__id__private_url_get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Source_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Get Source Private Url Sources Id Private Url Get", "type": "string" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Source Private Url" } }, "/sources/{id}/signed_upload_url": { "post": { "description": "Recreates a presigned upload URL, which must be used to upload the documentation\nassociated with this source. If the document is already uploaded, this endpoint will\nresponse with a 409 error.", "operationId": "post_signed_upload_url_sources__id__signed_upload_url_post", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_Source_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignedUploadUrlRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "title": "Response Post Signed Upload Url Sources Id Signed Upload Url Post", "type": "string" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Post Signed Upload Url" } }, "/storage_units": { "get": { "description": "Gets all storage units.", "operationId": "get_storage_units_storage_units_get", "parameters": [ { "in": "query", "name": "storage_location_id", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/IsometricIDQueryParam_StorageLocation_" }, { "type": "null" } ], "title": "Storage Location Id" } }, { "in": "query", "name": "supplier_reference_id", "required": false, "schema": { "anyOf": [ { "description": "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.", "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Supplier Reference Id" } }, { "in": "query", "name": "last", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve before the item represented by the cursor passed in the before parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "Last", "type": "integer" } }, { "in": "query", "name": "before", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the first item in the previously requested page to select items ordered before it. Submit the previously requested page\u2019s start_cursor here when paginated backwards.", "title": "Before" } }, { "in": "query", "name": "first", "required": false, "schema": { "default": 10, "description": "An integer number of items to retrieve after the item represented by the cursor passed in the after parameter. Defaults to 10 with a maximum value of 50.", "exclusiveMinimum": 0, "maximum": 50, "title": "First", "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An opaque cursor representing the last item in the previously requested page to select items ordered after it. Submit the previously requested page\u2019s end_cursor here when paginated forwards.", "title": "After" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedListResource_StorageUnit_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Storage Units" }, "post": { "description": "Creates a storage unit in the Isometric system.", "operationId": "post_storage_unit_storage_units_post", "parameters": [ { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateStorageUnitRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StorageUnit" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Post Storage Unit" } }, "/storage_units/{id}": { "get": { "description": "Gets storage unit by ID.", "operationId": "get_storage_unit_storage_units__id__get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/IsometricIDPathParam_StorageUnit_" } }, { "description": "A secret token identifying the client connecting to the API", "in": "header", "name": "x-client-secret", "required": true, "schema": { "description": "A secret token identifying the client connecting to the API", "examples": ["Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP"], "title": "Client secret", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StorageUnit" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Storage Unit" } } }, "servers": [ { "description": "Sandbox Isometric MRV API", "url": "https://api.sandbox.isometric.com/mrv/v0" }, { "description": "Production Isometric MRV API", "url": "https://api.isometric.com/mrv/v0" } ] }