openapi: 3.1.0 info: title: Isometric Certify Data Ingestion Beneficiaries Removals API 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₂e 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₂e 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₂e 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₂e 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" version: v0 servers: - url: /mrv/v0 - url: https://api.sandbox.isometric.com/mrv/v0 description: Sandbox Isometric MRV API - url: https://api.isometric.com/mrv/v0 description: Production Isometric MRV API tags: - name: Removals paths: /removals/{id}: patch: summary: Patch Removal 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 security: - HTTPBearer: [] parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/IsometricIDPathParam_GhgEntry_' - name: x-client-secret in: header required: true schema: type: string title: Client secret description: A secret token identifying the client connecting to the API examples: - Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP description: A secret token identifying the client connecting to the API requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PatchRemovalRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Removal' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' tags: - Removals get: summary: Get Removal operationId: get_removal_removals__id__get security: - HTTPBearer: [] parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/IsometricIDPathParam_GhgEntry_' - name: x-client-secret in: header required: true schema: type: string title: Client secret description: A secret token identifying the client connecting to the API examples: - Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP description: A secret token identifying the client connecting to the API responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Removal' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' tags: - Removals delete: summary: Delete Removal description: 'This endpoint deletes a removal - this is irreversible and the removal cannot be recovered. It will return an error if the removal is not in DRAFT status.' operationId: delete_removal_removals__id__delete security: - HTTPBearer: [] parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/IsometricIDPathParam_GhgEntry_' - name: x-client-secret in: header required: true schema: type: string title: Client secret description: A secret token identifying the client connecting to the API examples: - Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP description: A secret token identifying the client connecting to the API responses: '204': description: Successful Response '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' tags: - Removals /removals: get: summary: Get Removals operationId: get_removals_removals_get security: - HTTPBearer: [] parameters: - name: supplier_reference_id in: query required: false schema: anyOf: - type: string minLength: 1 maxLength: 100 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. - type: 'null' title: Supplier Reference Id - name: last in: query required: false schema: type: integer maximum: 50 exclusiveMinimum: 0 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. default: 10 title: Last - name: before in: query required: false schema: anyOf: - type: string minLength: 1 - 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’s start_cursor here when paginated backwards. title: Before - name: first in: query required: false schema: type: integer maximum: 50 exclusiveMinimum: 0 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. default: 10 title: First - name: after in: query required: false schema: anyOf: - type: string minLength: 1 - 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’s end_cursor here when paginated forwards. title: After - name: x-client-secret in: header required: true schema: type: string title: Client secret description: A secret token identifying the client connecting to the API examples: - Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP description: A secret token identifying the client connecting to the API responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PaginatedListResource_Removal_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' tags: - Removals post: summary: Post Removal operationId: post_removal_removals_post security: - HTTPBearer: [] parameters: - name: x-client-secret in: header required: true schema: type: string title: Client secret description: A secret token identifying the client connecting to the API examples: - Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP description: A secret token identifying the client connecting to the API requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateRemovalRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Removal' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' tags: - Removals /removals/{id}/component_attributions: get: summary: Get Removal Components operationId: get_removal_components_removals__id__component_attributions_get security: - HTTPBearer: [] parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/IsometricIDPathParam_GhgEntry_' - name: last in: query required: false schema: type: integer maximum: 50 exclusiveMinimum: 0 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. default: 10 title: Last - name: before in: query required: false schema: anyOf: - type: string minLength: 1 - 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’s start_cursor here when paginated backwards. title: Before - name: first in: query required: false schema: type: integer maximum: 50 exclusiveMinimum: 0 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. default: 10 title: First - name: after in: query required: false schema: anyOf: - type: string minLength: 1 - 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’s end_cursor here when paginated forwards. title: After - name: x-client-secret in: header required: true schema: type: string title: Client secret description: A secret token identifying the client connecting to the API examples: - Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP description: A secret token identifying the client connecting to the API responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PaginatedListResource_ComponentAttribution_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' tags: - Removals patch: summary: Patch Removal Components description: Change component attributions for the removal. operationId: patch_removal_components_removals__id__component_attributions_patch security: - HTTPBearer: [] parameters: - name: id in: path required: true schema: $ref: '#/components/schemas/IsometricIDPathParam_GhgEntry_' - name: x-client-secret in: header required: true schema: type: string title: Client secret description: A secret token identifying the client connecting to the API examples: - Syou3EZiO5vuMEgNyBeA8cjEMYOnQDwP description: A secret token identifying the client connecting to the API requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PatchRemovalComponentAttributionsRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Removal' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' tags: - Removals components: schemas: ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError CreateRemovalRequest: properties: supplier_reference_id: type: string maxLength: 100 minLength: 1 title: 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. started_on: type: string format: date title: Started On description: The date at which activities related to this removal started. completed_on: type: string format: date title: Completed On description: The date by which activities related to this removal finished. steps: anyOf: - items: $ref: '#/components/schemas/CreateRemovalStep' type: array - type: 'null' title: Steps description: 'Deprecated, please use the `removal_template_components` field instead. A 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.' deprecated: true process_key: anyOf: - type: string - type: 'null' title: Process Key description: 'Deprecated, please use the `removal_template_id` field instead. The key of the process to be used. See the processes endpoint for the processes available.' deprecated: true project_id: type: string maxLength: 37 minLength: 20 title: Project Id description: The ID of the project to associate this removal to. examples: - prj_1CTWZQGKE1S0VAXA - prj_1E0QTWB22SBX34D1 example: prj_1CTWZQGKE1S0VAXA feedstock_type_id: anyOf: - type: string maxLength: 37 minLength: 20 examples: - ftt_1D7KZ1P761S0G7BN - ftt_1CSRJN4HHSBXZ3TK example: ftt_1D7KZ1P761S0G7BN - type: 'null' title: Feedstock Type Id description: The ID of the feedstock type that will be used for this removal. removal_template_id: anyOf: - type: string maxLength: 37 minLength: 20 examples: - rvt_1EVC8RZFE1S0BAT6 - rvt_1ECDZGE2DSBX88EX example: rvt_1EVC8RZFE1S0BAT6 - type: 'null' title: Removal Template Id description: 'This field will become required once the deprecated `process_key` field is removed. ID of the removal template to instantiate the removal from.' removal_template_components: items: $ref: '#/components/schemas/RemovalTemplateComponentInputs' type: array title: Removal Template Components description: '' type: object required: - supplier_reference_id - started_on - completed_on - project_id title: CreateRemovalRequest description: Input to the POST /removals endpoint that creates a single removal IsometricIDRequestParam_GhgEntry_: type: string maxLength: 37 minLength: 20 examples: - rmv_1EEM6NJXX1S0EXKD - rmv_1E3V4J2EWSBX5E82 example: rmv_1EEM6NJXX1S0EXKD ComponentToAttribute: properties: component_id: type: string maxLength: 37 minLength: 20 title: Component Id description: ID of the component to add to the removal. examples: - cmp_1EP2SB7MZ1S036PY - cmp_1EHK4R6QJSBXFC5N example: cmp_1EP2SB7MZ1S036PY component_group_key: type: string title: Component Group Key description: 'Key of a component group that this component should be applied to in the removal. The 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 attribution_factor: type: number maximum: 1.0 exclusiveMinimum: 0.0 title: Attribution Factor 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. default: 1.0 type: object required: - component_id - component_group_key title: ComponentToAttribute Undefined: properties: __typename: type: string const: Undefined title: Type name 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. default: Undefined additionalProperties: false type: object title: Undefined 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. PatchRemovalComponentAttributionsRequest: properties: components_to_add: anyOf: - items: $ref: '#/components/schemas/ComponentToAttribute' type: array - $ref: '#/components/schemas/Undefined' title: Components To Add description: Components to be attributed to Removal. default: __typename: Undefined components_to_remove: anyOf: - items: type: string maxLength: 37 minLength: 20 examples: - cmp_1EP2SB7MZ1S036PY - cmp_1EHK4R6QJSBXFC5N example: cmp_1EP2SB7MZ1S036PY type: array - $ref: '#/components/schemas/Undefined' title: Components To Remove description: Components to be fully removed from Removal. default: __typename: Undefined type: object title: PatchRemovalComponentAttributionsRequest CreateRemovalComponentLink: properties: component_id: type: string maxLength: 37 minLength: 20 title: Component Id description: Isometric ID of the component to include within this removal step examples: - cmp_1EP2SB7MZ1S036PY - cmp_1EHK4R6QJSBXFC5N example: cmp_1EP2SB7MZ1S036PY attribution_factor_datapoint_id: anyOf: - type: string maxLength: 37 minLength: 20 examples: - dtp_1DVKHKS101S0Q61Q - dtp_1DJN8P57VSBXASFX example: dtp_1DVKHKS101S0Q61Q - type: 'null' title: Attribution Factor Datapoint Id 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. type: object required: - component_id title: CreateRemovalComponentLink PaginatedListResource_Removal_: properties: nodes: items: $ref: '#/components/schemas/Removal' type: array title: Nodes total_count: type: integer title: Total Count page_info: $ref: '#/components/schemas/PageInfo' type: object required: - nodes - total_count - page_info title: PaginatedListResource[Removal] IsometricIDPathParam_GhgEntry_: $ref: '#/components/schemas/IsometricIDRequestParam_GhgEntry_' CreateRemovalStep: properties: process_step_key: type: string title: Process Step Key description: The key of the process step that this model corresponds to components: items: $ref: '#/components/schemas/CreateRemovalComponentLink' type: array title: Components description: List of components that represent emissions, counterfactuals or sequestrations type: object required: - process_step_key - components title: CreateRemovalStep description: Nested type for the POST /removals endpoint to create a step within a removal PageInfo: properties: has_previous_page: type: boolean title: Has Previous Page start_cursor: anyOf: - type: string - type: 'null' title: Start Cursor has_next_page: type: boolean title: Has Next Page end_cursor: anyOf: - type: string - type: 'null' title: End Cursor type: object required: - has_previous_page - start_cursor - has_next_page - end_cursor title: PageInfo ComponentAttribution: properties: id: type: string maxLength: 37 minLength: 20 title: Id examples: - rvc_1EADHFQHM1S0TVMN - rvc_1EB9G4FR7SBX795D example: rvc_1EADHFQHM1S0TVMN removal_id: type: string maxLength: 37 minLength: 20 title: Removal Id examples: - rmv_1EEM6NJXX1S0EXKD - rmv_1E3V4J2EWSBX5E82 example: rmv_1EEM6NJXX1S0EXKD component_id: type: string maxLength: 37 minLength: 20 title: Component Id examples: - cmp_1EP2SB7MZ1S036PY - cmp_1EHK4R6QJSBXFC5N example: cmp_1EP2SB7MZ1S036PY component_group_key: type: string title: Component Group Key removal_template_component_id: anyOf: - type: string maxLength: 37 minLength: 20 examples: - rtc_1DAA58EDM1S0AMPN - rtc_1CQAKRCVQSBXKKTM example: rtc_1DAA58EDM1S0AMPN - type: 'null' title: Removal Template Component Id 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. attribution_factor: type: number maximum: 1.0 exclusiveMinimum: 0.0 title: Attribution Factor examples: - 1.0 - 0.654 type: object required: - id - removal_id - component_id - component_group_key - removal_template_component_id - attribution_factor title: ComponentAttribution PaginatedListResource_ComponentAttribution_: properties: nodes: items: $ref: '#/components/schemas/ComponentAttribution' type: array title: Nodes total_count: type: integer title: Total Count page_info: $ref: '#/components/schemas/PageInfo' type: object required: - nodes - total_count - page_info title: PaginatedListResource[ComponentAttribution] RemovalTemplateComponentInputs: properties: removal_template_component_id: type: string maxLength: 37 minLength: 20 title: Removal Template Component Id description: The ID of the removal template component to provide examples: - rtc_1DAA58EDM1S0AMPN - rtc_1CQAKRCVQSBXKKTM example: rtc_1DAA58EDM1S0AMPN inputs: items: oneOf: - $ref: '#/components/schemas/CreateComponentListInput' - $ref: '#/components/schemas/CreateComponentScalarInput' type: array title: 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. type: object required: - removal_template_component_id - inputs title: RemovalTemplateComponentInputs HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError PatchRemovalRequest: properties: delete_component_ids: anyOf: - items: type: string maxLength: 37 minLength: 20 examples: - cmp_1EP2SB7MZ1S036PY - cmp_1EHK4R6QJSBXFC5N example: cmp_1EP2SB7MZ1S036PY type: array - $ref: '#/components/schemas/Undefined' title: Delete Component Ids description: 'Deprecated, please use `PATCH /removal/{id}/component_attributions` instead. IDs for components to delete from the removal.' default: __typename: Undefined deprecated: true add_components: anyOf: - items: $ref: '#/components/schemas/AddComponentToRemoval' type: array - $ref: '#/components/schemas/Undefined' title: Add Components description: 'Deprecated, please use `PATCH /removal/{id}/component_attributions` instead. Components to be attributed to the removal.' default: __typename: Undefined deprecated: true feedstock_type_id: anyOf: - type: string maxLength: 37 minLength: 20 examples: - ftt_1D7KZ1P761S0G7BN - ftt_1CSRJN4HHSBXZ3TK example: ftt_1D7KZ1P761S0G7BN - $ref: '#/components/schemas/Undefined' title: Feedstock Type Id description: ID of the feedstock type for the removal. default: __typename: Undefined started_on: anyOf: - type: string format: date description: Date in ISO format (YYYY-MM-DD) - type: 'null' title: Started On description: The date at which activities related to this removal started. completed_on: anyOf: - type: string format: date description: Date in ISO format (YYYY-MM-DD) - type: 'null' title: Completed On description: The date by which activities related to this removal finished. type: object title: PatchRemovalRequest AddComponentToRemoval: properties: component_id: type: string maxLength: 37 minLength: 20 title: Component Id description: ID for component to add to Removal. examples: - cmp_1EP2SB7MZ1S036PY - cmp_1EHK4R6QJSBXFC5N example: cmp_1EP2SB7MZ1S036PY process_step_key: anyOf: - type: string maxLength: 100 - type: 'null' title: Process Step Key description: 'Deprecated, please use removal_template_group_id instead. Process step key matching the module the component should be added to.' deprecated: true removal_template_group_id: anyOf: - type: string maxLength: 37 minLength: 20 examples: - rtg_1EGQ9DZXZ1S05S28 - rtg_1CWEFDQ7GSBX1X5C example: rtg_1EGQ9DZXZ1S05S28 - type: 'null' title: Removal Template Group Id description: Which group the component should be added to, based on the removal's template structure. attribution_factor_datapoint_id: anyOf: - type: string maxLength: 37 minLength: 20 examples: - dtp_1DVKHKS101S0Q61Q - dtp_1DJN8P57VSBXASFX example: dtp_1DVKHKS101S0Q61Q - type: 'null' title: Attribution Factor Datapoint Id 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. type: object required: - component_id - attribution_factor_datapoint_id title: AddComponentToRemoval CreateComponentListInput: properties: __typename: type: string const: CreateComponentListInput title: Type name 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. default: CreateComponentListInput input_key: type: string maxLength: 100 title: Input Key description: Must match an input key in the component blueprint. datapoint_ids: items: type: string maxLength: 37 minLength: 20 examples: - dtp_1DVKHKS101S0Q61Q - dtp_1DJN8P57VSBXASFX example: dtp_1DVKHKS101S0Q61Q type: array title: Datapoint Ids description: The Isometric IDs of the datapoints that will be used to populate the value of this input type: object required: - input_key - datapoint_ids title: CreateComponentListInput Removal: properties: id: type: string maxLength: 37 minLength: 20 title: Id examples: - rmv_1EEM6NJXX1S0EXKD - rmv_1E3V4J2EWSBX5E82 example: rmv_1EEM6NJXX1S0EXKD supplier_reference_id: anyOf: - type: string maxLength: 100 minLength: 1 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. - type: 'null' title: Supplier Reference Id started_on: type: string format: date title: Started On completed_on: type: string format: date title: Completed On co2e_net_removed_kg: type: number title: Co2E Net Removed Kg description: The CO₂e removed by this removal once uncertainty discounting has been applied co2e_net_removed_without_discount_kg: type: number title: Co2E Net Removed Without Discount Kg description: The CO₂e removed by this removal before any uncertainty discounting has been applied co2e_net_removed_standard_deviation_kg: anyOf: - type: number - type: 'null' title: Co2E Net Removed Standard Deviation Kg description: The standard deviation of the CO₂e net removed and therefore the uncertainty discount applied to the removal ghg_statement_id: anyOf: - type: string maxLength: 37 minLength: 20 examples: - ggs_1GDQJ99Z51S0DYW9 - ggs_1FWVEQRWSSBXK3NB example: ggs_1GDQJ99Z51S0DYW9 - type: 'null' title: Ghg Statement Id 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. feedstock_type_id: anyOf: - type: string maxLength: 37 minLength: 20 examples: - ftt_1D7KZ1P761S0G7BN - ftt_1CSRJN4HHSBXZ3TK example: ftt_1D7KZ1P761S0G7BN - type: 'null' title: Feedstock Type Id description: The feedstock type ID that this removal is associated with. type: object 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 CreateComponentScalarInput: properties: __typename: type: string const: CreateComponentScalarInput title: Type name 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. default: CreateComponentScalarInput input_key: type: string maxLength: 100 title: Input Key description: Must match an input key in the component blueprint. datapoint_id: type: string maxLength: 37 minLength: 20 title: Datapoint Id description: The Isometric ID of the datapoint that will be used to populate the value of this input examples: - dtp_1DVKHKS101S0Q61Q - dtp_1DJN8P57VSBXASFX example: dtp_1DVKHKS101S0Q61Q type: object required: - input_key - datapoint_id title: CreateComponentScalarInput securitySchemes: HTTPBearer: type: http description: 'A JWT Bearer token header for authentication and authorization, in the format `Authorization: Bearer `' scheme: bearer bearerFormat: JWT