{"openapi":"3.1.0","info":{"title":"OGCR Domain API","version":"1.0.0","description":"The OGCR API"},"servers":[{"url":"https://dcr.ogcr.tesobe.com/crcf/ogcr/v1","description":"OGCR Domain API"}],"paths":{"/certification-on-chain/{certificationonchainid}":{"get":{"tags":["_Certification_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get certification_on_chain by id","description":"<p>Get certification_on_chain by id.</p>\n<p>Cache of CertificationNFT data minted on the OGCR chain (chain id 20253). One record per certificate_of_compliance_id (a re-certification is a new certificate and a new record), populated by OGCR-chain-cache reading the chain.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_hash: activity_hash stored on-chain: keccak256 of the raw activity entity body.</li>\n<li>activity_id: activity_id of the certified activity as stored on-chain.</li>\n<li>activity_name: Activity name as stored on-chain.</li>\n<li>activity_nft_id: ActivityNFT token id this certification references (stored on-chain).</li>\n<li>activity_uri: activity_uri stored on-chain: link back to the OBP activity entity.</li>\n<li>audit_report_hash: audit_report_hash stored on-chain: keccak256 of the raw audit_report entity body.</li>\n<li>audit_report_uri: audit_report_uri stored on-chain: link back to the OBP audit_report entity.</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: carbon_farming_net_soil_emission_reduction_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>carbon_farming_temporary_net_carbon_removal_benefit: carbon_farming_temporary_net_carbon_removal_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>carbon_removals_under_baseline: carbon_removals_under_baseline as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: carbon_storage_temporary_net_carbon_removal_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>certificate_of_compliance_hash: certificate_of_compliance_hash stored on-chain: keccak256 of the raw certificate_of_compliance entity body.</li>\n<li>certificate_of_compliance_id: Links to the <code>certificate_of_compliance</code> dynamic entity. The on-chain CertificationNFT is keyed by this id.</li>\n<li>certificate_of_compliance_uri: certificate_of_compliance_uri stored on-chain: link back to the OBP certificate_of_compliance entity.</li>\n<li>certification_body_hash: certification_body_hash stored on-chain: keccak256 of the raw certification_body entity body.</li>\n<li>certification_body_name: Certification body name as stored on-chain.</li>\n<li>certification_body_uri: certification_body_uri stored on-chain: link back to the OBP certification_body entity.</li>\n<li>certification_scheme_hash: certification_scheme_hash stored on-chain: keccak256 of the raw certification_scheme entity body.</li>\n<li>certification_scheme_name: Certification scheme name as stored on-chain.</li>\n<li>certification_scheme_uri: certification_scheme_uri stored on-chain: link back to the OBP certification_scheme entity.</li>\n<li>certification_status: Certification status as stored on-chain.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: CertificationNFT contract address the token was read from.</li>\n<li>country_id: Country id as stored on-chain.</li>\n<li>expiry_date: Certification expiry date as stored on-chain.</li>\n<li>issue_date: Certification issue date as stored on-chain.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>permanent_net_carbon_removal_benefit: permanent_net_carbon_removal_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>soil_emissions_under_baseline: soil_emissions_under_baseline as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>token_id: CertificationNFT token id minted for this certificate.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>tx_hash: Mint transaction hash (from the CertificationMinted event).</li>\n<li>unit_types: Unit types of the certificate as stored on-chain.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglecertification_on_chain_ogcr","parameters":[{"name":"certificationonchainid","in":"path","description":"The CERTIFICATIONONCHAINID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_on_chain":{"type":"object","properties":{"certification_on_chain_id":{"type":"string"},"activity_uri":{"type":"string"},"carbon_removals_under_baseline":{"type":"string"},"audit_report_hash":{"type":"string"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"string"},"certification_scheme_uri":{"type":"string"},"block_number":{"type":"integer"},"certification_body_name":{"type":"string"},"certification_body_uri":{"type":"string"},"token_uri":{"type":"string"},"certificate_of_compliance_hash":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"string"},"activity_nft_id":{"type":"integer"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"certificate_of_compliance_uri":{"type":"string"},"audit_report_uri":{"type":"string"},"certification_scheme_hash":{"type":"string"},"token_id":{"type":"integer"},"activity_name":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"string"},"unit_types":{"type":"string"},"activity_hash":{"type":"string"},"contract_address":{"type":"string"},"certification_status":{"type":"string"},"certification_scheme_name":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"string"},"permanent_net_carbon_removal_benefit":{"type":"string"},"country_id":{"type":"string"},"certification_body_hash":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certification_on_chain":{"certification_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_name":"Reforestation 2024","activity_nft_id":1,"activity_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/activity/activity_AB12CD34EF","audit_report_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","audit_report_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/audit_report/audit_report_01","block_number":12345,"carbon_farming_net_soil_emission_reduction_benefit":"10.5","carbon_farming_temporary_net_carbon_removal_benefit":"10.5","carbon_removals_under_baseline":"10.5","carbon_storage_temporary_net_carbon_removal_benefit":"10.5","certificate_of_compliance_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certificate_of_compliance_id":"coc_AB12CD34EF","certificate_of_compliance_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certificate_of_compliance/coc_AB12CD34EF","certification_body_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_body_name":"Example Certification Body","certification_body_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certification_body/body_VERRA","certification_scheme_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_scheme_name":"Example Certification Scheme","certification_scheme_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certification_scheme/scheme_SALUS","certification_status":"certified","chain_id":20253,"contract_address":"0x2e335F247E91caa168c64b63104C4475b2af3942","country_id":"DK","expiry_date":"2029-06-01","issue_date":"2024-06-01","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","permanent_net_carbon_removal_benefit":"10.5","soil_emissions_under_baseline":"10.5","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQ2VydCJ9","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_types":"Permanent Removal"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Certification_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update certification_on_chain","description":"<p>Update certification_on_chain.</p>\n<p>Cache of CertificationNFT data minted on the OGCR chain (chain id 20253). One record per certificate_of_compliance_id (a re-certification is a new certificate and a new record), populated by OGCR-chain-cache reading the chain.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_hash: activity_hash stored on-chain: keccak256 of the raw activity entity body.</li>\n<li>activity_id: activity_id of the certified activity as stored on-chain.</li>\n<li>activity_name: Activity name as stored on-chain.</li>\n<li>activity_nft_id: ActivityNFT token id this certification references (stored on-chain).</li>\n<li>activity_uri: activity_uri stored on-chain: link back to the OBP activity entity.</li>\n<li>audit_report_hash: audit_report_hash stored on-chain: keccak256 of the raw audit_report entity body.</li>\n<li>audit_report_uri: audit_report_uri stored on-chain: link back to the OBP audit_report entity.</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: carbon_farming_net_soil_emission_reduction_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>carbon_farming_temporary_net_carbon_removal_benefit: carbon_farming_temporary_net_carbon_removal_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>carbon_removals_under_baseline: carbon_removals_under_baseline as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: carbon_storage_temporary_net_carbon_removal_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>certificate_of_compliance_hash: certificate_of_compliance_hash stored on-chain: keccak256 of the raw certificate_of_compliance entity body.</li>\n<li>certificate_of_compliance_id: Links to the <code>certificate_of_compliance</code> dynamic entity. The on-chain CertificationNFT is keyed by this id.</li>\n<li>certificate_of_compliance_uri: certificate_of_compliance_uri stored on-chain: link back to the OBP certificate_of_compliance entity.</li>\n<li>certification_body_hash: certification_body_hash stored on-chain: keccak256 of the raw certification_body entity body.</li>\n<li>certification_body_name: Certification body name as stored on-chain.</li>\n<li>certification_body_uri: certification_body_uri stored on-chain: link back to the OBP certification_body entity.</li>\n<li>certification_scheme_hash: certification_scheme_hash stored on-chain: keccak256 of the raw certification_scheme entity body.</li>\n<li>certification_scheme_name: Certification scheme name as stored on-chain.</li>\n<li>certification_scheme_uri: certification_scheme_uri stored on-chain: link back to the OBP certification_scheme entity.</li>\n<li>certification_status: Certification status as stored on-chain.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: CertificationNFT contract address the token was read from.</li>\n<li>country_id: Country id as stored on-chain.</li>\n<li>expiry_date: Certification expiry date as stored on-chain.</li>\n<li>issue_date: Certification issue date as stored on-chain.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>permanent_net_carbon_removal_benefit: permanent_net_carbon_removal_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>soil_emissions_under_baseline: soil_emissions_under_baseline as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>token_id: CertificationNFT token id minted for this certificate.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>tx_hash: Mint transaction hash (from the CertificationMinted event).</li>\n<li>unit_types: Unit types of the certificate as stored on-chain.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updatecertification_on_chain_ogcr","parameters":[{"name":"certificationonchainid","in":"path","description":"The CERTIFICATIONONCHAINID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"activity_uri":{"type":"string"},"carbon_removals_under_baseline":{"type":"string"},"audit_report_hash":{"type":"string"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"string"},"certification_scheme_uri":{"type":"string"},"block_number":{"type":"integer"},"certification_body_name":{"type":"string"},"certification_body_uri":{"type":"string"},"token_uri":{"type":"string"},"certificate_of_compliance_hash":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"string"},"activity_nft_id":{"type":"integer"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"certificate_of_compliance_uri":{"type":"string"},"audit_report_uri":{"type":"string"},"certification_scheme_hash":{"type":"string"},"token_id":{"type":"integer"},"activity_name":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"string"},"unit_types":{"type":"string"},"activity_hash":{"type":"string"},"contract_address":{"type":"string"},"certification_status":{"type":"string"},"certification_scheme_name":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"string"},"permanent_net_carbon_removal_benefit":{"type":"string"},"country_id":{"type":"string"},"certification_body_hash":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"}}},"example":{"activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_name":"Reforestation 2024","activity_nft_id":1,"activity_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/activity/activity_AB12CD34EF","audit_report_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","audit_report_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/audit_report/audit_report_01","block_number":12345,"carbon_farming_net_soil_emission_reduction_benefit":"10.5","carbon_farming_temporary_net_carbon_removal_benefit":"10.5","carbon_removals_under_baseline":"10.5","carbon_storage_temporary_net_carbon_removal_benefit":"10.5","certificate_of_compliance_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certificate_of_compliance_id":"coc_AB12CD34EF","certificate_of_compliance_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certificate_of_compliance/coc_AB12CD34EF","certification_body_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_body_name":"Example Certification Body","certification_body_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certification_body/body_VERRA","certification_scheme_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_scheme_name":"Example Certification Scheme","certification_scheme_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certification_scheme/scheme_SALUS","certification_status":"certified","chain_id":20253,"contract_address":"0x2e335F247E91caa168c64b63104C4475b2af3942","country_id":"DK","expiry_date":"2029-06-01","issue_date":"2024-06-01","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","permanent_net_carbon_removal_benefit":"10.5","soil_emissions_under_baseline":"10.5","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQ2VydCJ9","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_types":"Permanent Removal"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_on_chain":{"type":"object","properties":{"certification_on_chain_id":{"type":"string"},"activity_uri":{"type":"string"},"carbon_removals_under_baseline":{"type":"string"},"audit_report_hash":{"type":"string"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"string"},"certification_scheme_uri":{"type":"string"},"block_number":{"type":"integer"},"certification_body_name":{"type":"string"},"certification_body_uri":{"type":"string"},"token_uri":{"type":"string"},"certificate_of_compliance_hash":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"string"},"activity_nft_id":{"type":"integer"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"certificate_of_compliance_uri":{"type":"string"},"audit_report_uri":{"type":"string"},"certification_scheme_hash":{"type":"string"},"token_id":{"type":"integer"},"activity_name":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"string"},"unit_types":{"type":"string"},"activity_hash":{"type":"string"},"contract_address":{"type":"string"},"certification_status":{"type":"string"},"certification_scheme_name":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"string"},"permanent_net_carbon_removal_benefit":{"type":"string"},"country_id":{"type":"string"},"certification_body_hash":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certification_on_chain":{"certification_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_name":"Reforestation 2024","activity_nft_id":1,"activity_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/activity/activity_AB12CD34EF","audit_report_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","audit_report_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/audit_report/audit_report_01","block_number":12345,"carbon_farming_net_soil_emission_reduction_benefit":"10.5","carbon_farming_temporary_net_carbon_removal_benefit":"10.5","carbon_removals_under_baseline":"10.5","carbon_storage_temporary_net_carbon_removal_benefit":"10.5","certificate_of_compliance_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certificate_of_compliance_id":"coc_AB12CD34EF","certificate_of_compliance_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certificate_of_compliance/coc_AB12CD34EF","certification_body_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_body_name":"Example Certification Body","certification_body_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certification_body/body_VERRA","certification_scheme_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_scheme_name":"Example Certification Scheme","certification_scheme_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certification_scheme/scheme_SALUS","certification_status":"certified","chain_id":20253,"contract_address":"0x2e335F247E91caa168c64b63104C4475b2af3942","country_id":"DK","expiry_date":"2029-06-01","issue_date":"2024-06-01","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","permanent_net_carbon_removal_benefit":"10.5","soil_emissions_under_baseline":"10.5","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQ2VydCJ9","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_types":"Permanent Removal"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Certification_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete certification_on_chain by id","description":"<p>Delete certification_on_chain by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletecertification_on_chain_ogcr","parameters":[{"name":"certificationonchainid","in":"path","description":"The CERTIFICATIONONCHAINID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_on_chain":{"type":"object","properties":{"certification_on_chain_id":{"type":"string"},"activity_uri":{"type":"string"},"carbon_removals_under_baseline":{"type":"string"},"audit_report_hash":{"type":"string"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"string"},"certification_scheme_uri":{"type":"string"},"block_number":{"type":"integer"},"certification_body_name":{"type":"string"},"certification_body_uri":{"type":"string"},"token_uri":{"type":"string"},"certificate_of_compliance_hash":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"string"},"activity_nft_id":{"type":"integer"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"certificate_of_compliance_uri":{"type":"string"},"audit_report_uri":{"type":"string"},"certification_scheme_hash":{"type":"string"},"token_id":{"type":"integer"},"activity_name":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"string"},"unit_types":{"type":"string"},"activity_hash":{"type":"string"},"contract_address":{"type":"string"},"certification_status":{"type":"string"},"certification_scheme_name":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"string"},"permanent_net_carbon_removal_benefit":{"type":"string"},"country_id":{"type":"string"},"certification_body_hash":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certification_on_chain":{"certification_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_name":"Reforestation 2024","activity_nft_id":1,"activity_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/activity/activity_AB12CD34EF","audit_report_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","audit_report_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/audit_report/audit_report_01","block_number":12345,"carbon_farming_net_soil_emission_reduction_benefit":"10.5","carbon_farming_temporary_net_carbon_removal_benefit":"10.5","carbon_removals_under_baseline":"10.5","carbon_storage_temporary_net_carbon_removal_benefit":"10.5","certificate_of_compliance_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certificate_of_compliance_id":"coc_AB12CD34EF","certificate_of_compliance_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certificate_of_compliance/coc_AB12CD34EF","certification_body_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_body_name":"Example Certification Body","certification_body_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certification_body/body_VERRA","certification_scheme_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_scheme_name":"Example Certification Scheme","certification_scheme_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certification_scheme/scheme_SALUS","certification_status":"certified","chain_id":20253,"contract_address":"0x2e335F247E91caa168c64b63104C4475b2af3942","country_id":"DK","expiry_date":"2029-06-01","issue_date":"2024-06-01","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","permanent_net_carbon_removal_benefit":"10.5","soil_emissions_under_baseline":"10.5","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQ2VydCJ9","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_types":"Permanent Removal"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Certification_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update certification_on_chain","description":"<p>Partially update certification_on_chain: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Cache of CertificationNFT data minted on the OGCR chain (chain id 20253). One record per certificate_of_compliance_id (a re-certification is a new certificate and a new record), populated by OGCR-chain-cache reading the chain.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_hash: activity_hash stored on-chain: keccak256 of the raw activity entity body.</li>\n<li>activity_id: activity_id of the certified activity as stored on-chain.</li>\n<li>activity_name: Activity name as stored on-chain.</li>\n<li>activity_nft_id: ActivityNFT token id this certification references (stored on-chain).</li>\n<li>activity_uri: activity_uri stored on-chain: link back to the OBP activity entity.</li>\n<li>audit_report_hash: audit_report_hash stored on-chain: keccak256 of the raw audit_report entity body.</li>\n<li>audit_report_uri: audit_report_uri stored on-chain: link back to the OBP audit_report entity.</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: carbon_farming_net_soil_emission_reduction_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>carbon_farming_temporary_net_carbon_removal_benefit: carbon_farming_temporary_net_carbon_removal_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>carbon_removals_under_baseline: carbon_removals_under_baseline as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: carbon_storage_temporary_net_carbon_removal_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>certificate_of_compliance_hash: certificate_of_compliance_hash stored on-chain: keccak256 of the raw certificate_of_compliance entity body.</li>\n<li>certificate_of_compliance_id: Links to the <code>certificate_of_compliance</code> dynamic entity. The on-chain CertificationNFT is keyed by this id.</li>\n<li>certificate_of_compliance_uri: certificate_of_compliance_uri stored on-chain: link back to the OBP certificate_of_compliance entity.</li>\n<li>certification_body_hash: certification_body_hash stored on-chain: keccak256 of the raw certification_body entity body.</li>\n<li>certification_body_name: Certification body name as stored on-chain.</li>\n<li>certification_body_uri: certification_body_uri stored on-chain: link back to the OBP certification_body entity.</li>\n<li>certification_scheme_hash: certification_scheme_hash stored on-chain: keccak256 of the raw certification_scheme entity body.</li>\n<li>certification_scheme_name: Certification scheme name as stored on-chain.</li>\n<li>certification_scheme_uri: certification_scheme_uri stored on-chain: link back to the OBP certification_scheme entity.</li>\n<li>certification_status: Certification status as stored on-chain.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: CertificationNFT contract address the token was read from.</li>\n<li>country_id: Country id as stored on-chain.</li>\n<li>expiry_date: Certification expiry date as stored on-chain.</li>\n<li>issue_date: Certification issue date as stored on-chain.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>permanent_net_carbon_removal_benefit: permanent_net_carbon_removal_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>soil_emissions_under_baseline: soil_emissions_under_baseline as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>token_id: CertificationNFT token id minted for this certificate.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>tx_hash: Mint transaction hash (from the CertificationMinted event).</li>\n<li>unit_types: Unit types of the certificate as stored on-chain.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchcertification_on_chain_ogcr","parameters":[{"name":"certificationonchainid","in":"path","description":"The CERTIFICATIONONCHAINID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"activity_uri":{"type":"string"},"carbon_removals_under_baseline":{"type":"string"},"audit_report_hash":{"type":"string"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"string"},"certification_scheme_uri":{"type":"string"},"block_number":{"type":"integer"},"certification_body_name":{"type":"string"},"certification_body_uri":{"type":"string"},"token_uri":{"type":"string"},"certificate_of_compliance_hash":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"string"},"activity_nft_id":{"type":"integer"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"certificate_of_compliance_uri":{"type":"string"},"audit_report_uri":{"type":"string"},"certification_scheme_hash":{"type":"string"},"token_id":{"type":"integer"},"activity_name":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"string"},"unit_types":{"type":"string"},"activity_hash":{"type":"string"},"contract_address":{"type":"string"},"certification_status":{"type":"string"},"certification_scheme_name":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"string"},"permanent_net_carbon_removal_benefit":{"type":"string"},"country_id":{"type":"string"},"certification_body_hash":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"}}},"example":{"activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_name":"Reforestation 2024","activity_nft_id":1,"activity_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/activity/activity_AB12CD34EF","audit_report_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","audit_report_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/audit_report/audit_report_01","block_number":12345,"carbon_farming_net_soil_emission_reduction_benefit":"10.5","carbon_farming_temporary_net_carbon_removal_benefit":"10.5","carbon_removals_under_baseline":"10.5","carbon_storage_temporary_net_carbon_removal_benefit":"10.5","certificate_of_compliance_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certificate_of_compliance_id":"coc_AB12CD34EF","certificate_of_compliance_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certificate_of_compliance/coc_AB12CD34EF","certification_body_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_body_name":"Example Certification Body","certification_body_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certification_body/body_VERRA","certification_scheme_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_scheme_name":"Example Certification Scheme","certification_scheme_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certification_scheme/scheme_SALUS","certification_status":"certified","chain_id":20253,"contract_address":"0x2e335F247E91caa168c64b63104C4475b2af3942","country_id":"DK","expiry_date":"2029-06-01","issue_date":"2024-06-01","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","permanent_net_carbon_removal_benefit":"10.5","soil_emissions_under_baseline":"10.5","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQ2VydCJ9","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_types":"Permanent Removal"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_on_chain":{"type":"object","properties":{"certification_on_chain_id":{"type":"string"},"activity_uri":{"type":"string"},"carbon_removals_under_baseline":{"type":"string"},"audit_report_hash":{"type":"string"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"string"},"certification_scheme_uri":{"type":"string"},"block_number":{"type":"integer"},"certification_body_name":{"type":"string"},"certification_body_uri":{"type":"string"},"token_uri":{"type":"string"},"certificate_of_compliance_hash":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"string"},"activity_nft_id":{"type":"integer"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"certificate_of_compliance_uri":{"type":"string"},"audit_report_uri":{"type":"string"},"certification_scheme_hash":{"type":"string"},"token_id":{"type":"integer"},"activity_name":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"string"},"unit_types":{"type":"string"},"activity_hash":{"type":"string"},"contract_address":{"type":"string"},"certification_status":{"type":"string"},"certification_scheme_name":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"string"},"permanent_net_carbon_removal_benefit":{"type":"string"},"country_id":{"type":"string"},"certification_body_hash":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certification_on_chain":{"certification_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_name":"Reforestation 2024","activity_nft_id":1,"activity_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/activity/activity_AB12CD34EF","audit_report_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","audit_report_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/audit_report/audit_report_01","block_number":12345,"carbon_farming_net_soil_emission_reduction_benefit":"10.5","carbon_farming_temporary_net_carbon_removal_benefit":"10.5","carbon_removals_under_baseline":"10.5","carbon_storage_temporary_net_carbon_removal_benefit":"10.5","certificate_of_compliance_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certificate_of_compliance_id":"coc_AB12CD34EF","certificate_of_compliance_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certificate_of_compliance/coc_AB12CD34EF","certification_body_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_body_name":"Example Certification Body","certification_body_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certification_body/body_VERRA","certification_scheme_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_scheme_name":"Example Certification Scheme","certification_scheme_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certification_scheme/scheme_SALUS","certification_status":"certified","chain_id":20253,"contract_address":"0x2e335F247E91caa168c64b63104C4475b2af3942","country_id":"DK","expiry_date":"2029-06-01","issue_date":"2024-06-01","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","permanent_net_carbon_removal_benefit":"10.5","soil_emissions_under_baseline":"10.5","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQ2VydCJ9","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_types":"Permanent Removal"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/technologies-practices-processes/{technologiespracticesprocessesid}":{"get":{"tags":["_Technologies_practices_processes(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get technologies_practices_processes by id","description":"<p>Get technologies_practices_processes by id.</p>\n<p>This is the lookup table for technologies, practices and processes. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"technologies_practices_processes\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingletechnologies_practices_processes_ogcr","parameters":[{"name":"technologiespracticesprocessesid","in":"path","description":"The TECHNOLOGIESPRACTICESPROCESSESID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"technologies_practices_processes":{"type":"object","properties":{"technologies_practices_processes_id":{"type":"string"},"practice_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"technologies_practices_processes":{"technologies_practices_processes_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","technologies_practices_processes_id":"string","practice_name":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Technologies_practices_processes(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update technologies_practices_processes","description":"<p>Update technologies_practices_processes.</p>\n<p>This is the lookup table for technologies, practices and processes. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"technologies_practices_processes\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updatetechnologies_practices_processes_ogcr","parameters":[{"name":"technologiespracticesprocessesid","in":"path","description":"The TECHNOLOGIESPRACTICESPROCESSESID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"technologies_practices_processes_id":{"type":"string"},"practice_name":{"type":"string"}}},"example":{"technologies_practices_processes_id":"string","practice_name":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"technologies_practices_processes":{"type":"object","properties":{"technologies_practices_processes_id":{"type":"string"},"practice_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"technologies_practices_processes":{"technologies_practices_processes_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","technologies_practices_processes_id":"string","practice_name":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Technologies_practices_processes(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete technologies_practices_processes by id","description":"<p>Delete technologies_practices_processes by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"technologies_practices_processes\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletetechnologies_practices_processes_ogcr","parameters":[{"name":"technologiespracticesprocessesid","in":"path","description":"The TECHNOLOGIESPRACTICESPROCESSESID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"technologies_practices_processes":{"type":"object","properties":{"technologies_practices_processes_id":{"type":"string"},"practice_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"technologies_practices_processes":{"technologies_practices_processes_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","technologies_practices_processes_id":"string","practice_name":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Technologies_practices_processes(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update technologies_practices_processes","description":"<p>Partially update technologies_practices_processes: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>This is the lookup table for technologies, practices and processes. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"technologies_practices_processes\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchtechnologies_practices_processes_ogcr","parameters":[{"name":"technologiespracticesprocessesid","in":"path","description":"The TECHNOLOGIESPRACTICESPROCESSESID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"technologies_practices_processes_id":{"type":"string"},"practice_name":{"type":"string"}}},"example":{"technologies_practices_processes_id":"string","practice_name":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"technologies_practices_processes":{"type":"object","properties":{"technologies_practices_processes_id":{"type":"string"},"practice_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"technologies_practices_processes":{"technologies_practices_processes_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","technologies_practices_processes_id":"string","practice_name":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/audit-report":{"get":{"tags":["_Audit_report(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get audit_report List","description":"<p>Get audit_report List.</p>\n<p>Audit report is the outcome of the audit conducted by certification bodies. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>audit_report_id: (uu)id of the audit report</li>\n<li>audit_report_summary: Short human-readable summary of audit scope, approach, and conclusion.</li>\n<li>operator_id: Operator\u2019s legal name</li>\n<li>group_manager_legal_name: For group certification: group manager name</li>\n<li>group_manager_address: For group certification: group manager address</li>\n<li>group_activity_operator_list: For group certification: list of carbon farming activities under scope (operators\u2019 names and addresses)</li>\n<li>activity_id: Internal identifier for the activity entity</li>\n<li>certification_scope: Scope of certification</li>\n<li>certification_scheme_id: Methodology(ies) the scheme applies (identifier + version).</li>\n<li>certification_methodology_legal_reference: Legal reference for certification methodology</li>\n<li>activity_plan_id: Reference number of the activity plan</li>\n<li>monitoring_plan_id: Reference number of the monitoring plan</li>\n<li>permanent_net_carbon_removal_benefit: Expected/verified amount of permanent net carbon removal benefit (in Co2e Tonnes)</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: Expected/verified amount of temporary net carbon removal benefit (in Co2e Tonnes)</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: Expected/verified amount of net soil emission reduction benefit (in Co2e Tonnes)</li>\n<li>sustainability_co_benefits: Sustainability co-benefits associated with the activity</li>\n<li>certification_body_id: Legal or trading name of the certification body</li>\n<li>audit_team_composition: Composition of the audit team</li>\n<li>national_accreditation_body: National accreditation body and scope/date of accreditation (or recognition authority and scope/date)</li>\n<li>accreditation_scope: Accreditation scope</li>\n<li>accreditation_date: Accreditation date</li>\n<li>national_recognition_authority: National recognition authority</li>\n<li>recognition_scope: Recognition scope</li>\n<li>recognition_date: Recognition date</li>\n<li>audit_date: Date of the audit</li>\n<li>audit_itinerary: Audit itinerary and duration (split onsite/remote where relevant)</li>\n<li>audit_duration_onsite: Duration spent on-site</li>\n<li>audit_duration_remote: Duration spent remotely</li>\n<li>sites_audited: Sites audited</li>\n<li>audit_method_risk_assessment: Audit method, risk assessment</li>\n<li>audit_method_sampling_basis: Audit method, sampling basis</li>\n<li>audit_method_stakeholder_consultation: Audit method, stakeholder consultation</li>\n<li>other_certification_schemes_or_standards_certified: Certification of other certification schemes or standards</li>\n<li>ghg_data_type: GHG data type</li>\n<li>audit_report_issue_location: Place of issuance of the audit report</li>\n<li>audit_report_issue_date: Date of issuance of the audit report</li>\n<li>certificate_valid_from_date: Certificate valid from date</li>\n<li>certificate_valid_to_date: Certificate valid to date</li>\n<li>date_certified: Date certified (if applicable)</li>\n<li>issuing_party_signature_or_stamp: Stamp and/or signature of issuing party</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"audit_report\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>activity_plan_id</code>, <code>audit_report_id</code>, <code>certification_scheme_id</code>, <code>monitoring_plan_id</code>, <code>operator_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>activity_id</code> → <code>activity</code>, <code>activity_plan_id</code> → <code>activity_plan</code>, <code>certification_scheme_id</code> → <code>certification_scheme</code>, <code>monitoring_plan_id</code> → <code>monitoring_plan</code>, <code>operator_id</code> → <code>operator</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getaudit_reportList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"audit_report_list":{"type":"array","items":{"type":"object","properties":{"audit_report":{"type":"object","properties":{"audit_method_stakeholder_consultation":{"type":"string"},"sustainability_co_benefits":{"type":"string"},"audit_method_risk_assessment":{"type":"string"},"accreditation_date":{"type":"string"},"group_manager_address":{"type":"string"},"audit_duration_remote":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"national_accreditation_body":{"type":"string"},"audit_report_issue_date":{"type":"string"},"certification_body_id":{"type":"string"},"group_manager_legal_name":{"type":"string"},"audit_duration_onsite":{"type":"string"},"activity_plan_id":{"type":"string"},"audit_date":{"type":"string"},"certification_scheme_id":{"type":"string"},"certificate_valid_to_date":{"type":"string"},"ghg_data_type":{"type":"string"},"accreditation_scope":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"certification_scope":{"type":"string"},"audit_report_issue_location":{"type":"string"},"certification_methodology_legal_reference":{"type":"string"},"issuing_party_signature_or_stamp":{"type":"string"},"group_activity_operator_list":{"type":"string"},"other_certification_schemes_or_standards_certified":{"type":"string"},"certificate_valid_from_date":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"audit_report_id":{"type":"string"},"national_recognition_authority":{"type":"string"},"sites_audited":{"type":"string"},"monitoring_plan_id":{"type":"string"},"recognition_date":{"type":"string"},"audit_report_summary":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"audit_method_sampling_basis":{"type":"string"},"date_certified":{"type":"string"},"audit_team_composition":{"type":"string"},"recognition_scope":{"type":"string"},"audit_itinerary":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"audit_report_list":[{"audit_report":{"audit_report_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","audit_report_id":"string","audit_report_summary":"Audit confirmed conformance to methodology X for monitoring period FY2027; no major non-conformities.","operator_id":"op_05OFWI037022","group_manager_legal_name":"Green Fields Cooperative GmbH","group_manager_address":"Hauptstrasse 12, 15230 Frankfurt (Oder), Germany","group_activity_operator_list":"[{\"operator\": \"Oderbruch Farms GmbH\", \"address\": \"Dorfstrasse 4, 15324 Letschin, Germany\"}]","activity_id":"a_05OFWI037022","certification_scope":"Carbon farming activity a_05OFWI037022, 120 ha across 14 parcels, monitoring period 2027 to 2031","certification_scheme_id":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","certification_methodology_legal_reference":"Methodology crcf_agri_mineral_soils version 1.0, adopted under Article 8 of Regulation (EU) 2024/3012","activity_plan_id":"ap_01HZY3...","monitoring_plan_id":"mp_01HZYW...","permanent_net_carbon_removal_benefit":6.5,"carbon_farming_temporary_net_carbon_removal_benefit":6.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"sustainability_co_benefits":"Biodiversity and soil health (Article 7(1)(f))","certification_body_id":"DNV Business Assurance Germany GmbH","audit_team_composition":"Lead auditor, one soil science expert, one auditor in training","national_accreditation_body":"DAkkS (Germany), accredited for carbon farming certification audits since 1 March 2025","accreditation_scope":"Verification and certification of carbon farming activities under Regulation (EU) 2024/3012","accreditation_date":"2025-03-01","national_recognition_authority":"Not applicable (accredited body)","recognition_scope":"Not applicable (accredited body)","recognition_date":"2026-05-24","audit_date":"2026-12-15","audit_itinerary":"Day 1 on-site: farm and parcels A to C. Day 2 on-site: records review. Day 3 remote: closing meeting","audit_duration_onsite":"2 days","audit_duration_remote":"1 day","sites_audited":"Oderbruch Farms GmbH headquarters and 4 of 14 parcels","audit_method_risk_assessment":"Risk-based: more sampling on parcels with a large claimed benefit","audit_method_sampling_basis":"Random sample of 30% of parcels plus all parcels above 10 ha","audit_method_stakeholder_consultation":"Interviews with the operator, the farm advisor and two neighbouring landowners","other_certification_schemes_or_standards_certified":"string","ghg_data_type":"Measured (soil sampling), with modelled values for unsampled parcels","audit_report_issue_location":"Hamburg, Germany","audit_report_issue_date":"2026-12-20","certificate_valid_from_date":"2027-01-01","certificate_valid_to_date":"2031-12-31","date_certified":"2026-12-25","issuing_party_signature_or_stamp":"Signed and stamped by the lead auditor, DNV Business Assurance Germany GmbH"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Audit_report(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new audit_report","description":"<p>Create new audit_report.</p>\n<p>Audit report is the outcome of the audit conducted by certification bodies. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>audit_report_id: (uu)id of the audit report</li>\n<li>audit_report_summary: Short human-readable summary of audit scope, approach, and conclusion.</li>\n<li>operator_id: Operator\u2019s legal name</li>\n<li>group_manager_legal_name: For group certification: group manager name</li>\n<li>group_manager_address: For group certification: group manager address</li>\n<li>group_activity_operator_list: For group certification: list of carbon farming activities under scope (operators\u2019 names and addresses)</li>\n<li>activity_id: Internal identifier for the activity entity</li>\n<li>certification_scope: Scope of certification</li>\n<li>certification_scheme_id: Methodology(ies) the scheme applies (identifier + version).</li>\n<li>certification_methodology_legal_reference: Legal reference for certification methodology</li>\n<li>activity_plan_id: Reference number of the activity plan</li>\n<li>monitoring_plan_id: Reference number of the monitoring plan</li>\n<li>permanent_net_carbon_removal_benefit: Expected/verified amount of permanent net carbon removal benefit (in Co2e Tonnes)</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: Expected/verified amount of temporary net carbon removal benefit (in Co2e Tonnes)</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: Expected/verified amount of net soil emission reduction benefit (in Co2e Tonnes)</li>\n<li>sustainability_co_benefits: Sustainability co-benefits associated with the activity</li>\n<li>certification_body_id: Legal or trading name of the certification body</li>\n<li>audit_team_composition: Composition of the audit team</li>\n<li>national_accreditation_body: National accreditation body and scope/date of accreditation (or recognition authority and scope/date)</li>\n<li>accreditation_scope: Accreditation scope</li>\n<li>accreditation_date: Accreditation date</li>\n<li>national_recognition_authority: National recognition authority</li>\n<li>recognition_scope: Recognition scope</li>\n<li>recognition_date: Recognition date</li>\n<li>audit_date: Date of the audit</li>\n<li>audit_itinerary: Audit itinerary and duration (split onsite/remote where relevant)</li>\n<li>audit_duration_onsite: Duration spent on-site</li>\n<li>audit_duration_remote: Duration spent remotely</li>\n<li>sites_audited: Sites audited</li>\n<li>audit_method_risk_assessment: Audit method, risk assessment</li>\n<li>audit_method_sampling_basis: Audit method, sampling basis</li>\n<li>audit_method_stakeholder_consultation: Audit method, stakeholder consultation</li>\n<li>other_certification_schemes_or_standards_certified: Certification of other certification schemes or standards</li>\n<li>ghg_data_type: GHG data type</li>\n<li>audit_report_issue_location: Place of issuance of the audit report</li>\n<li>audit_report_issue_date: Date of issuance of the audit report</li>\n<li>certificate_valid_from_date: Certificate valid from date</li>\n<li>certificate_valid_to_date: Certificate valid to date</li>\n<li>date_certified: Date certified (if applicable)</li>\n<li>issuing_party_signature_or_stamp: Stamp and/or signature of issuing party</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"audit_report\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createaudit_report_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"audit_method_stakeholder_consultation":{"type":"string"},"sustainability_co_benefits":{"type":"string"},"audit_method_risk_assessment":{"type":"string"},"accreditation_date":{"type":"string"},"group_manager_address":{"type":"string"},"audit_duration_remote":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"national_accreditation_body":{"type":"string"},"audit_report_issue_date":{"type":"string"},"certification_body_id":{"type":"string"},"group_manager_legal_name":{"type":"string"},"audit_duration_onsite":{"type":"string"},"activity_plan_id":{"type":"string"},"audit_date":{"type":"string"},"certification_scheme_id":{"type":"string"},"certificate_valid_to_date":{"type":"string"},"ghg_data_type":{"type":"string"},"accreditation_scope":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"certification_scope":{"type":"string"},"audit_report_issue_location":{"type":"string"},"certification_methodology_legal_reference":{"type":"string"},"issuing_party_signature_or_stamp":{"type":"string"},"group_activity_operator_list":{"type":"string"},"other_certification_schemes_or_standards_certified":{"type":"string"},"certificate_valid_from_date":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"audit_report_id":{"type":"string"},"national_recognition_authority":{"type":"string"},"sites_audited":{"type":"string"},"monitoring_plan_id":{"type":"string"},"recognition_date":{"type":"string"},"audit_report_summary":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"audit_method_sampling_basis":{"type":"string"},"date_certified":{"type":"string"},"audit_team_composition":{"type":"string"},"recognition_scope":{"type":"string"},"audit_itinerary":{"type":"string"}}},"example":{"audit_report_id":"string","audit_report_summary":"Audit confirmed conformance to methodology X for monitoring period FY2027; no major non-conformities.","operator_id":"op_05OFWI037022","group_manager_legal_name":"Green Fields Cooperative GmbH","group_manager_address":"Hauptstrasse 12, 15230 Frankfurt (Oder), Germany","group_activity_operator_list":"[{\"operator\": \"Oderbruch Farms GmbH\", \"address\": \"Dorfstrasse 4, 15324 Letschin, Germany\"}]","activity_id":"a_05OFWI037022","certification_scope":"Carbon farming activity a_05OFWI037022, 120 ha across 14 parcels, monitoring period 2027 to 2031","certification_scheme_id":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","certification_methodology_legal_reference":"Methodology crcf_agri_mineral_soils version 1.0, adopted under Article 8 of Regulation (EU) 2024/3012","activity_plan_id":"ap_01HZY3...","monitoring_plan_id":"mp_01HZYW...","permanent_net_carbon_removal_benefit":6.5,"carbon_farming_temporary_net_carbon_removal_benefit":6.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"sustainability_co_benefits":"Biodiversity and soil health (Article 7(1)(f))","certification_body_id":"DNV Business Assurance Germany GmbH","audit_team_composition":"Lead auditor, one soil science expert, one auditor in training","national_accreditation_body":"DAkkS (Germany), accredited for carbon farming certification audits since 1 March 2025","accreditation_scope":"Verification and certification of carbon farming activities under Regulation (EU) 2024/3012","accreditation_date":"2025-03-01","national_recognition_authority":"Not applicable (accredited body)","recognition_scope":"Not applicable (accredited body)","recognition_date":"2026-05-24","audit_date":"2026-12-15","audit_itinerary":"Day 1 on-site: farm and parcels A to C. Day 2 on-site: records review. Day 3 remote: closing meeting","audit_duration_onsite":"2 days","audit_duration_remote":"1 day","sites_audited":"Oderbruch Farms GmbH headquarters and 4 of 14 parcels","audit_method_risk_assessment":"Risk-based: more sampling on parcels with a large claimed benefit","audit_method_sampling_basis":"Random sample of 30% of parcels plus all parcels above 10 ha","audit_method_stakeholder_consultation":"Interviews with the operator, the farm advisor and two neighbouring landowners","other_certification_schemes_or_standards_certified":"string","ghg_data_type":"Measured (soil sampling), with modelled values for unsampled parcels","audit_report_issue_location":"Hamburg, Germany","audit_report_issue_date":"2026-12-20","certificate_valid_from_date":"2027-01-01","certificate_valid_to_date":"2031-12-31","date_certified":"2026-12-25","issuing_party_signature_or_stamp":"Signed and stamped by the lead auditor, DNV Business Assurance Germany GmbH"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"audit_report":{"type":"object","properties":{"audit_method_stakeholder_consultation":{"type":"string"},"sustainability_co_benefits":{"type":"string"},"audit_method_risk_assessment":{"type":"string"},"accreditation_date":{"type":"string"},"group_manager_address":{"type":"string"},"audit_duration_remote":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"national_accreditation_body":{"type":"string"},"audit_report_issue_date":{"type":"string"},"certification_body_id":{"type":"string"},"group_manager_legal_name":{"type":"string"},"audit_duration_onsite":{"type":"string"},"activity_plan_id":{"type":"string"},"audit_date":{"type":"string"},"certification_scheme_id":{"type":"string"},"certificate_valid_to_date":{"type":"string"},"ghg_data_type":{"type":"string"},"accreditation_scope":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"certification_scope":{"type":"string"},"audit_report_issue_location":{"type":"string"},"certification_methodology_legal_reference":{"type":"string"},"issuing_party_signature_or_stamp":{"type":"string"},"group_activity_operator_list":{"type":"string"},"other_certification_schemes_or_standards_certified":{"type":"string"},"certificate_valid_from_date":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"audit_report_id":{"type":"string"},"national_recognition_authority":{"type":"string"},"sites_audited":{"type":"string"},"monitoring_plan_id":{"type":"string"},"recognition_date":{"type":"string"},"audit_report_summary":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"audit_method_sampling_basis":{"type":"string"},"date_certified":{"type":"string"},"audit_team_composition":{"type":"string"},"recognition_scope":{"type":"string"},"audit_itinerary":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"audit_report":{"audit_report_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","audit_report_id":"string","audit_report_summary":"Audit confirmed conformance to methodology X for monitoring period FY2027; no major non-conformities.","operator_id":"op_05OFWI037022","group_manager_legal_name":"Green Fields Cooperative GmbH","group_manager_address":"Hauptstrasse 12, 15230 Frankfurt (Oder), Germany","group_activity_operator_list":"[{\"operator\": \"Oderbruch Farms GmbH\", \"address\": \"Dorfstrasse 4, 15324 Letschin, Germany\"}]","activity_id":"a_05OFWI037022","certification_scope":"Carbon farming activity a_05OFWI037022, 120 ha across 14 parcels, monitoring period 2027 to 2031","certification_scheme_id":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","certification_methodology_legal_reference":"Methodology crcf_agri_mineral_soils version 1.0, adopted under Article 8 of Regulation (EU) 2024/3012","activity_plan_id":"ap_01HZY3...","monitoring_plan_id":"mp_01HZYW...","permanent_net_carbon_removal_benefit":6.5,"carbon_farming_temporary_net_carbon_removal_benefit":6.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"sustainability_co_benefits":"Biodiversity and soil health (Article 7(1)(f))","certification_body_id":"DNV Business Assurance Germany GmbH","audit_team_composition":"Lead auditor, one soil science expert, one auditor in training","national_accreditation_body":"DAkkS (Germany), accredited for carbon farming certification audits since 1 March 2025","accreditation_scope":"Verification and certification of carbon farming activities under Regulation (EU) 2024/3012","accreditation_date":"2025-03-01","national_recognition_authority":"Not applicable (accredited body)","recognition_scope":"Not applicable (accredited body)","recognition_date":"2026-05-24","audit_date":"2026-12-15","audit_itinerary":"Day 1 on-site: farm and parcels A to C. Day 2 on-site: records review. Day 3 remote: closing meeting","audit_duration_onsite":"2 days","audit_duration_remote":"1 day","sites_audited":"Oderbruch Farms GmbH headquarters and 4 of 14 parcels","audit_method_risk_assessment":"Risk-based: more sampling on parcels with a large claimed benefit","audit_method_sampling_basis":"Random sample of 30% of parcels plus all parcels above 10 ha","audit_method_stakeholder_consultation":"Interviews with the operator, the farm advisor and two neighbouring landowners","other_certification_schemes_or_standards_certified":"string","ghg_data_type":"Measured (soil sampling), with modelled values for unsampled parcels","audit_report_issue_location":"Hamburg, Germany","audit_report_issue_date":"2026-12-20","certificate_valid_from_date":"2027-01-01","certificate_valid_to_date":"2031-12-31","date_certified":"2026-12-25","issuing_party_signature_or_stamp":"Signed and stamped by the lead auditor, DNV Business Assurance Germany GmbH"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/parcel-owner-verification/{parcelownerverificationid}":{"get":{"tags":["_Parcel_owner_verification(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get parcel_owner_verification by id","description":"<p>Get parcel_owner_verification by id.</p>\n<p>Parcel owner verification' records the outcome of verifying legal ownership of a parcel against an authoritative source (e.g. national cadastre). Parcel status for NFT-minting purposes lives on this record (status_code), not on the parcel entity itself \u2014 minting is gated on a verified POV record. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>parcel_id: (uu)id of the parcel that gets verified</li>\n<li>status_code: in_progress, verified, failed</li>\n<li>status_message: further explanation of status code</li>\n<li>parcel_owner_legal_name: Legal owner of the parcel</li>\n<li>authority: name of authority that verified the ownership</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_owner_verification\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleparcel_owner_verification_ogcr","parameters":[{"name":"parcelownerverificationid","in":"path","description":"The PARCELOWNERVERIFICATIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_owner_verification":{"type":"object","properties":{"status_code":{"type":"string"},"parcel_owner_verification_id":{"type":"string"},"parcel_id":{"type":"string"},"authority":{"type":"string"},"parcel_owner_legal_name":{"type":"string"},"status_message":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_owner_verification":{"parcel_owner_verification_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_owner_verification_id":"string","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","status_code":"verified","status_message":"could not find owner","parcel_owner_legal_name":"string","authority":"Mycountry cadastre"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Parcel_owner_verification(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update parcel_owner_verification","description":"<p>Update parcel_owner_verification.</p>\n<p>Parcel owner verification' records the outcome of verifying legal ownership of a parcel against an authoritative source (e.g. national cadastre). Parcel status for NFT-minting purposes lives on this record (status_code), not on the parcel entity itself \u2014 minting is gated on a verified POV record. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>parcel_id: (uu)id of the parcel that gets verified</li>\n<li>status_code: in_progress, verified, failed</li>\n<li>status_message: further explanation of status code</li>\n<li>parcel_owner_legal_name: Legal owner of the parcel</li>\n<li>authority: name of authority that verified the ownership</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_owner_verification\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateparcel_owner_verification_ogcr","parameters":[{"name":"parcelownerverificationid","in":"path","description":"The PARCELOWNERVERIFICATIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"string"},"parcel_owner_verification_id":{"type":"string"},"parcel_id":{"type":"string"},"authority":{"type":"string"},"parcel_owner_legal_name":{"type":"string"},"status_message":{"type":"string"}}},"example":{"parcel_owner_verification_id":"string","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","status_code":"verified","status_message":"could not find owner","parcel_owner_legal_name":"string","authority":"Mycountry cadastre"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_owner_verification":{"type":"object","properties":{"status_code":{"type":"string"},"parcel_owner_verification_id":{"type":"string"},"parcel_id":{"type":"string"},"authority":{"type":"string"},"parcel_owner_legal_name":{"type":"string"},"status_message":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_owner_verification":{"parcel_owner_verification_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_owner_verification_id":"string","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","status_code":"verified","status_message":"could not find owner","parcel_owner_legal_name":"string","authority":"Mycountry cadastre"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Parcel_owner_verification(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete parcel_owner_verification by id","description":"<p>Delete parcel_owner_verification by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_owner_verification\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteparcel_owner_verification_ogcr","parameters":[{"name":"parcelownerverificationid","in":"path","description":"The PARCELOWNERVERIFICATIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_owner_verification":{"type":"object","properties":{"status_code":{"type":"string"},"parcel_owner_verification_id":{"type":"string"},"parcel_id":{"type":"string"},"authority":{"type":"string"},"parcel_owner_legal_name":{"type":"string"},"status_message":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_owner_verification":{"parcel_owner_verification_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_owner_verification_id":"string","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","status_code":"verified","status_message":"could not find owner","parcel_owner_legal_name":"string","authority":"Mycountry cadastre"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Parcel_owner_verification(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update parcel_owner_verification","description":"<p>Partially update parcel_owner_verification: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Parcel owner verification' records the outcome of verifying legal ownership of a parcel against an authoritative source (e.g. national cadastre). Parcel status for NFT-minting purposes lives on this record (status_code), not on the parcel entity itself \u2014 minting is gated on a verified POV record. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>parcel_id: (uu)id of the parcel that gets verified</li>\n<li>status_code: in_progress, verified, failed</li>\n<li>status_message: further explanation of status code</li>\n<li>parcel_owner_legal_name: Legal owner of the parcel</li>\n<li>authority: name of authority that verified the ownership</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_owner_verification\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchparcel_owner_verification_ogcr","parameters":[{"name":"parcelownerverificationid","in":"path","description":"The PARCELOWNERVERIFICATIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"string"},"parcel_owner_verification_id":{"type":"string"},"parcel_id":{"type":"string"},"authority":{"type":"string"},"parcel_owner_legal_name":{"type":"string"},"status_message":{"type":"string"}}},"example":{"parcel_owner_verification_id":"string","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","status_code":"verified","status_message":"could not find owner","parcel_owner_legal_name":"string","authority":"Mycountry cadastre"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_owner_verification":{"type":"object","properties":{"status_code":{"type":"string"},"parcel_owner_verification_id":{"type":"string"},"parcel_id":{"type":"string"},"authority":{"type":"string"},"parcel_owner_legal_name":{"type":"string"},"status_message":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_owner_verification":{"parcel_owner_verification_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_owner_verification_id":"string","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","status_code":"verified","status_message":"could not find owner","parcel_owner_legal_name":"string","authority":"Mycountry cadastre"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/sustainable-development-goal":{"get":{"tags":["_Sustainable_development_goal(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get sustainable_development_goal List","description":"<p>Get sustainable_development_goal List.</p>\n<p>This is the lookup table for sustainable development goals. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"sustainable_development_goal\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>sustainable_development_goal_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getsustainable_development_goalList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"sustainable_development_goal_list":{"type":"array","items":{"type":"object","properties":{"sustainable_development_goal":{"type":"object","properties":{"sustainable_development_goal_id":{"type":"string"},"sustainable_development_goal_name":{"type":"string"},"sustainable_development_goal_link":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"sustainable_development_goal_list":[{"sustainable_development_goal":{"sustainable_development_goal_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","sustainable_development_goal_id":"string","sustainable_development_goal_name":"string","sustainable_development_goal_link":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Sustainable_development_goal(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new sustainable_development_goal","description":"<p>Create new sustainable_development_goal.</p>\n<p>This is the lookup table for sustainable development goals. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"sustainable_development_goal\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createsustainable_development_goal_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"sustainable_development_goal_id":{"type":"string"},"sustainable_development_goal_name":{"type":"string"},"sustainable_development_goal_link":{"type":"string"}}},"example":{"sustainable_development_goal_id":"string","sustainable_development_goal_name":"string","sustainable_development_goal_link":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"sustainable_development_goal":{"type":"object","properties":{"sustainable_development_goal_id":{"type":"string"},"sustainable_development_goal_name":{"type":"string"},"sustainable_development_goal_link":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"sustainable_development_goal":{"sustainable_development_goal_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","sustainable_development_goal_id":"string","sustainable_development_goal_name":"string","sustainable_development_goal_link":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/parcel-snapshot":{"get":{"tags":["_Parcel_snapshot(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get parcel_snapshot List","description":"<p>Get parcel_snapshot List.</p>\n<p>\"parcel snapshot\" is a point-in-time record of what was happening on a parcel over a defined period \u2014 for example which growing seasons and livestock herds were present. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>digital_mrv_observation_id: The dMRV observation that triggered this snapshot</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_snapshot\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>digital_mrv_observation_id</code>, <code>land_manager_id</code>, <code>parcel_id</code>, <code>parcel_snapshot_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>digital_mrv_observation_id</code> → <code>digital_mrv_observation</code>, <code>land_manager_id</code> → <code>land_manager</code>, <code>parcel_id</code> → <code>parcel</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getparcel_snapshotList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_snapshot_list":{"type":"array","items":{"type":"object","properties":{"parcel_snapshot":{"type":"object","properties":{"land_manager_id":{"type":"string"},"snapshot_start_date":{"type":"string"},"snapshot_end_date":{"type":"string"},"livestock_list":{},"parcel_id":{"type":"string"},"parcel_snapshot_id":{"type":"string"},"digital_mrv_observation_id":{"type":"string"},"growing_season_list":{}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"parcel_snapshot_list":[{"parcel_snapshot":{"parcel_snapshot_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_snapshot_id":"string","parcel_id":"string","land_manager_id":"string","snapshot_start_date":"2020-01-01","snapshot_end_date":"2020-01-01","digital_mrv_observation_id":"string","growing_season_list":{},"livestock_list":{}},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Parcel_snapshot(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new parcel_snapshot","description":"<p>Create new parcel_snapshot.</p>\n<p>\"parcel snapshot\" is a point-in-time record of what was happening on a parcel over a defined period \u2014 for example which growing seasons and livestock herds were present. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>digital_mrv_observation_id: The dMRV observation that triggered this snapshot</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_snapshot\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createparcel_snapshot_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"land_manager_id":{"type":"string"},"snapshot_start_date":{"type":"string"},"snapshot_end_date":{"type":"string"},"livestock_list":{},"parcel_id":{"type":"string"},"parcel_snapshot_id":{"type":"string"},"digital_mrv_observation_id":{"type":"string"},"growing_season_list":{}}},"example":{"parcel_snapshot_id":"string","parcel_id":"string","land_manager_id":"string","snapshot_start_date":"2020-01-01","snapshot_end_date":"2020-01-01","digital_mrv_observation_id":"string","growing_season_list":{},"livestock_list":{}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_snapshot":{"type":"object","properties":{"land_manager_id":{"type":"string"},"snapshot_start_date":{"type":"string"},"snapshot_end_date":{"type":"string"},"livestock_list":{},"parcel_id":{"type":"string"},"parcel_snapshot_id":{"type":"string"},"digital_mrv_observation_id":{"type":"string"},"growing_season_list":{}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_snapshot":{"parcel_snapshot_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_snapshot_id":"string","parcel_id":"string","land_manager_id":"string","snapshot_start_date":"2020-01-01","snapshot_end_date":"2020-01-01","digital_mrv_observation_id":"string","growing_season_list":{},"livestock_list":{}},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/retirement-certificate/{retirementcertificateid}":{"get":{"tags":["_Retirement_certificate(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get retirement_certificate by id","description":"<p>Get retirement_certificate by id.</p>\n<p>Parsed entity retirement_certificate. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>retirement_certificate_id: (uu)id of the retirement certificate</li>\n<li>serial_number: Unique serial number of the retirement certificate</li>\n<li>retirement_event_id: Reference to the retirement event this certificate is certifying.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_certificate\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleretirement_certificate_ogcr","parameters":[{"name":"retirementcertificateid","in":"path","description":"The RETIREMENTCERTIFICATEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_certificate":{"type":"object","properties":{"end_use":{"type":"string"},"retirement_event_id":{"type":"string"},"retirement_certificate_id":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"activity_name":{"type":"string"},"certification_body_id":{"type":"string"},"serial_number":{"type":"string"},"beneficiary_name":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"retirement_certificate":{"retirement_certificate_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_certificate_id":"string","serial_number":"string","retirement_event_id":"string","issue_date":"2020-01-01","beneficiary_name":"string","end_use":"string","amount":1.0,"unit_type":"string","activity_id":"string","activity_name":"string","operator_id":"string","certification_scheme_id":"string","certification_body_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Retirement_certificate(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update retirement_certificate","description":"<p>Update retirement_certificate.</p>\n<p>Parsed entity retirement_certificate. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>retirement_certificate_id: (uu)id of the retirement certificate</li>\n<li>serial_number: Unique serial number of the retirement certificate</li>\n<li>retirement_event_id: Reference to the retirement event this certificate is certifying.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_certificate\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateretirement_certificate_ogcr","parameters":[{"name":"retirementcertificateid","in":"path","description":"The RETIREMENTCERTIFICATEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"end_use":{"type":"string"},"retirement_event_id":{"type":"string"},"retirement_certificate_id":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"activity_name":{"type":"string"},"certification_body_id":{"type":"string"},"serial_number":{"type":"string"},"beneficiary_name":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"}}},"example":{"retirement_certificate_id":"string","serial_number":"string","retirement_event_id":"string","issue_date":"2020-01-01","beneficiary_name":"string","end_use":"string","amount":1.0,"unit_type":"string","activity_id":"string","activity_name":"string","operator_id":"string","certification_scheme_id":"string","certification_body_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_certificate":{"type":"object","properties":{"end_use":{"type":"string"},"retirement_event_id":{"type":"string"},"retirement_certificate_id":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"activity_name":{"type":"string"},"certification_body_id":{"type":"string"},"serial_number":{"type":"string"},"beneficiary_name":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"retirement_certificate":{"retirement_certificate_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_certificate_id":"string","serial_number":"string","retirement_event_id":"string","issue_date":"2020-01-01","beneficiary_name":"string","end_use":"string","amount":1.0,"unit_type":"string","activity_id":"string","activity_name":"string","operator_id":"string","certification_scheme_id":"string","certification_body_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Retirement_certificate(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete retirement_certificate by id","description":"<p>Delete retirement_certificate by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_certificate\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteretirement_certificate_ogcr","parameters":[{"name":"retirementcertificateid","in":"path","description":"The RETIREMENTCERTIFICATEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_certificate":{"type":"object","properties":{"end_use":{"type":"string"},"retirement_event_id":{"type":"string"},"retirement_certificate_id":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"activity_name":{"type":"string"},"certification_body_id":{"type":"string"},"serial_number":{"type":"string"},"beneficiary_name":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"retirement_certificate":{"retirement_certificate_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_certificate_id":"string","serial_number":"string","retirement_event_id":"string","issue_date":"2020-01-01","beneficiary_name":"string","end_use":"string","amount":1.0,"unit_type":"string","activity_id":"string","activity_name":"string","operator_id":"string","certification_scheme_id":"string","certification_body_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Retirement_certificate(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update retirement_certificate","description":"<p>Partially update retirement_certificate: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Parsed entity retirement_certificate. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>retirement_certificate_id: (uu)id of the retirement certificate</li>\n<li>serial_number: Unique serial number of the retirement certificate</li>\n<li>retirement_event_id: Reference to the retirement event this certificate is certifying.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_certificate\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchretirement_certificate_ogcr","parameters":[{"name":"retirementcertificateid","in":"path","description":"The RETIREMENTCERTIFICATEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"end_use":{"type":"string"},"retirement_event_id":{"type":"string"},"retirement_certificate_id":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"activity_name":{"type":"string"},"certification_body_id":{"type":"string"},"serial_number":{"type":"string"},"beneficiary_name":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"}}},"example":{"retirement_certificate_id":"string","serial_number":"string","retirement_event_id":"string","issue_date":"2020-01-01","beneficiary_name":"string","end_use":"string","amount":1.0,"unit_type":"string","activity_id":"string","activity_name":"string","operator_id":"string","certification_scheme_id":"string","certification_body_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_certificate":{"type":"object","properties":{"end_use":{"type":"string"},"retirement_event_id":{"type":"string"},"retirement_certificate_id":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"activity_name":{"type":"string"},"certification_body_id":{"type":"string"},"serial_number":{"type":"string"},"beneficiary_name":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"retirement_certificate":{"retirement_certificate_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_certificate_id":"string","serial_number":"string","retirement_event_id":"string","issue_date":"2020-01-01","beneficiary_name":"string","end_use":"string","amount":1.0,"unit_type":"string","activity_id":"string","activity_name":"string","operator_id":"string","certification_scheme_id":"string","certification_body_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/carbon-credit-balance-on-chain/{carboncreditbalanceonchainid}":{"get":{"tags":["_Carbon_credit_balance_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public carbon_credit_balance_on_chain by id","description":"<p>Get Public carbon_credit_balance_on_chain by id.</p>\n<p>Cache of CarbonCredit (ERC-20) balances on the OGCR chain (chain id 20253). One record per holding address, covering both operator wallets and the ERC-6551 token-bound accounts of credit batches. Populated by OGCR-chain-cache, which derives the holder set from Transfer events and then reads each balance at the current head. Balances are current-state, not historical: each record is only true as of block_number.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>balance: CarbonCredit balance in smallest units, as read at block_number. Decimal string because a uint256 does not fit an integer field. Divide by 10^decimals for tonnes CO2e.</li>\n<li>batch_token_id: When holder_type is token_bound_account, the CarbonCreditBatchNFT token id this account belongs to. 0 otherwise. Join to <code>carbon_credit_batch_on_chain</code>.token_id.</li>\n<li>block_number: Block height the balance was read at.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: CarbonCredit ERC-20 contract address the balance was read from.</li>\n<li>decimals: Decimals of the CarbonCredit ERC-20, for rendering balance.</li>\n<li>holder_type: Whether this address is a plain wallet or the ERC-6551 token-bound account of a credit batch. One of: wallet, token_bound_account. A token_bound_account balance is credits still held inside their batch; a wallet balance is credits withdrawn from a batch and now pooled.</li>\n<li>owner_address: Address holding the balance, lowercase-insensitive checksum form. The business key for this record. Match against operator.ogcr_wallet_address or land_manager.ogcr_wallet_address to find a party's holdings.</li>\n<li>symbol: Symbol of the CarbonCredit ERC-20.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"carbon_credit_balance_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePubliccarbon_credit_balance_on_chain_ogcr","parameters":[{"name":"carboncreditbalanceonchainid","in":"path","description":"The CARBONCREDITBALANCEONCHAINID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"carbon_credit_balance_on_chain":{"type":"object","properties":{"balance":{"type":"string"},"owner_address":{"type":"string"},"symbol":{"type":"string"},"carbon_credit_balance_on_chain_id":{"type":"string"},"holder_type":{"type":"string"},"batch_token_id":{"type":"integer"},"block_number":{"type":"integer"},"chain_id":{"type":"integer"},"contract_address":{"type":"string"},"decimals":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"carbon_credit_balance_on_chain":{"carbon_credit_balance_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","balance":"1000000000000000000","batch_token_id":1,"block_number":12400,"chain_id":20253,"contract_address":"0x1B4bC0dE8b6A1A2b3C4d5E6f7A8b9C0d1E2f3A4b","decimals":18,"holder_type":"token_bound_account","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","symbol":"CC"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/liability-choice/{liabilitychoiceid}":{"get":{"tags":["_Liability_choice(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get liability_choice by id","description":"<p>Get liability_choice by id.</p>\n<p>Records which liability mechanism applies to an activity for addressing reversals during its monitoring period. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>liability_choice_id: Internal identifier for the liability choice</li>\n<li>liability_mechanism_type: buffer_pool, insurance or individual_liability</li>\n<li>operator_id: Natural or legal person liable to address reversals (Annex II(s))</li>\n<li>insurance_policy_reference: Policy number. Only if insurance is chosen.</li>\n<li>effective_date: Date from which the mechanism applies</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"liability_choice\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleliability_choice_ogcr","parameters":[{"name":"liabilitychoiceid","in":"path","description":"The LIABILITYCHOICEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"liability_choice":{"type":"object","properties":{"liability_choice_id":{"type":"string"},"liability_mechanism_type":{"type":"string"},"effective_date":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"insurance_policy_reference":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"liability_choice":{"liability_choice_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","liability_choice_id":"string","activity_id":"string","liability_mechanism_type":"string","operator_id":"string","insurance_policy_reference":"string","effective_date":"2020-01-01"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Liability_choice(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update liability_choice","description":"<p>Update liability_choice.</p>\n<p>Records which liability mechanism applies to an activity for addressing reversals during its monitoring period. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>liability_choice_id: Internal identifier for the liability choice</li>\n<li>liability_mechanism_type: buffer_pool, insurance or individual_liability</li>\n<li>operator_id: Natural or legal person liable to address reversals (Annex II(s))</li>\n<li>insurance_policy_reference: Policy number. Only if insurance is chosen.</li>\n<li>effective_date: Date from which the mechanism applies</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"liability_choice\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateliability_choice_ogcr","parameters":[{"name":"liabilitychoiceid","in":"path","description":"The LIABILITYCHOICEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"liability_choice_id":{"type":"string"},"liability_mechanism_type":{"type":"string"},"effective_date":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"insurance_policy_reference":{"type":"string"}}},"example":{"liability_choice_id":"string","activity_id":"string","liability_mechanism_type":"string","operator_id":"string","insurance_policy_reference":"string","effective_date":"2020-01-01"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"liability_choice":{"type":"object","properties":{"liability_choice_id":{"type":"string"},"liability_mechanism_type":{"type":"string"},"effective_date":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"insurance_policy_reference":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"liability_choice":{"liability_choice_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","liability_choice_id":"string","activity_id":"string","liability_mechanism_type":"string","operator_id":"string","insurance_policy_reference":"string","effective_date":"2020-01-01"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Liability_choice(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete liability_choice by id","description":"<p>Delete liability_choice by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"liability_choice\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteliability_choice_ogcr","parameters":[{"name":"liabilitychoiceid","in":"path","description":"The LIABILITYCHOICEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"liability_choice":{"type":"object","properties":{"liability_choice_id":{"type":"string"},"liability_mechanism_type":{"type":"string"},"effective_date":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"insurance_policy_reference":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"liability_choice":{"liability_choice_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","liability_choice_id":"string","activity_id":"string","liability_mechanism_type":"string","operator_id":"string","insurance_policy_reference":"string","effective_date":"2020-01-01"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Liability_choice(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update liability_choice","description":"<p>Partially update liability_choice: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Records which liability mechanism applies to an activity for addressing reversals during its monitoring period. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>liability_choice_id: Internal identifier for the liability choice</li>\n<li>liability_mechanism_type: buffer_pool, insurance or individual_liability</li>\n<li>operator_id: Natural or legal person liable to address reversals (Annex II(s))</li>\n<li>insurance_policy_reference: Policy number. Only if insurance is chosen.</li>\n<li>effective_date: Date from which the mechanism applies</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"liability_choice\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchliability_choice_ogcr","parameters":[{"name":"liabilitychoiceid","in":"path","description":"The LIABILITYCHOICEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"liability_choice_id":{"type":"string"},"liability_mechanism_type":{"type":"string"},"effective_date":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"insurance_policy_reference":{"type":"string"}}},"example":{"liability_choice_id":"string","activity_id":"string","liability_mechanism_type":"string","operator_id":"string","insurance_policy_reference":"string","effective_date":"2020-01-01"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"liability_choice":{"type":"object","properties":{"liability_choice_id":{"type":"string"},"liability_mechanism_type":{"type":"string"},"effective_date":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"insurance_policy_reference":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"liability_choice":{"liability_choice_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","liability_choice_id":"string","activity_id":"string","liability_mechanism_type":"string","operator_id":"string","insurance_policy_reference":"string","effective_date":"2020-01-01"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/certificate-of-compliance/{certificateofcomplianceid}":{"get":{"tags":["_Certificate_of_compliance(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get certificate_of_compliance by id","description":"<p>Get certificate_of_compliance by id.</p>\n<p>\u2018certificate of compliance\u2019 means a conformity statement issued by a certification body certifying that an activity complies with this Regulation;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certificate_of_compliance_id: ID of the certificate of compliance</li>\n<li>certification_scheme_id: ID of the certification scheme</li>\n<li>certification_body_id: ID of the certification body</li>\n<li>activity_id: ID of the activity being certified.</li>\n<li>country_id: Country of issuance</li>\n<li>issue_date: Issuance data</li>\n<li>expiry_date: Expiry date</li>\n<li>carbon_removals_under_baseline: Carbon removals that would have occurred under the baseline, without the activity (CO2e tonnes)</li>\n<li>soil_emissions_under_baseline: Soil emissions that would have occurred under the baseline (CO2e tonnes)</li>\n<li>permanent_net_carbon_removal_benefit: Permanent net carbon removal benefit certified for the activity (CO2e tonnes)</li>\n<li>carbon_farming_temporary_net_carbon_removal_benefit: Temporary net carbon removal benefit from carbon farming certified for the activity (CO2e tonnes)</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: Net soil emission reduction benefit from carbon farming certified for the activity (CO2e tonnes)</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: Temporary net carbon removal benefit from carbon storage in products certified for the activity (CO2e tonnes)</li>\n<li>unit_type: Unit category produced during this activity. (Permanent Removal,<br />\nCarbon Farming Sequestration, Soil Emission Reduction, Carbon Storage in Product)</li>\n<li>certification_status: The status of a certificate. Either \"Certified\" or \"Expired\"</li>\n<li>certification_scheme_rules_and_procedures: Reference to the rules and procedures of the certification scheme under which the certificate was issued</li>\n<li>certification_annual_reports: Reference to the annual reports of the certification scheme</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certificate_of_compliance\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglecertificate_of_compliance_ogcr","parameters":[{"name":"certificateofcomplianceid","in":"path","description":"The CERTIFICATEOFCOMPLIANCEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certificate_of_compliance":{"type":"object","properties":{"certification_annual_reports":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"carbon_removals_under_baseline":{"type":"number"},"certification_scheme_rules_and_procedures":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"number"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"expiry_date":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"certification_status":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"country_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certificate_of_compliance":{"certificate_of_compliance_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certificate_of_compliance_id":"3dece208-c95c-11f0-9041-54e1adfac5b3","certification_scheme_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b2","activity_id":"a_05OFWI037022","audit_report_id":"string","country_id":"DE","issue_date":"2026-12-25","expiry_date":"2031-12-25","carbon_removals_under_baseline":6.5,"soil_emissions_under_baseline":6.5,"permanent_net_carbon_removal_benefit":6.5,"carbon_farming_temporary_net_carbon_removal_benefit":6.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"unit_type":"Carbon Farming Sequestration","certification_status":"Verified","certification_scheme_rules_and_procedures":"https://scheme.example.org/rules-and-procedures-v2.1.pdf","certification_annual_reports":"https://scheme.example.org/annual-report-2026.pdf"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Certificate_of_compliance(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update certificate_of_compliance","description":"<p>Update certificate_of_compliance.</p>\n<p>\u2018certificate of compliance\u2019 means a conformity statement issued by a certification body certifying that an activity complies with this Regulation;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certificate_of_compliance_id: ID of the certificate of compliance</li>\n<li>certification_scheme_id: ID of the certification scheme</li>\n<li>certification_body_id: ID of the certification body</li>\n<li>activity_id: ID of the activity being certified.</li>\n<li>country_id: Country of issuance</li>\n<li>issue_date: Issuance data</li>\n<li>expiry_date: Expiry date</li>\n<li>carbon_removals_under_baseline: Carbon removals that would have occurred under the baseline, without the activity (CO2e tonnes)</li>\n<li>soil_emissions_under_baseline: Soil emissions that would have occurred under the baseline (CO2e tonnes)</li>\n<li>permanent_net_carbon_removal_benefit: Permanent net carbon removal benefit certified for the activity (CO2e tonnes)</li>\n<li>carbon_farming_temporary_net_carbon_removal_benefit: Temporary net carbon removal benefit from carbon farming certified for the activity (CO2e tonnes)</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: Net soil emission reduction benefit from carbon farming certified for the activity (CO2e tonnes)</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: Temporary net carbon removal benefit from carbon storage in products certified for the activity (CO2e tonnes)</li>\n<li>unit_type: Unit category produced during this activity. (Permanent Removal,<br />\nCarbon Farming Sequestration, Soil Emission Reduction, Carbon Storage in Product)</li>\n<li>certification_status: The status of a certificate. Either \"Certified\" or \"Expired\"</li>\n<li>certification_scheme_rules_and_procedures: Reference to the rules and procedures of the certification scheme under which the certificate was issued</li>\n<li>certification_annual_reports: Reference to the annual reports of the certification scheme</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certificate_of_compliance\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updatecertificate_of_compliance_ogcr","parameters":[{"name":"certificateofcomplianceid","in":"path","description":"The CERTIFICATEOFCOMPLIANCEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"certification_annual_reports":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"carbon_removals_under_baseline":{"type":"number"},"certification_scheme_rules_and_procedures":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"number"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"expiry_date":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"certification_status":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"country_id":{"type":"string"}}},"example":{"certificate_of_compliance_id":"3dece208-c95c-11f0-9041-54e1adfac5b3","certification_scheme_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b2","activity_id":"a_05OFWI037022","audit_report_id":"string","country_id":"DE","issue_date":"2026-12-25","expiry_date":"2031-12-25","carbon_removals_under_baseline":6.5,"soil_emissions_under_baseline":6.5,"permanent_net_carbon_removal_benefit":6.5,"carbon_farming_temporary_net_carbon_removal_benefit":6.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"unit_type":"Carbon Farming Sequestration","certification_status":"Verified","certification_scheme_rules_and_procedures":"https://scheme.example.org/rules-and-procedures-v2.1.pdf","certification_annual_reports":"https://scheme.example.org/annual-report-2026.pdf"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certificate_of_compliance":{"type":"object","properties":{"certification_annual_reports":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"carbon_removals_under_baseline":{"type":"number"},"certification_scheme_rules_and_procedures":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"number"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"expiry_date":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"certification_status":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"country_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certificate_of_compliance":{"certificate_of_compliance_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certificate_of_compliance_id":"3dece208-c95c-11f0-9041-54e1adfac5b3","certification_scheme_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b2","activity_id":"a_05OFWI037022","audit_report_id":"string","country_id":"DE","issue_date":"2026-12-25","expiry_date":"2031-12-25","carbon_removals_under_baseline":6.5,"soil_emissions_under_baseline":6.5,"permanent_net_carbon_removal_benefit":6.5,"carbon_farming_temporary_net_carbon_removal_benefit":6.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"unit_type":"Carbon Farming Sequestration","certification_status":"Verified","certification_scheme_rules_and_procedures":"https://scheme.example.org/rules-and-procedures-v2.1.pdf","certification_annual_reports":"https://scheme.example.org/annual-report-2026.pdf"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Certificate_of_compliance(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete certificate_of_compliance by id","description":"<p>Delete certificate_of_compliance by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certificate_of_compliance\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletecertificate_of_compliance_ogcr","parameters":[{"name":"certificateofcomplianceid","in":"path","description":"The CERTIFICATEOFCOMPLIANCEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certificate_of_compliance":{"type":"object","properties":{"certification_annual_reports":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"carbon_removals_under_baseline":{"type":"number"},"certification_scheme_rules_and_procedures":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"number"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"expiry_date":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"certification_status":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"country_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certificate_of_compliance":{"certificate_of_compliance_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certificate_of_compliance_id":"3dece208-c95c-11f0-9041-54e1adfac5b3","certification_scheme_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b2","activity_id":"a_05OFWI037022","audit_report_id":"string","country_id":"DE","issue_date":"2026-12-25","expiry_date":"2031-12-25","carbon_removals_under_baseline":6.5,"soil_emissions_under_baseline":6.5,"permanent_net_carbon_removal_benefit":6.5,"carbon_farming_temporary_net_carbon_removal_benefit":6.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"unit_type":"Carbon Farming Sequestration","certification_status":"Verified","certification_scheme_rules_and_procedures":"https://scheme.example.org/rules-and-procedures-v2.1.pdf","certification_annual_reports":"https://scheme.example.org/annual-report-2026.pdf"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Certificate_of_compliance(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update certificate_of_compliance","description":"<p>Partially update certificate_of_compliance: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>\u2018certificate of compliance\u2019 means a conformity statement issued by a certification body certifying that an activity complies with this Regulation;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certificate_of_compliance_id: ID of the certificate of compliance</li>\n<li>certification_scheme_id: ID of the certification scheme</li>\n<li>certification_body_id: ID of the certification body</li>\n<li>activity_id: ID of the activity being certified.</li>\n<li>country_id: Country of issuance</li>\n<li>issue_date: Issuance data</li>\n<li>expiry_date: Expiry date</li>\n<li>carbon_removals_under_baseline: Carbon removals that would have occurred under the baseline, without the activity (CO2e tonnes)</li>\n<li>soil_emissions_under_baseline: Soil emissions that would have occurred under the baseline (CO2e tonnes)</li>\n<li>permanent_net_carbon_removal_benefit: Permanent net carbon removal benefit certified for the activity (CO2e tonnes)</li>\n<li>carbon_farming_temporary_net_carbon_removal_benefit: Temporary net carbon removal benefit from carbon farming certified for the activity (CO2e tonnes)</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: Net soil emission reduction benefit from carbon farming certified for the activity (CO2e tonnes)</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: Temporary net carbon removal benefit from carbon storage in products certified for the activity (CO2e tonnes)</li>\n<li>unit_type: Unit category produced during this activity. (Permanent Removal,<br />\nCarbon Farming Sequestration, Soil Emission Reduction, Carbon Storage in Product)</li>\n<li>certification_status: The status of a certificate. Either \"Certified\" or \"Expired\"</li>\n<li>certification_scheme_rules_and_procedures: Reference to the rules and procedures of the certification scheme under which the certificate was issued</li>\n<li>certification_annual_reports: Reference to the annual reports of the certification scheme</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certificate_of_compliance\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchcertificate_of_compliance_ogcr","parameters":[{"name":"certificateofcomplianceid","in":"path","description":"The CERTIFICATEOFCOMPLIANCEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"certification_annual_reports":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"carbon_removals_under_baseline":{"type":"number"},"certification_scheme_rules_and_procedures":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"number"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"expiry_date":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"certification_status":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"country_id":{"type":"string"}}},"example":{"certificate_of_compliance_id":"3dece208-c95c-11f0-9041-54e1adfac5b3","certification_scheme_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b2","activity_id":"a_05OFWI037022","audit_report_id":"string","country_id":"DE","issue_date":"2026-12-25","expiry_date":"2031-12-25","carbon_removals_under_baseline":6.5,"soil_emissions_under_baseline":6.5,"permanent_net_carbon_removal_benefit":6.5,"carbon_farming_temporary_net_carbon_removal_benefit":6.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"unit_type":"Carbon Farming Sequestration","certification_status":"Verified","certification_scheme_rules_and_procedures":"https://scheme.example.org/rules-and-procedures-v2.1.pdf","certification_annual_reports":"https://scheme.example.org/annual-report-2026.pdf"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certificate_of_compliance":{"type":"object","properties":{"certification_annual_reports":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"carbon_removals_under_baseline":{"type":"number"},"certification_scheme_rules_and_procedures":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"number"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"expiry_date":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"certification_status":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"country_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certificate_of_compliance":{"certificate_of_compliance_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certificate_of_compliance_id":"3dece208-c95c-11f0-9041-54e1adfac5b3","certification_scheme_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b2","activity_id":"a_05OFWI037022","audit_report_id":"string","country_id":"DE","issue_date":"2026-12-25","expiry_date":"2031-12-25","carbon_removals_under_baseline":6.5,"soil_emissions_under_baseline":6.5,"permanent_net_carbon_removal_benefit":6.5,"carbon_farming_temporary_net_carbon_removal_benefit":6.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"unit_type":"Carbon Farming Sequestration","certification_status":"Verified","certification_scheme_rules_and_procedures":"https://scheme.example.org/rules-and-procedures-v2.1.pdf","certification_annual_reports":"https://scheme.example.org/annual-report-2026.pdf"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/certification-scheme":{"get":{"tags":["_Certification_scheme(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get certification_scheme List","description":"<p>Get certification_scheme List.</p>\n<p>\u2018certification scheme\u2019 means an organisation that certifies the compliance of activities and operators with the quality criteria and certification rules set out in this Regulation;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certification_scheme_id: Unique identifier for certification scheme entity.</li>\n<li>legal_name: Public name of the certification scheme.</li>\n<li>logo: URL or asset reference to a logo image for UI/PDF rendering.</li>\n<li>commission_decision_reference: \"the Commission decision recognising that scheme\"</li>\n<li>certification_methodology: Methodology(ies) the scheme applies (identifier + version).</li>\n<li>scheme_version_number: Scheme rulebook version used for this certification</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_scheme\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>certification_scheme_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getcertification_schemeList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_scheme_list":{"type":"array","items":{"type":"object","properties":{"certification_scheme":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"email":{"type":"string"},"logo":{"type":"string"},"scheme_version_number":{"type":"string"},"legal_name":{"type":"string"},"commission_decision_reference":{"type":"string"},"certification_methodology":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"certification_scheme_list":[{"certification_scheme":{"certification_scheme_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certification_scheme_id":"cs_01HZZ1K0X5F6Q7R8S9T0","legal_name":"CRCF Scheme","logo":"https://cdn.example.org/logos/dnv.png","email":"string","commission_decision_reference":"Commission Decision C(2026)1234","certification_methodology":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","scheme_version_number":"v1.3"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Certification_scheme(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new certification_scheme","description":"<p>Create new certification_scheme.</p>\n<p>\u2018certification scheme\u2019 means an organisation that certifies the compliance of activities and operators with the quality criteria and certification rules set out in this Regulation;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certification_scheme_id: Unique identifier for certification scheme entity.</li>\n<li>legal_name: Public name of the certification scheme.</li>\n<li>logo: URL or asset reference to a logo image for UI/PDF rendering.</li>\n<li>commission_decision_reference: \"the Commission decision recognising that scheme\"</li>\n<li>certification_methodology: Methodology(ies) the scheme applies (identifier + version).</li>\n<li>scheme_version_number: Scheme rulebook version used for this certification</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_scheme\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createcertification_scheme_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"email":{"type":"string"},"logo":{"type":"string"},"scheme_version_number":{"type":"string"},"legal_name":{"type":"string"},"commission_decision_reference":{"type":"string"},"certification_methodology":{"type":"string"}}},"example":{"certification_scheme_id":"cs_01HZZ1K0X5F6Q7R8S9T0","legal_name":"CRCF Scheme","logo":"https://cdn.example.org/logos/dnv.png","email":"string","commission_decision_reference":"Commission Decision C(2026)1234","certification_methodology":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","scheme_version_number":"v1.3"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_scheme":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"email":{"type":"string"},"logo":{"type":"string"},"scheme_version_number":{"type":"string"},"legal_name":{"type":"string"},"commission_decision_reference":{"type":"string"},"certification_methodology":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certification_scheme":{"certification_scheme_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certification_scheme_id":"cs_01HZZ1K0X5F6Q7R8S9T0","legal_name":"CRCF Scheme","logo":"https://cdn.example.org/logos/dnv.png","email":"string","commission_decision_reference":"Commission Decision C(2026)1234","certification_methodology":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","scheme_version_number":"v1.3"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/certificate-of-compliance-on-chain":{"get":{"tags":["_Certificate_of_compliance_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get certificate_of_compliance_on_chain List","description":"<p>Get certificate_of_compliance_on_chain List.</p>\n<p>For data from the block chain about about an activity. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certificate_of_compliance_id: Links to the <code>parcel</code> dynamic entity. The on-chain NFT is keyed by this id.</li>\n<li>certification_body_id: ID of the certification body</li>\n<li>token_id: CarbonProjectNFT token id minted for this parcel.</li>\n<li>minted_at: On-chain block timestamp (mintedAt) from projectData, unix seconds.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>contract_address: CarbonProjectNFT contract address the token was read from.</li>\n<li>chain_id: EVM chain id (OGCR chain = 2025).</li>\n<li>tx_hash: Mint transaction hash (from the CarbonProjectMinted</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>country_id: Country of issuance</li>\n<li>issue_date: Issuance data</li>\n<li>expiry_date: Expiry date</li>\n<li>carbon_removals_under_baseline: Carbon removals that would have occurred under the baseline, without the activity (CO2e tonnes)</li>\n<li>soil_emissions_under_baseline: Soil emissions that would have occurred under the baseline (CO2e tonnes)</li>\n<li>permanent_net_carbon_removal_benefit: Permanent net carbon removal benefit certified for the activity (CO2e tonnes)</li>\n<li>carbon_farming_temporary_net_carbon_removal_benefit: Temporary net carbon removal benefit from carbon farming certified for the activity (CO2e tonnes)</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: Net soil emission reduction benefit from carbon farming certified for the activity (CO2e tonnes)</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: Temporary net carbon removal benefit from carbon storage in products certified for the activity (CO2e tonnes)</li>\n<li>certification_status: Status of the certificate as stored on-chain. Either \"Certified\" or \"Expired\"</li>\n<li>certification_scheme_rules_and_procedures: Reference to the rules and procedures of the certification scheme under which the certificate was issued</li>\n<li>certification_annual_reports: Reference to the annual reports of the certification scheme</li>\n<li>activity_id: ID of the activity being certified.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certificate_of_compliance_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>audit_report_id</code>, <code>certificate_of_compliance_id</code>, <code>certification_body_id</code>, <code>chain_id</code>, <code>country_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>activity_id</code> → <code>activity</code>, <code>audit_report_id</code> → <code>audit_report</code>, <code>certificate_of_compliance_id</code> → <code>certificate_of_compliance</code>, <code>certification_body_id</code> → <code>certification_body</code>, <code>country_id</code> → <code>country</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getcertificate_of_compliance_on_chainList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certificate_of_compliance_on_chain_list":{"type":"array","items":{"type":"object","properties":{"certificate_of_compliance_on_chain":{"type":"object","properties":{"certification_annual_reports":{"type":"string"},"minted_at":{"type":"integer"},"token_uri":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"carbon_removals_under_baseline":{"type":"number"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"certification_scheme_rules_and_procedures":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"number"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"block_number":{"type":"integer"},"certificate_of_compliance_on_chain_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"token_id":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"contract_address":{"type":"string"},"certification_status":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"country_id":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"certificate_of_compliance_on_chain_list":[{"certificate_of_compliance_on_chain":{"certificate_of_compliance_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certificate_of_compliance_id":"string","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b2","audit_report_id":"string","token_id":"parcel_AB12CD34EF","minted_at":1779280448,"owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","token_uri":"data:application/json;base64,eyJuYW1lIjoiQ2FyYm9uIn0=","contract_address":"0xeec918d74c746167564401103096D45BbD494B74","chain_id":2025,"tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","block_number":12345,"country_id":"DE","issue_date":"2026-12-25","expiry_date":"2031-12-25","carbon_removals_under_baseline":5.5,"soil_emissions_under_baseline":5.5,"permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":5.5,"carbon_storage_temporary_net_carbon_removal_benefit":5.5,"certification_status":"Certified","certification_scheme_rules_and_procedures":"https://scheme.example.org/rules-and-procedures-v2.1.pdf","certification_annual_reports":"https://scheme.example.org/annual-report-2026.pdf","activity_id":"a_05OFWI037022"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Certificate_of_compliance_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new certificate_of_compliance_on_chain","description":"<p>Create new certificate_of_compliance_on_chain.</p>\n<p>For data from the block chain about about an activity. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certificate_of_compliance_id: Links to the <code>parcel</code> dynamic entity. The on-chain NFT is keyed by this id.</li>\n<li>certification_body_id: ID of the certification body</li>\n<li>token_id: CarbonProjectNFT token id minted for this parcel.</li>\n<li>minted_at: On-chain block timestamp (mintedAt) from projectData, unix seconds.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>contract_address: CarbonProjectNFT contract address the token was read from.</li>\n<li>chain_id: EVM chain id (OGCR chain = 2025).</li>\n<li>tx_hash: Mint transaction hash (from the CarbonProjectMinted</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>country_id: Country of issuance</li>\n<li>issue_date: Issuance data</li>\n<li>expiry_date: Expiry date</li>\n<li>carbon_removals_under_baseline: Carbon removals that would have occurred under the baseline, without the activity (CO2e tonnes)</li>\n<li>soil_emissions_under_baseline: Soil emissions that would have occurred under the baseline (CO2e tonnes)</li>\n<li>permanent_net_carbon_removal_benefit: Permanent net carbon removal benefit certified for the activity (CO2e tonnes)</li>\n<li>carbon_farming_temporary_net_carbon_removal_benefit: Temporary net carbon removal benefit from carbon farming certified for the activity (CO2e tonnes)</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: Net soil emission reduction benefit from carbon farming certified for the activity (CO2e tonnes)</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: Temporary net carbon removal benefit from carbon storage in products certified for the activity (CO2e tonnes)</li>\n<li>certification_status: Status of the certificate as stored on-chain. Either \"Certified\" or \"Expired\"</li>\n<li>certification_scheme_rules_and_procedures: Reference to the rules and procedures of the certification scheme under which the certificate was issued</li>\n<li>certification_annual_reports: Reference to the annual reports of the certification scheme</li>\n<li>activity_id: ID of the activity being certified.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certificate_of_compliance_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createcertificate_of_compliance_on_chain_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"certification_annual_reports":{"type":"string"},"minted_at":{"type":"integer"},"token_uri":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"carbon_removals_under_baseline":{"type":"number"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"certification_scheme_rules_and_procedures":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"number"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"block_number":{"type":"integer"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"token_id":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"contract_address":{"type":"string"},"certification_status":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"country_id":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"}}},"example":{"certificate_of_compliance_id":"string","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b2","audit_report_id":"string","token_id":"parcel_AB12CD34EF","minted_at":1779280448,"owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","token_uri":"data:application/json;base64,eyJuYW1lIjoiQ2FyYm9uIn0=","contract_address":"0xeec918d74c746167564401103096D45BbD494B74","chain_id":2025,"tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","block_number":12345,"country_id":"DE","issue_date":"2026-12-25","expiry_date":"2031-12-25","carbon_removals_under_baseline":5.5,"soil_emissions_under_baseline":5.5,"permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":5.5,"carbon_storage_temporary_net_carbon_removal_benefit":5.5,"certification_status":"Certified","certification_scheme_rules_and_procedures":"https://scheme.example.org/rules-and-procedures-v2.1.pdf","certification_annual_reports":"https://scheme.example.org/annual-report-2026.pdf","activity_id":"a_05OFWI037022"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certificate_of_compliance_on_chain":{"type":"object","properties":{"certification_annual_reports":{"type":"string"},"minted_at":{"type":"integer"},"token_uri":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"carbon_removals_under_baseline":{"type":"number"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"certification_scheme_rules_and_procedures":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"number"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"block_number":{"type":"integer"},"certificate_of_compliance_on_chain_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"token_id":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"contract_address":{"type":"string"},"certification_status":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"country_id":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certificate_of_compliance_on_chain":{"certificate_of_compliance_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certificate_of_compliance_id":"string","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b2","audit_report_id":"string","token_id":"parcel_AB12CD34EF","minted_at":1779280448,"owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","token_uri":"data:application/json;base64,eyJuYW1lIjoiQ2FyYm9uIn0=","contract_address":"0xeec918d74c746167564401103096D45BbD494B74","chain_id":2025,"tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","block_number":12345,"country_id":"DE","issue_date":"2026-12-25","expiry_date":"2031-12-25","carbon_removals_under_baseline":5.5,"soil_emissions_under_baseline":5.5,"permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":5.5,"carbon_storage_temporary_net_carbon_removal_benefit":5.5,"certification_status":"Certified","certification_scheme_rules_and_procedures":"https://scheme.example.org/rules-and-procedures-v2.1.pdf","certification_annual_reports":"https://scheme.example.org/annual-report-2026.pdf","activity_id":"a_05OFWI037022"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/ogcr-dynamicentities-log":{"get":{"tags":["_Ogcr_dynamicentities_log(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get ogcr_dynamicentities_log List","description":"<p>Get ogcr_dynamicentities_log List.</p>\n<p>Audit log of OGCR dynamic-entity data creation: one record per created object or failed create, capturing how each of its reference fields resolved.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>event_type: One of entity_created, entity_failed.</li>\n<li>entity_name: Name of the dynamic entity the event concerns.</li>\n<li>entity_id: Id of the created object, when known.</li>\n<li>status: success or error.</li>\n<li>message: Human-readable detail or error text.</li>\n<li>references: List of every reference: field on this entity and how it resolved. Each item has <code>field</code>, <code>target</code>, <code>resolution</code> (resolved = a real created id was used; fallback = the spreadsheet example value was used) and the <code>value</code> posted.</li>\n<li>timestamp: UTC ISO-8601 time the event was recorded.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"ogcr_dynamicentities_log\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p><em>(no fields on this entity are declared <code>indexed</code>, so only the legacy bare-parameter filter below is available.)</em></p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getogcr_dynamicentities_logList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"ogcr_dynamicentities_log_list":{"type":"array","items":{"type":"object","properties":{"ogcr_dynamicentities_log":{"type":"object","properties":{"timestamp":{"type":"string"},"entity_id":{"type":"string"},"references":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"target":{"type":"string"},"resolution":{"type":"string"},"value":{"type":"string"}}}},"entity_name":{"type":"string"},"event_type":{"type":"string"},"status":{"type":"string"},"message":{"type":"string"},"ogcr_dynamicentities_log_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"ogcr_dynamicentities_log_list":[{"ogcr_dynamicentities_log":{"ogcr_dynamicentities_log_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","event_type":"entity_created","entity_name":"operator","entity_id":"a8770fca-3d1d-47af-b6d0-7a6c3f124388","status":"success","message":"Created operator","references":[{"field":"operator_id","target":"operator","resolution":"resolved","value":"a8770fca-3d1d-47af-b6d0-7a6c3f124388"},{"field":"bank_account_id","target":"BankAccount","resolution":"fallback","value":"sample-account-id"}],"timestamp":"2026-06-24T12:00:00Z"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Ogcr_dynamicentities_log(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new ogcr_dynamicentities_log","description":"<p>Create new ogcr_dynamicentities_log.</p>\n<p>Audit log of OGCR dynamic-entity data creation: one record per created object or failed create, capturing how each of its reference fields resolved.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>event_type: One of entity_created, entity_failed.</li>\n<li>entity_name: Name of the dynamic entity the event concerns.</li>\n<li>entity_id: Id of the created object, when known.</li>\n<li>status: success or error.</li>\n<li>message: Human-readable detail or error text.</li>\n<li>references: List of every reference: field on this entity and how it resolved. Each item has <code>field</code>, <code>target</code>, <code>resolution</code> (resolved = a real created id was used; fallback = the spreadsheet example value was used) and the <code>value</code> posted.</li>\n<li>timestamp: UTC ISO-8601 time the event was recorded.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"ogcr_dynamicentities_log\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createogcr_dynamicentities_log_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"string"},"entity_id":{"type":"string"},"message":{"type":"string"},"references":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"target":{"type":"string"},"resolution":{"type":"string"},"value":{"type":"string"}}}},"entity_name":{"type":"string"},"event_type":{"type":"string"},"status":{"type":"string"}}},"example":{"event_type":"entity_created","entity_name":"operator","entity_id":"a8770fca-3d1d-47af-b6d0-7a6c3f124388","status":"success","message":"Created operator","references":[{"field":"operator_id","target":"operator","resolution":"resolved","value":"a8770fca-3d1d-47af-b6d0-7a6c3f124388"},{"field":"bank_account_id","target":"BankAccount","resolution":"fallback","value":"sample-account-id"}],"timestamp":"2026-06-24T12:00:00Z"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"ogcr_dynamicentities_log":{"type":"object","properties":{"timestamp":{"type":"string"},"entity_id":{"type":"string"},"references":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"target":{"type":"string"},"resolution":{"type":"string"},"value":{"type":"string"}}}},"entity_name":{"type":"string"},"event_type":{"type":"string"},"status":{"type":"string"},"message":{"type":"string"},"ogcr_dynamicentities_log_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"ogcr_dynamicentities_log":{"ogcr_dynamicentities_log_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","event_type":"entity_created","entity_name":"operator","entity_id":"a8770fca-3d1d-47af-b6d0-7a6c3f124388","status":"success","message":"Created operator","references":[{"field":"operator_id","target":"operator","resolution":"resolved","value":"a8770fca-3d1d-47af-b6d0-7a6c3f124388"},{"field":"bank_account_id","target":"BankAccount","resolution":"fallback","value":"sample-account-id"}],"timestamp":"2026-06-24T12:00:00Z"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/activity-verification":{"get":{"tags":["_Activity_verification(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get activity_verification List","description":"<p>Get activity_verification List.</p>\n<p>This is the initial certification done by the certifier scheme and auditors. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>parcel_id: (uu)id of the parcel that gets verified</li>\n<li>activity_id: ID of the project this parcel belongs to</li>\n<li>status_code: in_progress, verified, failed</li>\n<li>status_message: further explanation of status code</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: expected amount of CO2e tonnes removed or reduced</li>\n<li>supporting_document_id: Supporting documents for activity verification</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_verification\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>activity_verification_id</code>, <code>parcel_id</code>, <code>status_code</code>, <code>supporting_document_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>activity_id</code> → <code>activity</code>, <code>parcel_id</code> → <code>parcel</code>, <code>supporting_document_id</code> → <code>supporting_document</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getactivity_verificationList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_verification_list":{"type":"array","items":{"type":"object","properties":{"activity_verification":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"activity_verification_id":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"status_code":{"type":"string"},"activity_id":{"type":"string"},"status_message":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"parcel_id":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"activity_verification_list":[{"activity_verification":{"activity_verification_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_verification_id":"string","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","activity_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","status_code":"verified","status_message":"could not find owner","permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":5.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"supporting_document_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Activity_verification(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new activity_verification","description":"<p>Create new activity_verification.</p>\n<p>This is the initial certification done by the certifier scheme and auditors. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>parcel_id: (uu)id of the parcel that gets verified</li>\n<li>activity_id: ID of the project this parcel belongs to</li>\n<li>status_code: in_progress, verified, failed</li>\n<li>status_message: further explanation of status code</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: expected amount of CO2e tonnes removed or reduced</li>\n<li>supporting_document_id: Supporting documents for activity verification</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_verification\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createactivity_verification_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"activity_verification_id":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"status_code":{"type":"string"},"activity_id":{"type":"string"},"status_message":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"parcel_id":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"}}},"example":{"activity_verification_id":"string","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","activity_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","status_code":"verified","status_message":"could not find owner","permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":5.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"supporting_document_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_verification":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"activity_verification_id":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"status_code":{"type":"string"},"activity_id":{"type":"string"},"status_message":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"parcel_id":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_verification":{"activity_verification_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_verification_id":"string","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","activity_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","status_code":"verified","status_message":"could not find owner","permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":5.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"supporting_document_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/activity-verification/{activityverificationid}":{"get":{"tags":["_Activity_verification(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get activity_verification by id","description":"<p>Get activity_verification by id.</p>\n<p>This is the initial certification done by the certifier scheme and auditors. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>parcel_id: (uu)id of the parcel that gets verified</li>\n<li>activity_id: ID of the project this parcel belongs to</li>\n<li>status_code: in_progress, verified, failed</li>\n<li>status_message: further explanation of status code</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: expected amount of CO2e tonnes removed or reduced</li>\n<li>supporting_document_id: Supporting documents for activity verification</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_verification\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleactivity_verification_ogcr","parameters":[{"name":"activityverificationid","in":"path","description":"The ACTIVITYVERIFICATIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_verification":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"activity_verification_id":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"status_code":{"type":"string"},"activity_id":{"type":"string"},"status_message":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"parcel_id":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_verification":{"activity_verification_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_verification_id":"string","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","activity_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","status_code":"verified","status_message":"could not find owner","permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":5.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"supporting_document_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Activity_verification(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update activity_verification","description":"<p>Update activity_verification.</p>\n<p>This is the initial certification done by the certifier scheme and auditors. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>parcel_id: (uu)id of the parcel that gets verified</li>\n<li>activity_id: ID of the project this parcel belongs to</li>\n<li>status_code: in_progress, verified, failed</li>\n<li>status_message: further explanation of status code</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: expected amount of CO2e tonnes removed or reduced</li>\n<li>supporting_document_id: Supporting documents for activity verification</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_verification\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateactivity_verification_ogcr","parameters":[{"name":"activityverificationid","in":"path","description":"The ACTIVITYVERIFICATIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"activity_verification_id":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"status_code":{"type":"string"},"activity_id":{"type":"string"},"status_message":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"parcel_id":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"}}},"example":{"activity_verification_id":"string","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","activity_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","status_code":"verified","status_message":"could not find owner","permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":5.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"supporting_document_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_verification":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"activity_verification_id":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"status_code":{"type":"string"},"activity_id":{"type":"string"},"status_message":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"parcel_id":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_verification":{"activity_verification_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_verification_id":"string","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","activity_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","status_code":"verified","status_message":"could not find owner","permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":5.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"supporting_document_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Activity_verification(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete activity_verification by id","description":"<p>Delete activity_verification by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_verification\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteactivity_verification_ogcr","parameters":[{"name":"activityverificationid","in":"path","description":"The ACTIVITYVERIFICATIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_verification":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"activity_verification_id":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"status_code":{"type":"string"},"activity_id":{"type":"string"},"status_message":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"parcel_id":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_verification":{"activity_verification_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_verification_id":"string","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","activity_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","status_code":"verified","status_message":"could not find owner","permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":5.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"supporting_document_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Activity_verification(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update activity_verification","description":"<p>Partially update activity_verification: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>This is the initial certification done by the certifier scheme and auditors. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>parcel_id: (uu)id of the parcel that gets verified</li>\n<li>activity_id: ID of the project this parcel belongs to</li>\n<li>status_code: in_progress, verified, failed</li>\n<li>status_message: further explanation of status code</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: expected amount of CO2e tonnes removed or reduced</li>\n<li>supporting_document_id: Supporting documents for activity verification</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_verification\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchactivity_verification_ogcr","parameters":[{"name":"activityverificationid","in":"path","description":"The ACTIVITYVERIFICATIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"activity_verification_id":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"status_code":{"type":"string"},"activity_id":{"type":"string"},"status_message":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"parcel_id":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"}}},"example":{"activity_verification_id":"string","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","activity_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","status_code":"verified","status_message":"could not find owner","permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":5.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"supporting_document_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_verification":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"activity_verification_id":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"status_code":{"type":"string"},"activity_id":{"type":"string"},"status_message":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"parcel_id":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_verification":{"activity_verification_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_verification_id":"string","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","activity_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","status_code":"verified","status_message":"could not find owner","permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":5.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"supporting_document_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/reversal-event":{"get":{"tags":["_Reversal_event(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get reversal_event List","description":"<p>Get reversal_event List.</p>\n<p>\u2018certificate of compliance\u2019 means a conformity statement issued by a certification body certifying that an activity complies with this Regulation;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>reversal_event_id: Internal identifier for the reversal event</li>\n<li>activity_id: Activity the reversal traces back to</li>\n<li>parcel_id: Parcel(s) affected by the reversal, if reversal is parcel-specific rather than activity-wide</li>\n<li>monitoring_period_id: Monitoring period during which the reversal occurred (Art. 6(2)(a) ties mitigation rules to the monitoring period)</li>\n<li>token_id: The minted unit(s)/token(s) affected \u2014 feeds the state transition to Invalidated/Revoked</li>\n<li>quantity_reversed_tco2e: Amount of carbon released back to the atmosphere, quantified conservatively per Art. 4(12)</li>\n<li>reversal_cause: Cause of the reversal (fire, drought, tillage/ploughing, land-use change, pest/disease, other)</li>\n<li>voluntary_flag: Whether the reversal was voluntary, involuntary, or undetermined (Recital 22 distinction)</li>\n<li>occurrence_date: Date the reversal actually happened</li>\n<li>detected_date: Date the reversal was detected/reported</li>\n<li>detection_source: Who/what detected it (self-report, monitoring system, certifier audit, third-party)</li>\n<li>status_code: Workflow status of the reversal case</li>\n<li>liability_choice_id: Which liability mechanism applies (buffer pool / individual liability / insurance) \u2014 Art. 6(2)(b)</li>\n<li>buffer_pool_drawdown_amount: Amount drawn from the buffer pool to cover the reversal, if applicable</li>\n<li>units_cancelled: Reference(s) to units directly cancelled as last resort (Art. 6(3)(i))</li>\n<li>verification_body_id: Certification body that confirmed the reversal</li>\n<li>audit_report_id: Audit report documenting confirmation of the reversal</li>\n<li>certification_methodology_reference: Which methodology's reversal/liability rules governed this case</li>\n<li>corrective_measures: Remediation actions required/taken</li>\n<li>on_chain_tx_hash: Transaction hash of the invalidation/cancellation event on-chain</li>\n<li>created_at: Record creation timestamp</li>\n<li>updated_at: Last update timestamp</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"reversal_event\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>audit_report_id</code>, <code>liability_choice_id</code>, <code>monitoring_period_id</code>, <code>parcel_id</code>, <code>reversal_event_id</code>, <code>status_code</code>, <code>verification_body_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>activity_id</code> → <code>activity</code>, <code>audit_report_id</code> → <code>audit_report</code>, <code>liability_choice_id</code> → <code>liability_choice</code>, <code>monitoring_period_id</code> → <code>monitoring_plan</code>, <code>parcel_id</code> → <code>parcel</code>, <code>verification_body_id</code> → <code>certification_body</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getreversal_eventList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"reversal_event_list":{"type":"array","items":{"type":"object","properties":{"reversal_event":{"type":"object","properties":{"buffer_pool_drawdown_amount":{"type":"number"},"liability_choice_id":{"type":"string"},"on_chain_tx_hash":{"type":"string"},"verification_body_id":{"type":"string"},"voluntary_flag":{"type":"string"},"certification_methodology_reference":{"type":"string"},"reversal_cause":{"type":"string"},"monitoring_period_id":{"type":"string"},"corrective_measures":{"type":"string"},"parcel_id":{"type":"string"},"updated_at":{"type":"string"},"status_code":{"type":"string"},"quantity_reversed_tco2e":{"type":"number"},"units_cancelled":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"string"},"reversal_event_id":{"type":"string"},"created_at":{"type":"string"},"audit_report_id":{"type":"string"},"detected_date":{"type":"string"},"occurrence_date":{"type":"string"},"detection_source":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"reversal_event_list":[{"reversal_event":{"reversal_event_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","reversal_event_id":"rev_01HZZ2P3Q4R5S6T7U8V9","activity_id":"a_05OFWI037022","parcel_id":"parcel_03OGNWO397234DQ","monitoring_period_id":"mp_01HZYW8C9R7P4D2A6K1TQ3","token_id":"0xAb58...token_id_42","quantity_reversed_tco2e":6.0,"reversal_cause":"fire","voluntary_flag":"involuntary","occurrence_date":"2028-06-14","detected_date":"2028-06-20","detection_source":"monitoring_system","status_code":"reported / under_review / confirmed / liability_applied / resolved","liability_choice_id":"lc_01HZZ3...","buffer_pool_drawdown_amount":6.0,"units_cancelled":"0xAb58...token_id_42","verification_body_id":"cb_01HZZ1M2A3B4C5D6E7F8","audit_report_id":"ar_01HZZ4...","certification_methodology_reference":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","corrective_measures":"Re-establishment of cover crop, revised monitoring frequency","on_chain_tx_hash":"0x8f2a...c91e","created_at":"2028-06-20","updated_at":"2028-07-01"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Reversal_event(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new reversal_event","description":"<p>Create new reversal_event.</p>\n<p>\u2018certificate of compliance\u2019 means a conformity statement issued by a certification body certifying that an activity complies with this Regulation;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>reversal_event_id: Internal identifier for the reversal event</li>\n<li>activity_id: Activity the reversal traces back to</li>\n<li>parcel_id: Parcel(s) affected by the reversal, if reversal is parcel-specific rather than activity-wide</li>\n<li>monitoring_period_id: Monitoring period during which the reversal occurred (Art. 6(2)(a) ties mitigation rules to the monitoring period)</li>\n<li>token_id: The minted unit(s)/token(s) affected \u2014 feeds the state transition to Invalidated/Revoked</li>\n<li>quantity_reversed_tco2e: Amount of carbon released back to the atmosphere, quantified conservatively per Art. 4(12)</li>\n<li>reversal_cause: Cause of the reversal (fire, drought, tillage/ploughing, land-use change, pest/disease, other)</li>\n<li>voluntary_flag: Whether the reversal was voluntary, involuntary, or undetermined (Recital 22 distinction)</li>\n<li>occurrence_date: Date the reversal actually happened</li>\n<li>detected_date: Date the reversal was detected/reported</li>\n<li>detection_source: Who/what detected it (self-report, monitoring system, certifier audit, third-party)</li>\n<li>status_code: Workflow status of the reversal case</li>\n<li>liability_choice_id: Which liability mechanism applies (buffer pool / individual liability / insurance) \u2014 Art. 6(2)(b)</li>\n<li>buffer_pool_drawdown_amount: Amount drawn from the buffer pool to cover the reversal, if applicable</li>\n<li>units_cancelled: Reference(s) to units directly cancelled as last resort (Art. 6(3)(i))</li>\n<li>verification_body_id: Certification body that confirmed the reversal</li>\n<li>audit_report_id: Audit report documenting confirmation of the reversal</li>\n<li>certification_methodology_reference: Which methodology's reversal/liability rules governed this case</li>\n<li>corrective_measures: Remediation actions required/taken</li>\n<li>on_chain_tx_hash: Transaction hash of the invalidation/cancellation event on-chain</li>\n<li>created_at: Record creation timestamp</li>\n<li>updated_at: Last update timestamp</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"reversal_event\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createreversal_event_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"buffer_pool_drawdown_amount":{"type":"number"},"liability_choice_id":{"type":"string"},"on_chain_tx_hash":{"type":"string"},"verification_body_id":{"type":"string"},"voluntary_flag":{"type":"string"},"certification_methodology_reference":{"type":"string"},"reversal_cause":{"type":"string"},"monitoring_period_id":{"type":"string"},"corrective_measures":{"type":"string"},"parcel_id":{"type":"string"},"updated_at":{"type":"string"},"status_code":{"type":"string"},"quantity_reversed_tco2e":{"type":"number"},"units_cancelled":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"string"},"reversal_event_id":{"type":"string"},"created_at":{"type":"string"},"audit_report_id":{"type":"string"},"detected_date":{"type":"string"},"occurrence_date":{"type":"string"},"detection_source":{"type":"string"}}},"example":{"reversal_event_id":"rev_01HZZ2P3Q4R5S6T7U8V9","activity_id":"a_05OFWI037022","parcel_id":"parcel_03OGNWO397234DQ","monitoring_period_id":"mp_01HZYW8C9R7P4D2A6K1TQ3","token_id":"0xAb58...token_id_42","quantity_reversed_tco2e":6.0,"reversal_cause":"fire","voluntary_flag":"involuntary","occurrence_date":"2028-06-14","detected_date":"2028-06-20","detection_source":"monitoring_system","status_code":"reported / under_review / confirmed / liability_applied / resolved","liability_choice_id":"lc_01HZZ3...","buffer_pool_drawdown_amount":6.0,"units_cancelled":"0xAb58...token_id_42","verification_body_id":"cb_01HZZ1M2A3B4C5D6E7F8","audit_report_id":"ar_01HZZ4...","certification_methodology_reference":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","corrective_measures":"Re-establishment of cover crop, revised monitoring frequency","on_chain_tx_hash":"0x8f2a...c91e","created_at":"2028-06-20","updated_at":"2028-07-01"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"reversal_event":{"type":"object","properties":{"buffer_pool_drawdown_amount":{"type":"number"},"liability_choice_id":{"type":"string"},"on_chain_tx_hash":{"type":"string"},"verification_body_id":{"type":"string"},"voluntary_flag":{"type":"string"},"certification_methodology_reference":{"type":"string"},"reversal_cause":{"type":"string"},"monitoring_period_id":{"type":"string"},"corrective_measures":{"type":"string"},"parcel_id":{"type":"string"},"updated_at":{"type":"string"},"status_code":{"type":"string"},"quantity_reversed_tco2e":{"type":"number"},"units_cancelled":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"string"},"reversal_event_id":{"type":"string"},"created_at":{"type":"string"},"audit_report_id":{"type":"string"},"detected_date":{"type":"string"},"occurrence_date":{"type":"string"},"detection_source":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"reversal_event":{"reversal_event_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","reversal_event_id":"rev_01HZZ2P3Q4R5S6T7U8V9","activity_id":"a_05OFWI037022","parcel_id":"parcel_03OGNWO397234DQ","monitoring_period_id":"mp_01HZYW8C9R7P4D2A6K1TQ3","token_id":"0xAb58...token_id_42","quantity_reversed_tco2e":6.0,"reversal_cause":"fire","voluntary_flag":"involuntary","occurrence_date":"2028-06-14","detected_date":"2028-06-20","detection_source":"monitoring_system","status_code":"reported / under_review / confirmed / liability_applied / resolved","liability_choice_id":"lc_01HZZ3...","buffer_pool_drawdown_amount":6.0,"units_cancelled":"0xAb58...token_id_42","verification_body_id":"cb_01HZZ1M2A3B4C5D6E7F8","audit_report_id":"ar_01HZZ4...","certification_methodology_reference":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","corrective_measures":"Re-establishment of cover crop, revised monitoring frequency","on_chain_tx_hash":"0x8f2a...c91e","created_at":"2028-06-20","updated_at":"2028-07-01"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/activity/{activityid}":{"get":{"tags":["_Activity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public activity by id","description":"<p>Get Public activity by id.</p>\n<p>\u2018activity\u2019 means one or more practices or processes carried out by an operator, or a group of operators, resulting in a permanent/temporary carbon removal through carbon farming or carbon storage in products, or soil emission reductions. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_id: Internal identifier for the activity</li>\n<li>name: Human-readable activity name shown in UI and exports.</li>\n<li>summary: 1\u20132 sentence public summary, used in Activity listing.</li>\n<li>description: Longer narrative description (scope, intent, participants, context).</li>\n<li>website: Public URL with activity/operator details</li>\n<li>hero_image: Primary image URL for hero image</li>\n<li>image: Primary image URL or asset reference for UI cards.</li>\n<li>operator_id: Internal identifier for the operator entity</li>\n<li>activity_type: Activity category, based on technologies, practices and processes. (CARBON_FARMING, PERMANENT_REMOVAL, CARBON_STORAGE_IN_PRODUCTS)</li>\n<li>unit_types: Unit category that will be produced during this activity. (Permanent Removal,<br />\nCarbon Farming Sequestration, Soil Emission Reduction, Carbon Storage in Product)</li>\n<li>city: Primary city/municipality associated with the activity</li>\n<li>country_id: ISO 3166-1 alpha-2 country code for where the activity occurs.</li>\n<li>multipolygon_coordinates: GeoJSON MultiPolygon boundary of the activity area.</li>\n<li>start_date: Start date of the activity implementation period (when practices/process begin).</li>\n<li>end_date: End date of the activity implementation period.</li>\n<li>term_commitment: Commitment/contract duration for maintaining practices.</li>\n<li>cobenefits: Declared co-benefits</li>\n<li>methodologies: Methodology IDs/names and versions used to quantify outcomes</li>\n<li>monitoring_period_years: Planned monitoring duration in years</li>\n<li>monitoring_period_start_date: Start date of the monitoring window used for MRV/accounting</li>\n<li>monitoring_period_end_date: End date of the monitoring window</li>\n<li>certification_scheme_id: ID of the certification scheme chosen by the operator.</li>\n<li>internal_note: An internal note that will not be displayed to the public</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePublicactivity_ogcr","parameters":[{"name":"activityid","in":"path","description":"The ACTIVITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity":{"type":"object","properties":{"name":{"type":"string"},"start_date":{"type":"string"},"certification_scheme_id":{"type":"string"},"methodologies":{"type":"string"},"image":{"type":"string"},"description":{"type":"string"},"cobenefits":{"type":"string"},"internal_note":{"type":"string"},"multipolygon_coordinates":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"array","maxItems":2,"minItems":2,"items":{"type":"number"}}}}}}},"activity_type":{"type":"string"},"hero_image":{"type":"string"},"monitoring_period_end_date":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"summary":{"type":"string"},"website":{"type":"string"},"city":{"type":"string"},"term_commitment":{"type":"integer"},"end_date":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"unit_types":{"type":"string"},"monitoring_period_years":{"type":"integer"},"country_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"activity":{"activity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"a_05OFWI037022","name":"Brandenburg Regenerative Wheat","summary":"Wheat rotation adopting cover crops and reduced tillage across enrolled parcels.","description":"This activity aggregates multiple parcels under a single operator to monitor practice changes and estimate carbon stock change over the monitoring period.","website":"https://example.org/activities/brandenburg-wheat","hero_image":"https://cdn.example.org/activity-images/activity_123.png","image":"https://cdn.example.org/activity-images/activity_123.png","operator_id":"op_01JS0347FKH","activity_type":"CARBON_FARMING","unit_types":"Soil Emission Reduction","city":"Seelow","country_id":"DE","multipolygon_coordinates":{"type":"MultiPolygon","coordinates":[[[[14.3801,52.5201],[14.3901,52.5201],[14.3901,52.5301],[14.3801,52.5301],[14.3801,52.5201]]]]},"start_date":"2027-01-01","end_date":"2031-12-31","term_commitment":5,"cobenefits":"[\"biodiversity\", \"water_quality\", \"soil_health\"]","methodologies":"[{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}]","monitoring_period_years":5,"monitoring_period_start_date":"2027-01-01","monitoring_period_end_date":"2031-12-31","certification_scheme_id":"CRCF Scheme","internal_note":"I'm flagging this for review"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/monitoring-plan/{monitoringplanid}":{"get":{"tags":["_Monitoring_plan(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get monitoring_plan by id","description":"<p>Get monitoring_plan by id.</p>\n<p>Parsed entity monitoring_plan. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>monitoring_plan_id: Unique identifier for monitoring plan entity</li>\n<li>date_submitted: Date/time the monitoring plan was submitted. Created by system.</li>\n<li>monitored_data_parameters: List of parameters to be collected/computed during monitoring (should be structured, each with name, unit, and scope).</li>\n<li>monitoring_frequency: How often each parameter is monitored (months)</li>\n<li>emission_sources_and_sinks: Emission sources and sinks</li>\n<li>data_source: Where the monitored data comes from (field sampling, remote sensing, farm management system, invoices, IoT).</li>\n<li>measurement_methods_procedures_accuracy_calibration: Measurement methods and procedures (accuracy and calibration)</li>\n<li>quality_assessment_or_quality_control_procedures: Quality assessment or quality control procedures</li>\n<li>responsibility_for_collection_and_archiving: Responsibility for collection and archiving</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"monitoring_plan\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglemonitoring_plan_ogcr","parameters":[{"name":"monitoringplanid","in":"path","description":"The MONITORINGPLANID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"monitoring_plan":{"type":"object","properties":{"emission_sources_and_sinks":{"type":"string"},"monitoring_frequency":{"type":"integer"},"monitored_data_parameters":{"type":"string"},"date_submitted":{"type":"string"},"responsibility_for_collection_and_archiving":{"type":"string"},"activity_id":{"type":"string"},"quality_assessment_or_quality_control_procedures":{"type":"string"},"monitoring_plan_id":{"type":"string"},"measurement_methods_procedures_accuracy_calibration":{"type":"string"},"data_source":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"monitoring_plan":{"monitoring_plan_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","monitoring_plan_id":"mp_01HZYW8C9R7P4D2A6K1TQ3","date_submitted":"2026-11-20","activity_id":"string","monitored_data_parameters":"[{\"name\": \"soc_percent\", \"unit\": \"%\", \"scope\": \"soil_0_30cm\"}, {\"name\": \"bulk_density\", \"unit\": \"g/cm3\", \"scope\": \"soil_0_30cm\"}, {\"name\": \"yield\", \"unit\": \"t/ha\", \"scope\": \"crop_wheat\"}]","monitoring_frequency":12,"emission_sources_and_sinks":"Sources: fertiliser use, machinery fuel. Sinks: soil organic carbon in the 0-30 cm layer","data_source":"Field soil sampling, remote sensing (NDVI), farm management system records","measurement_methods_procedures_accuracy_calibration":"Soil cores analysed by dry combustion (accuracy ±0.1% SOC), lab equipment calibrated annually","quality_assessment_or_quality_control_procedures":"Duplicate samples for 10% of plots; lab results checked against certified reference material","responsibility_for_collection_and_archiving":"Farm manager collects the data; operator archives it for 10 years"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Monitoring_plan(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update monitoring_plan","description":"<p>Update monitoring_plan.</p>\n<p>Parsed entity monitoring_plan. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>monitoring_plan_id: Unique identifier for monitoring plan entity</li>\n<li>date_submitted: Date/time the monitoring plan was submitted. Created by system.</li>\n<li>monitored_data_parameters: List of parameters to be collected/computed during monitoring (should be structured, each with name, unit, and scope).</li>\n<li>monitoring_frequency: How often each parameter is monitored (months)</li>\n<li>emission_sources_and_sinks: Emission sources and sinks</li>\n<li>data_source: Where the monitored data comes from (field sampling, remote sensing, farm management system, invoices, IoT).</li>\n<li>measurement_methods_procedures_accuracy_calibration: Measurement methods and procedures (accuracy and calibration)</li>\n<li>quality_assessment_or_quality_control_procedures: Quality assessment or quality control procedures</li>\n<li>responsibility_for_collection_and_archiving: Responsibility for collection and archiving</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"monitoring_plan\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updatemonitoring_plan_ogcr","parameters":[{"name":"monitoringplanid","in":"path","description":"The MONITORINGPLANID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"emission_sources_and_sinks":{"type":"string"},"monitoring_frequency":{"type":"integer"},"monitored_data_parameters":{"type":"string"},"date_submitted":{"type":"string"},"responsibility_for_collection_and_archiving":{"type":"string"},"activity_id":{"type":"string"},"quality_assessment_or_quality_control_procedures":{"type":"string"},"monitoring_plan_id":{"type":"string"},"measurement_methods_procedures_accuracy_calibration":{"type":"string"},"data_source":{"type":"string"}}},"example":{"monitoring_plan_id":"mp_01HZYW8C9R7P4D2A6K1TQ3","date_submitted":"2026-11-20","activity_id":"string","monitored_data_parameters":"[{\"name\": \"soc_percent\", \"unit\": \"%\", \"scope\": \"soil_0_30cm\"}, {\"name\": \"bulk_density\", \"unit\": \"g/cm3\", \"scope\": \"soil_0_30cm\"}, {\"name\": \"yield\", \"unit\": \"t/ha\", \"scope\": \"crop_wheat\"}]","monitoring_frequency":12,"emission_sources_and_sinks":"Sources: fertiliser use, machinery fuel. Sinks: soil organic carbon in the 0-30 cm layer","data_source":"Field soil sampling, remote sensing (NDVI), farm management system records","measurement_methods_procedures_accuracy_calibration":"Soil cores analysed by dry combustion (accuracy ±0.1% SOC), lab equipment calibrated annually","quality_assessment_or_quality_control_procedures":"Duplicate samples for 10% of plots; lab results checked against certified reference material","responsibility_for_collection_and_archiving":"Farm manager collects the data; operator archives it for 10 years"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"monitoring_plan":{"type":"object","properties":{"emission_sources_and_sinks":{"type":"string"},"monitoring_frequency":{"type":"integer"},"monitored_data_parameters":{"type":"string"},"date_submitted":{"type":"string"},"responsibility_for_collection_and_archiving":{"type":"string"},"activity_id":{"type":"string"},"quality_assessment_or_quality_control_procedures":{"type":"string"},"monitoring_plan_id":{"type":"string"},"measurement_methods_procedures_accuracy_calibration":{"type":"string"},"data_source":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"monitoring_plan":{"monitoring_plan_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","monitoring_plan_id":"mp_01HZYW8C9R7P4D2A6K1TQ3","date_submitted":"2026-11-20","activity_id":"string","monitored_data_parameters":"[{\"name\": \"soc_percent\", \"unit\": \"%\", \"scope\": \"soil_0_30cm\"}, {\"name\": \"bulk_density\", \"unit\": \"g/cm3\", \"scope\": \"soil_0_30cm\"}, {\"name\": \"yield\", \"unit\": \"t/ha\", \"scope\": \"crop_wheat\"}]","monitoring_frequency":12,"emission_sources_and_sinks":"Sources: fertiliser use, machinery fuel. Sinks: soil organic carbon in the 0-30 cm layer","data_source":"Field soil sampling, remote sensing (NDVI), farm management system records","measurement_methods_procedures_accuracy_calibration":"Soil cores analysed by dry combustion (accuracy ±0.1% SOC), lab equipment calibrated annually","quality_assessment_or_quality_control_procedures":"Duplicate samples for 10% of plots; lab results checked against certified reference material","responsibility_for_collection_and_archiving":"Farm manager collects the data; operator archives it for 10 years"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Monitoring_plan(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete monitoring_plan by id","description":"<p>Delete monitoring_plan by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"monitoring_plan\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletemonitoring_plan_ogcr","parameters":[{"name":"monitoringplanid","in":"path","description":"The MONITORINGPLANID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"monitoring_plan":{"type":"object","properties":{"emission_sources_and_sinks":{"type":"string"},"monitoring_frequency":{"type":"integer"},"monitored_data_parameters":{"type":"string"},"date_submitted":{"type":"string"},"responsibility_for_collection_and_archiving":{"type":"string"},"activity_id":{"type":"string"},"quality_assessment_or_quality_control_procedures":{"type":"string"},"monitoring_plan_id":{"type":"string"},"measurement_methods_procedures_accuracy_calibration":{"type":"string"},"data_source":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"monitoring_plan":{"monitoring_plan_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","monitoring_plan_id":"mp_01HZYW8C9R7P4D2A6K1TQ3","date_submitted":"2026-11-20","activity_id":"string","monitored_data_parameters":"[{\"name\": \"soc_percent\", \"unit\": \"%\", \"scope\": \"soil_0_30cm\"}, {\"name\": \"bulk_density\", \"unit\": \"g/cm3\", \"scope\": \"soil_0_30cm\"}, {\"name\": \"yield\", \"unit\": \"t/ha\", \"scope\": \"crop_wheat\"}]","monitoring_frequency":12,"emission_sources_and_sinks":"Sources: fertiliser use, machinery fuel. Sinks: soil organic carbon in the 0-30 cm layer","data_source":"Field soil sampling, remote sensing (NDVI), farm management system records","measurement_methods_procedures_accuracy_calibration":"Soil cores analysed by dry combustion (accuracy ±0.1% SOC), lab equipment calibrated annually","quality_assessment_or_quality_control_procedures":"Duplicate samples for 10% of plots; lab results checked against certified reference material","responsibility_for_collection_and_archiving":"Farm manager collects the data; operator archives it for 10 years"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Monitoring_plan(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update monitoring_plan","description":"<p>Partially update monitoring_plan: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Parsed entity monitoring_plan. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>monitoring_plan_id: Unique identifier for monitoring plan entity</li>\n<li>date_submitted: Date/time the monitoring plan was submitted. Created by system.</li>\n<li>monitored_data_parameters: List of parameters to be collected/computed during monitoring (should be structured, each with name, unit, and scope).</li>\n<li>monitoring_frequency: How often each parameter is monitored (months)</li>\n<li>emission_sources_and_sinks: Emission sources and sinks</li>\n<li>data_source: Where the monitored data comes from (field sampling, remote sensing, farm management system, invoices, IoT).</li>\n<li>measurement_methods_procedures_accuracy_calibration: Measurement methods and procedures (accuracy and calibration)</li>\n<li>quality_assessment_or_quality_control_procedures: Quality assessment or quality control procedures</li>\n<li>responsibility_for_collection_and_archiving: Responsibility for collection and archiving</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"monitoring_plan\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchmonitoring_plan_ogcr","parameters":[{"name":"monitoringplanid","in":"path","description":"The MONITORINGPLANID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"emission_sources_and_sinks":{"type":"string"},"monitoring_frequency":{"type":"integer"},"monitored_data_parameters":{"type":"string"},"date_submitted":{"type":"string"},"responsibility_for_collection_and_archiving":{"type":"string"},"activity_id":{"type":"string"},"quality_assessment_or_quality_control_procedures":{"type":"string"},"monitoring_plan_id":{"type":"string"},"measurement_methods_procedures_accuracy_calibration":{"type":"string"},"data_source":{"type":"string"}}},"example":{"monitoring_plan_id":"mp_01HZYW8C9R7P4D2A6K1TQ3","date_submitted":"2026-11-20","activity_id":"string","monitored_data_parameters":"[{\"name\": \"soc_percent\", \"unit\": \"%\", \"scope\": \"soil_0_30cm\"}, {\"name\": \"bulk_density\", \"unit\": \"g/cm3\", \"scope\": \"soil_0_30cm\"}, {\"name\": \"yield\", \"unit\": \"t/ha\", \"scope\": \"crop_wheat\"}]","monitoring_frequency":12,"emission_sources_and_sinks":"Sources: fertiliser use, machinery fuel. Sinks: soil organic carbon in the 0-30 cm layer","data_source":"Field soil sampling, remote sensing (NDVI), farm management system records","measurement_methods_procedures_accuracy_calibration":"Soil cores analysed by dry combustion (accuracy ±0.1% SOC), lab equipment calibrated annually","quality_assessment_or_quality_control_procedures":"Duplicate samples for 10% of plots; lab results checked against certified reference material","responsibility_for_collection_and_archiving":"Farm manager collects the data; operator archives it for 10 years"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"monitoring_plan":{"type":"object","properties":{"emission_sources_and_sinks":{"type":"string"},"monitoring_frequency":{"type":"integer"},"monitored_data_parameters":{"type":"string"},"date_submitted":{"type":"string"},"responsibility_for_collection_and_archiving":{"type":"string"},"activity_id":{"type":"string"},"quality_assessment_or_quality_control_procedures":{"type":"string"},"monitoring_plan_id":{"type":"string"},"measurement_methods_procedures_accuracy_calibration":{"type":"string"},"data_source":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"monitoring_plan":{"monitoring_plan_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","monitoring_plan_id":"mp_01HZYW8C9R7P4D2A6K1TQ3","date_submitted":"2026-11-20","activity_id":"string","monitored_data_parameters":"[{\"name\": \"soc_percent\", \"unit\": \"%\", \"scope\": \"soil_0_30cm\"}, {\"name\": \"bulk_density\", \"unit\": \"g/cm3\", \"scope\": \"soil_0_30cm\"}, {\"name\": \"yield\", \"unit\": \"t/ha\", \"scope\": \"crop_wheat\"}]","monitoring_frequency":12,"emission_sources_and_sinks":"Sources: fertiliser use, machinery fuel. Sinks: soil organic carbon in the 0-30 cm layer","data_source":"Field soil sampling, remote sensing (NDVI), farm management system records","measurement_methods_procedures_accuracy_calibration":"Soil cores analysed by dry combustion (accuracy ±0.1% SOC), lab equipment calibrated annually","quality_assessment_or_quality_control_procedures":"Duplicate samples for 10% of plots; lab results checked against certified reference material","responsibility_for_collection_and_archiving":"Farm manager collects the data; operator archives it for 10 years"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/co-benefits":{"get":{"tags":["_Co_benefits(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public co_benefits List","description":"<p>Get Public co_benefits List.</p>\n<p>Parsed entity co_benefits. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"co_benefits\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p><em>(no fields on this entity are declared <code>indexed</code>, so only the legacy bare-parameter filter below is available.)</em></p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPublicco_benefitsList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"co_benefits_list":{"type":"array","items":{"type":"object","properties":{"co_benefits":{"type":"object","properties":{"co_benefits_id":{"type":"string"},"co_benefit_id":{"type":"string"},"co_benefit_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"co_benefits_list":[{"co_benefits":{"co_benefits_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","co_benefit_id":"string","co_benefit_name":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/public/activity-sustainable-development-goal":{"get":{"tags":["_Activity_sustainable_development_goal(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public activity_sustainable_development_goal List","description":"<p>Get Public activity_sustainable_development_goal List.</p>\n<p>Entity for listing sustainable development goals being addressed by an activity. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_sustainable_development_goal\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>sustainable_development_goal_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPublicactivity_sustainable_development_goalList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_sustainable_development_goal_list":{"type":"array","items":{"type":"object","properties":{"activity_sustainable_development_goal":{"type":"object","properties":{"activity_sustainable_development_goal_id":{"type":"string"},"activity_id":{"type":"string"},"sustainable_development_goal_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"activity_sustainable_development_goal_list":[{"activity_sustainable_development_goal":{"activity_sustainable_development_goal_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","sustainable_development_goal_id":"CLIMATE_ACTION"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/public/carbon-credit-batch-on-chain":{"get":{"tags":["_Carbon_credit_batch_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public carbon_credit_batch_on_chain List","description":"<p>Get Public carbon_credit_batch_on_chain List.</p>\n<p>Cache of CarbonCreditBatchNFT data minted on the OGCR chain (chain id 20253). One record per carbon_credit_batch_id: the units of one unit type issued for an activity over one monitoring period. Each batch owns an ERC-6551 token-bound account that holds its CarbonCredit (ERC-20) balance. Populated by OGCR-chain-cache reading the chain. Join to <code>activity_on_chain</code> on activity_id (or activity_nft_id = token_id) to reach the OBP activity.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_hash: activity_hash stored on-chain: keccak256 of the raw activity entity body.</li>\n<li>activity_id: activity_id this batch was issued for, as stored on-chain.</li>\n<li>activity_name: Activity name as stored on-chain.</li>\n<li>activity_nft_id: ActivityNFT token id this batch was issued against. Join to <code>activity_on_chain</code>.token_id to reach the OBP activity_id.</li>\n<li>activity_url: activity_url stored on-chain: link back to the OBP activity entity.</li>\n<li>amount: Units issued for the batch, fixed at mint, in CarbonCredit base units (18 decimals): 6.5 tonnes is 6500000000000000000. Decimal string because a uint256 does not fit an integer field. The live balance is credit_balance.</li>\n<li>batch_name: Display name of the batch by unit type, as stored on-chain.</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>block_number_balance: Block height the credit_balance was read at. Unlike the mint fields, the balance is current-state, not historical, so it is only true as of this block.</li>\n<li>carbon_credit_batch_id: Business key for this record, as stored on-chain. The contract permits one batch token per id (tokenIdByBatchId), so it is used to match records for upsert.</li>\n<li>certificate_of_compliance_hash: certificate_of_compliance_hash stored on-chain: keccak256 of the raw certificate_of_compliance entity body.</li>\n<li>certificate_of_compliance_uri: certificate_of_compliance_uri stored on-chain: link back to the OBP certificate_of_compliance entity.</li>\n<li>certification_body_hash: certification_body_hash stored on-chain: keccak256 of the raw certification body entity body.</li>\n<li>certification_body_url: certification_body_url stored on-chain: link back to the OBP certification body entity.</li>\n<li>certification_scheme_hash: certification_scheme_hash stored on-chain: keccak256 of the raw certification scheme entity body.</li>\n<li>certification_scheme_url: certification_scheme_url stored on-chain: link back to the OBP certification_scheme entity.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: CarbonCreditBatchNFT contract address the token was read from.</li>\n<li>country_id: Country id as stored on-chain.</li>\n<li>credit_balance: CarbonCredit (ERC-20) balance held by token_bound_account, in smallest units, as read at block_number_balance. Decimal string because a uint256 does not fit an integer field. Divide by 10^credit_decimals for tonnes CO2e. Empty when no CarbonCredit contract address is configured.</li>\n<li>credit_contract_address: CarbonCredit ERC-20 contract address the balance was read from.</li>\n<li>credit_decimals: Decimals of the CarbonCredit ERC-20, for rendering credit_balance. 0 when no CarbonCredit contract address is configured.</li>\n<li>expiry_date: Batch expiry date as stored on-chain.</li>\n<li>issue_date: Batch issue date as stored on-chain.</li>\n<li>monitoring_period_end_date: Monitoring period end date as stored on-chain.</li>\n<li>monitoring_period_start_date: Monitoring period start date as stored on-chain.</li>\n<li>operator_hash: operator_hash stored on-chain: keccak256 of the raw operator entity body.</li>\n<li>operator_url: operator_url stored on-chain: link back to the OBP operator entity.</li>\n<li>owner_address: Current owner of the batch NFT (operator OGCR wallet address). Owning the NFT gates the right to move the credits held in its token-bound account.</li>\n<li>status_code: Batch status as stored on-chain.</li>\n<li>token_bound_account: ERC-6551 token-bound account for this batch. This address holds the batch's CarbonCredit (ERC-20) balance.</li>\n<li>token_id: CarbonCreditBatchNFT token id, unique per contract. Records are matched on carbon_credit_batch_id rather than this, so that the match uses a string field.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI, rendered on-chain from the batch data).</li>\n<li>tx_hash: Mint transaction hash (from the BatchMinted event).</li>\n<li>unit_type: CRCF unit type this batch represents, as stored on-chain.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"carbon_credit_batch_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p><em>(no fields on this entity are declared <code>indexed</code>, so only the legacy bare-parameter filter below is available.)</em></p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPubliccarbon_credit_batch_on_chainList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"carbon_credit_batch_on_chain_list":{"type":"array","items":{"type":"object","properties":{"carbon_credit_batch_on_chain":{"type":"object","properties":{"activity_nft_id":{"type":"integer"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"block_number_balance":{"type":"integer"},"contract_address":{"type":"string"},"operator_hash":{"type":"string"},"carbon_credit_batch_on_chain_id":{"type":"string"},"unit_type":{"type":"string"},"credit_contract_address":{"type":"string"},"token_uri":{"type":"string"},"certificate_of_compliance_hash":{"type":"string"},"status_code":{"type":"string"},"credit_decimals":{"type":"integer"},"monitoring_period_end_date":{"type":"string"},"amount":{"type":"string"},"issue_date":{"type":"string"},"certificate_of_compliance_uri":{"type":"string"},"activity_url":{"type":"string"},"token_bound_account":{"type":"string"},"certification_scheme_hash":{"type":"string"},"certification_scheme_url":{"type":"string"},"certification_body_url":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"integer"},"activity_name":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"batch_name":{"type":"string"},"operator_url":{"type":"string"},"activity_hash":{"type":"string"},"block_number":{"type":"integer"},"carbon_credit_batch_id":{"type":"string"},"country_id":{"type":"string"},"certification_body_hash":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"},"credit_balance":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"carbon_credit_batch_on_chain_list":[{"carbon_credit_batch_on_chain":{"carbon_credit_batch_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_name":"Reforestation 2024","activity_nft_id":1,"activity_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/activity/activity_AB12CD34EF","amount":"6500000000000000000","batch_name":"Permanent Removals Carbon Credit Batch","block_number":12345,"block_number_balance":12400,"carbon_credit_batch_id":"verification_AB12:permanent_removal","certificate_of_compliance_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certificate_of_compliance_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certificate_of_compliance/coc_AB12CD34EF","certification_body_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_body_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/certification_body/body_VERRA","certification_scheme_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_scheme_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/certification_scheme/scheme_SALUS","chain_id":20253,"contract_address":"0x38cF23C52Bb4B13F051Aec09580a2dE845a7FA35","country_id":"DK","credit_balance":"1000000000000000000","credit_contract_address":"0x1B4bC0dE8b6A1A2b3C4d5E6f7A8b9C0d1E2f3A4b","credit_decimals":18,"expiry_date":"2030-01-01","issue_date":"2025-01-01","monitoring_period_end_date":"2024-12-31","monitoring_period_start_date":"2024-01-01","operator_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","operator_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/operator/op_01JS0347FKH","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","status_code":"issued","token_bound_account":"0x9F2fCc7C4E1C0eA0dB1A0EbD79b0Cc7Ee4c3e5a1","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQmF0Y2gifQ==","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_type":"Permanent Removal"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/activity-monitoring-period-verification/{activitymonitoringperiodverificationid}":{"get":{"tags":["_Activity_monitoring_period_verification(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get activity_monitoring_period_verification by id","description":"<p>Get activity_monitoring_period_verification by id.</p>\n<p>Parsed entity activity_monitoring_period_verification. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_id: ID of the project verified</li>\n<li>certificate_of_compliance_id: ID of the certificate</li>\n<li>activity_plan_id: ID of the activity plan</li>\n<li>monitoring_plan_id: ID of the monitoring plan</li>\n<li>status_code: in_progress, verified, failed</li>\n<li>start_date: Start date of the monitoring period</li>\n<li>end_date: End date of the monitoring period</li>\n<li>status_message: further explanation of status code</li>\n<li>permanent_net_carbon_removal_benefit: Confirmed amount of CO2e tonnes removed under permanent removals</li>\n<li>carbon_farming_temporary_net_carbon_removal_benefit: Confirmed amount of CO2e tonnes removed under carbon farming temporary practices</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: Confirmed amount of CO2e tonnes reduced under soil emission reductions</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: Confirmed amount of CO2e tonnes removed or reduced</li>\n<li>buffer_contribution_pct: Percentage of units to send to buffer pool. Only if liability_choice connected to activity is equal to buffer_pool</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_monitoring_period_verification\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleactivity_monitoring_period_verification_ogcr","parameters":[{"name":"activitymonitoringperiodverificationid","in":"path","description":"The ACTIVITYMONITORINGPERIODVERIFICATIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_monitoring_period_verification":{"type":"object","properties":{"activity_monitoring_period_verification_id":{"type":"string"},"start_date":{"type":"string"},"activity_plan_id":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"buffer_contribution_pct":{"type":"integer"},"status_code":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"activity_id":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"monitoring_plan_id":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"end_date":{"type":"string"},"status_message":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_monitoring_period_verification":{"activity_monitoring_period_verification_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_monitoring_period_verification_id":"string","activity_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certificate_of_compliance_id":"string","activity_plan_id":"string","monitoring_plan_id":"string","status_code":"verified","start_date":"2020-01-01","end_date":"2020-01-01","status_message":"Reversal occurred","permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"buffer_contribution_pct":5},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Activity_monitoring_period_verification(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update activity_monitoring_period_verification","description":"<p>Update activity_monitoring_period_verification.</p>\n<p>Parsed entity activity_monitoring_period_verification. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_id: ID of the project verified</li>\n<li>certificate_of_compliance_id: ID of the certificate</li>\n<li>activity_plan_id: ID of the activity plan</li>\n<li>monitoring_plan_id: ID of the monitoring plan</li>\n<li>status_code: in_progress, verified, failed</li>\n<li>start_date: Start date of the monitoring period</li>\n<li>end_date: End date of the monitoring period</li>\n<li>status_message: further explanation of status code</li>\n<li>permanent_net_carbon_removal_benefit: Confirmed amount of CO2e tonnes removed under permanent removals</li>\n<li>carbon_farming_temporary_net_carbon_removal_benefit: Confirmed amount of CO2e tonnes removed under carbon farming temporary practices</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: Confirmed amount of CO2e tonnes reduced under soil emission reductions</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: Confirmed amount of CO2e tonnes removed or reduced</li>\n<li>buffer_contribution_pct: Percentage of units to send to buffer pool. Only if liability_choice connected to activity is equal to buffer_pool</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_monitoring_period_verification\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateactivity_monitoring_period_verification_ogcr","parameters":[{"name":"activitymonitoringperiodverificationid","in":"path","description":"The ACTIVITYMONITORINGPERIODVERIFICATIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"activity_monitoring_period_verification_id":{"type":"string"},"start_date":{"type":"string"},"activity_plan_id":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"buffer_contribution_pct":{"type":"integer"},"status_code":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"activity_id":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"monitoring_plan_id":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"end_date":{"type":"string"},"status_message":{"type":"string"}}},"example":{"activity_monitoring_period_verification_id":"string","activity_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certificate_of_compliance_id":"string","activity_plan_id":"string","monitoring_plan_id":"string","status_code":"verified","start_date":"2020-01-01","end_date":"2020-01-01","status_message":"Reversal occurred","permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"buffer_contribution_pct":5}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_monitoring_period_verification":{"type":"object","properties":{"activity_monitoring_period_verification_id":{"type":"string"},"start_date":{"type":"string"},"activity_plan_id":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"buffer_contribution_pct":{"type":"integer"},"status_code":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"activity_id":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"monitoring_plan_id":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"end_date":{"type":"string"},"status_message":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_monitoring_period_verification":{"activity_monitoring_period_verification_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_monitoring_period_verification_id":"string","activity_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certificate_of_compliance_id":"string","activity_plan_id":"string","monitoring_plan_id":"string","status_code":"verified","start_date":"2020-01-01","end_date":"2020-01-01","status_message":"Reversal occurred","permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"buffer_contribution_pct":5},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Activity_monitoring_period_verification(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete activity_monitoring_period_verification by id","description":"<p>Delete activity_monitoring_period_verification by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_monitoring_period_verification\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteactivity_monitoring_period_verification_ogcr","parameters":[{"name":"activitymonitoringperiodverificationid","in":"path","description":"The ACTIVITYMONITORINGPERIODVERIFICATIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_monitoring_period_verification":{"type":"object","properties":{"activity_monitoring_period_verification_id":{"type":"string"},"start_date":{"type":"string"},"activity_plan_id":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"buffer_contribution_pct":{"type":"integer"},"status_code":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"activity_id":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"monitoring_plan_id":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"end_date":{"type":"string"},"status_message":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_monitoring_period_verification":{"activity_monitoring_period_verification_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_monitoring_period_verification_id":"string","activity_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certificate_of_compliance_id":"string","activity_plan_id":"string","monitoring_plan_id":"string","status_code":"verified","start_date":"2020-01-01","end_date":"2020-01-01","status_message":"Reversal occurred","permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"buffer_contribution_pct":5},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Activity_monitoring_period_verification(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update activity_monitoring_period_verification","description":"<p>Partially update activity_monitoring_period_verification: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Parsed entity activity_monitoring_period_verification. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_id: ID of the project verified</li>\n<li>certificate_of_compliance_id: ID of the certificate</li>\n<li>activity_plan_id: ID of the activity plan</li>\n<li>monitoring_plan_id: ID of the monitoring plan</li>\n<li>status_code: in_progress, verified, failed</li>\n<li>start_date: Start date of the monitoring period</li>\n<li>end_date: End date of the monitoring period</li>\n<li>status_message: further explanation of status code</li>\n<li>permanent_net_carbon_removal_benefit: Confirmed amount of CO2e tonnes removed under permanent removals</li>\n<li>carbon_farming_temporary_net_carbon_removal_benefit: Confirmed amount of CO2e tonnes removed under carbon farming temporary practices</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: Confirmed amount of CO2e tonnes reduced under soil emission reductions</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: Confirmed amount of CO2e tonnes removed or reduced</li>\n<li>buffer_contribution_pct: Percentage of units to send to buffer pool. Only if liability_choice connected to activity is equal to buffer_pool</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_monitoring_period_verification\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchactivity_monitoring_period_verification_ogcr","parameters":[{"name":"activitymonitoringperiodverificationid","in":"path","description":"The ACTIVITYMONITORINGPERIODVERIFICATIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"activity_monitoring_period_verification_id":{"type":"string"},"start_date":{"type":"string"},"activity_plan_id":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"buffer_contribution_pct":{"type":"integer"},"status_code":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"activity_id":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"monitoring_plan_id":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"end_date":{"type":"string"},"status_message":{"type":"string"}}},"example":{"activity_monitoring_period_verification_id":"string","activity_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certificate_of_compliance_id":"string","activity_plan_id":"string","monitoring_plan_id":"string","status_code":"verified","start_date":"2020-01-01","end_date":"2020-01-01","status_message":"Reversal occurred","permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"buffer_contribution_pct":5}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_monitoring_period_verification":{"type":"object","properties":{"activity_monitoring_period_verification_id":{"type":"string"},"start_date":{"type":"string"},"activity_plan_id":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"buffer_contribution_pct":{"type":"integer"},"status_code":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"activity_id":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"monitoring_plan_id":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"end_date":{"type":"string"},"status_message":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_monitoring_period_verification":{"activity_monitoring_period_verification_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_monitoring_period_verification_id":"string","activity_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certificate_of_compliance_id":"string","activity_plan_id":"string","monitoring_plan_id":"string","status_code":"verified","start_date":"2020-01-01","end_date":"2020-01-01","status_message":"Reversal occurred","permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"buffer_contribution_pct":5},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/activity-technologies-practices-processes":{"get":{"tags":["_Activity_technologies_practices_processes(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get activity_technologies_practices_processes List","description":"<p>Get activity_technologies_practices_processes List.</p>\n<p>This is the intersecting entity showing what technologies and practices are being carried out on a certain activity. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_technologies_practices_processes\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>technologies_practices_processes_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>activity_id</code> → <code>activity</code>, <code>technologies_practices_processes_id</code> → <code>technologies_practices_processes</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getactivity_technologies_practices_processesList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_technologies_practices_processes_list":{"type":"array","items":{"type":"object","properties":{"activity_technologies_practices_processes":{"type":"object","properties":{"activity_technologies_practices_processes_id":{"type":"string"},"activity_id":{"type":"string"},"technologies_practices_processes_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"activity_technologies_practices_processes_list":[{"activity_technologies_practices_processes":{"activity_technologies_practices_processes_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","technologies_practices_processes_id":"NO_TILL"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Activity_technologies_practices_processes(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new activity_technologies_practices_processes","description":"<p>Create new activity_technologies_practices_processes.</p>\n<p>This is the intersecting entity showing what technologies and practices are being carried out on a certain activity. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_technologies_practices_processes\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createactivity_technologies_practices_processes_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"activity_id":{"type":"string"},"technologies_practices_processes_id":{"type":"string"}}},"example":{"activity_id":"string","technologies_practices_processes_id":"NO_TILL"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_technologies_practices_processes":{"type":"object","properties":{"activity_technologies_practices_processes_id":{"type":"string"},"activity_id":{"type":"string"},"technologies_practices_processes_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_technologies_practices_processes":{"activity_technologies_practices_processes_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","technologies_practices_processes_id":"NO_TILL"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/activity-sustainable-development-goal":{"get":{"tags":["_Activity_sustainable_development_goal(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get activity_sustainable_development_goal List","description":"<p>Get activity_sustainable_development_goal List.</p>\n<p>Entity for listing sustainable development goals being addressed by an activity. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_sustainable_development_goal\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>sustainable_development_goal_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>activity_id</code> → <code>activity</code>, <code>sustainable_development_goal_id</code> → <code>sustainable_development_goal</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getactivity_sustainable_development_goalList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_sustainable_development_goal_list":{"type":"array","items":{"type":"object","properties":{"activity_sustainable_development_goal":{"type":"object","properties":{"activity_sustainable_development_goal_id":{"type":"string"},"activity_id":{"type":"string"},"sustainable_development_goal_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"activity_sustainable_development_goal_list":[{"activity_sustainable_development_goal":{"activity_sustainable_development_goal_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","sustainable_development_goal_id":"CLIMATE_ACTION"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Activity_sustainable_development_goal(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new activity_sustainable_development_goal","description":"<p>Create new activity_sustainable_development_goal.</p>\n<p>Entity for listing sustainable development goals being addressed by an activity. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_sustainable_development_goal\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createactivity_sustainable_development_goal_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"activity_id":{"type":"string"},"sustainable_development_goal_id":{"type":"string"}}},"example":{"activity_id":"string","sustainable_development_goal_id":"CLIMATE_ACTION"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_sustainable_development_goal":{"type":"object","properties":{"activity_sustainable_development_goal_id":{"type":"string"},"activity_id":{"type":"string"},"sustainable_development_goal_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_sustainable_development_goal":{"activity_sustainable_development_goal_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","sustainable_development_goal_id":"CLIMATE_ACTION"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/supervisory-non-conformity":{"get":{"tags":["_Supervisory_non_conformity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get supervisory_non_conformity List","description":"<p>Get supervisory_non_conformity List.</p>\n<p>\u2018non-conformity\u2019 means a failure by an operator or a certification body to comply with the rules and procedures, established by the certification scheme, of which they are members or under which they operate. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>category: critical, major and minor</li>\n<li>remediation_timeline: Timeline for remediation of non-conformities</li>\n<li>sanction: Sanction imposed for the non-conformity, e.g. warning, suspension or withdrawal of certification</li>\n<li>certification_body_id: The certification body this non  conformity refers to</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"supervisory_non_conformity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>audit_report_id</code>, <code>certification_body_id</code>, <code>certification_scheme_id</code>, <code>supervisory_finding_id</code>, <code>supervisory_non_conformity_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>audit_report_id</code> → <code>audit_report</code>, <code>certification_body_id</code> → <code>certification_body</code>, <code>certification_scheme_id</code> → <code>certification_scheme</code>, <code>supervisory_finding_id</code> → <code>supervisory_finding</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getsupervisory_non_conformityList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"supervisory_non_conformity_list":{"type":"array","items":{"type":"object","properties":{"supervisory_non_conformity":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"sanction":{"type":"string"},"audit_report_id":{"type":"string"},"supervisory_finding_id":{"type":"string"},"remediation_timeline":{"type":"string"},"supervisory_non_conformity_id":{"type":"string"},"certification_body_id":{"type":"string"},"category":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"supervisory_non_conformity_list":[{"supervisory_non_conformity":{"supervisory_non_conformity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supervisory_non_conformity_id":"string","supervisory_finding_id":"string","audit_report_id":"string","category":"string","remediation_timeline":"string","sanction":"warning","certification_scheme_id":"string","certification_body_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Supervisory_non_conformity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new supervisory_non_conformity","description":"<p>Create new supervisory_non_conformity.</p>\n<p>\u2018non-conformity\u2019 means a failure by an operator or a certification body to comply with the rules and procedures, established by the certification scheme, of which they are members or under which they operate. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>category: critical, major and minor</li>\n<li>remediation_timeline: Timeline for remediation of non-conformities</li>\n<li>sanction: Sanction imposed for the non-conformity, e.g. warning, suspension or withdrawal of certification</li>\n<li>certification_body_id: The certification body this non  conformity refers to</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"supervisory_non_conformity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createsupervisory_non_conformity_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"sanction":{"type":"string"},"audit_report_id":{"type":"string"},"supervisory_finding_id":{"type":"string"},"remediation_timeline":{"type":"string"},"supervisory_non_conformity_id":{"type":"string"},"certification_body_id":{"type":"string"},"category":{"type":"string"}}},"example":{"supervisory_non_conformity_id":"string","supervisory_finding_id":"string","audit_report_id":"string","category":"string","remediation_timeline":"string","sanction":"warning","certification_scheme_id":"string","certification_body_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"supervisory_non_conformity":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"sanction":{"type":"string"},"audit_report_id":{"type":"string"},"supervisory_finding_id":{"type":"string"},"remediation_timeline":{"type":"string"},"supervisory_non_conformity_id":{"type":"string"},"certification_body_id":{"type":"string"},"category":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"supervisory_non_conformity":{"supervisory_non_conformity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supervisory_non_conformity_id":"string","supervisory_finding_id":"string","audit_report_id":"string","category":"string","remediation_timeline":"string","sanction":"warning","certification_scheme_id":"string","certification_body_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/co-benefit/{cobenefitid}":{"get":{"tags":["_Co_benefit(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public co_benefit by id","description":"<p>Get Public co_benefit by id.</p>\n<p>Parsed entity co_benefit. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"co_benefit\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePublicco_benefit_ogcr","parameters":[{"name":"cobenefitid","in":"path","description":"The COBENEFITID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"co_benefit":{"type":"object","properties":{"co_benefit_id":{"type":"string"},"co_benefit_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"co_benefit":{"co_benefit_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","co_benefit_id":"string","co_benefit_name":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/public/carbon-credit-batch-on-chain/{carboncreditbatchonchainid}":{"get":{"tags":["_Carbon_credit_batch_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public carbon_credit_batch_on_chain by id","description":"<p>Get Public carbon_credit_batch_on_chain by id.</p>\n<p>Cache of CarbonCreditBatchNFT data minted on the OGCR chain (chain id 20253). One record per carbon_credit_batch_id: the units of one unit type issued for an activity over one monitoring period. Each batch owns an ERC-6551 token-bound account that holds its CarbonCredit (ERC-20) balance. Populated by OGCR-chain-cache reading the chain. Join to <code>activity_on_chain</code> on activity_id (or activity_nft_id = token_id) to reach the OBP activity.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_hash: activity_hash stored on-chain: keccak256 of the raw activity entity body.</li>\n<li>activity_id: activity_id this batch was issued for, as stored on-chain.</li>\n<li>activity_name: Activity name as stored on-chain.</li>\n<li>activity_nft_id: ActivityNFT token id this batch was issued against. Join to <code>activity_on_chain</code>.token_id to reach the OBP activity_id.</li>\n<li>activity_url: activity_url stored on-chain: link back to the OBP activity entity.</li>\n<li>amount: Units issued for the batch, fixed at mint, in CarbonCredit base units (18 decimals): 6.5 tonnes is 6500000000000000000. Decimal string because a uint256 does not fit an integer field. The live balance is credit_balance.</li>\n<li>batch_name: Display name of the batch by unit type, as stored on-chain.</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>block_number_balance: Block height the credit_balance was read at. Unlike the mint fields, the balance is current-state, not historical, so it is only true as of this block.</li>\n<li>carbon_credit_batch_id: Business key for this record, as stored on-chain. The contract permits one batch token per id (tokenIdByBatchId), so it is used to match records for upsert.</li>\n<li>certificate_of_compliance_hash: certificate_of_compliance_hash stored on-chain: keccak256 of the raw certificate_of_compliance entity body.</li>\n<li>certificate_of_compliance_uri: certificate_of_compliance_uri stored on-chain: link back to the OBP certificate_of_compliance entity.</li>\n<li>certification_body_hash: certification_body_hash stored on-chain: keccak256 of the raw certification body entity body.</li>\n<li>certification_body_url: certification_body_url stored on-chain: link back to the OBP certification body entity.</li>\n<li>certification_scheme_hash: certification_scheme_hash stored on-chain: keccak256 of the raw certification scheme entity body.</li>\n<li>certification_scheme_url: certification_scheme_url stored on-chain: link back to the OBP certification_scheme entity.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: CarbonCreditBatchNFT contract address the token was read from.</li>\n<li>country_id: Country id as stored on-chain.</li>\n<li>credit_balance: CarbonCredit (ERC-20) balance held by token_bound_account, in smallest units, as read at block_number_balance. Decimal string because a uint256 does not fit an integer field. Divide by 10^credit_decimals for tonnes CO2e. Empty when no CarbonCredit contract address is configured.</li>\n<li>credit_contract_address: CarbonCredit ERC-20 contract address the balance was read from.</li>\n<li>credit_decimals: Decimals of the CarbonCredit ERC-20, for rendering credit_balance. 0 when no CarbonCredit contract address is configured.</li>\n<li>expiry_date: Batch expiry date as stored on-chain.</li>\n<li>issue_date: Batch issue date as stored on-chain.</li>\n<li>monitoring_period_end_date: Monitoring period end date as stored on-chain.</li>\n<li>monitoring_period_start_date: Monitoring period start date as stored on-chain.</li>\n<li>operator_hash: operator_hash stored on-chain: keccak256 of the raw operator entity body.</li>\n<li>operator_url: operator_url stored on-chain: link back to the OBP operator entity.</li>\n<li>owner_address: Current owner of the batch NFT (operator OGCR wallet address). Owning the NFT gates the right to move the credits held in its token-bound account.</li>\n<li>status_code: Batch status as stored on-chain.</li>\n<li>token_bound_account: ERC-6551 token-bound account for this batch. This address holds the batch's CarbonCredit (ERC-20) balance.</li>\n<li>token_id: CarbonCreditBatchNFT token id, unique per contract. Records are matched on carbon_credit_batch_id rather than this, so that the match uses a string field.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI, rendered on-chain from the batch data).</li>\n<li>tx_hash: Mint transaction hash (from the BatchMinted event).</li>\n<li>unit_type: CRCF unit type this batch represents, as stored on-chain.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"carbon_credit_batch_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePubliccarbon_credit_batch_on_chain_ogcr","parameters":[{"name":"carboncreditbatchonchainid","in":"path","description":"The CARBONCREDITBATCHONCHAINID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"carbon_credit_batch_on_chain":{"type":"object","properties":{"activity_nft_id":{"type":"integer"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"block_number_balance":{"type":"integer"},"contract_address":{"type":"string"},"operator_hash":{"type":"string"},"carbon_credit_batch_on_chain_id":{"type":"string"},"unit_type":{"type":"string"},"credit_contract_address":{"type":"string"},"token_uri":{"type":"string"},"certificate_of_compliance_hash":{"type":"string"},"status_code":{"type":"string"},"credit_decimals":{"type":"integer"},"monitoring_period_end_date":{"type":"string"},"amount":{"type":"string"},"issue_date":{"type":"string"},"certificate_of_compliance_uri":{"type":"string"},"activity_url":{"type":"string"},"token_bound_account":{"type":"string"},"certification_scheme_hash":{"type":"string"},"certification_scheme_url":{"type":"string"},"certification_body_url":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"integer"},"activity_name":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"batch_name":{"type":"string"},"operator_url":{"type":"string"},"activity_hash":{"type":"string"},"block_number":{"type":"integer"},"carbon_credit_batch_id":{"type":"string"},"country_id":{"type":"string"},"certification_body_hash":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"},"credit_balance":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"carbon_credit_batch_on_chain":{"carbon_credit_batch_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_name":"Reforestation 2024","activity_nft_id":1,"activity_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/activity/activity_AB12CD34EF","amount":"6500000000000000000","batch_name":"Permanent Removals Carbon Credit Batch","block_number":12345,"block_number_balance":12400,"carbon_credit_batch_id":"verification_AB12:permanent_removal","certificate_of_compliance_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certificate_of_compliance_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certificate_of_compliance/coc_AB12CD34EF","certification_body_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_body_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/certification_body/body_VERRA","certification_scheme_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_scheme_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/certification_scheme/scheme_SALUS","chain_id":20253,"contract_address":"0x38cF23C52Bb4B13F051Aec09580a2dE845a7FA35","country_id":"DK","credit_balance":"1000000000000000000","credit_contract_address":"0x1B4bC0dE8b6A1A2b3C4d5E6f7A8b9C0d1E2f3A4b","credit_decimals":18,"expiry_date":"2030-01-01","issue_date":"2025-01-01","monitoring_period_end_date":"2024-12-31","monitoring_period_start_date":"2024-01-01","operator_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","operator_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/operator/op_01JS0347FKH","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","status_code":"issued","token_bound_account":"0x9F2fCc7C4E1C0eA0dB1A0EbD79b0Cc7Ee4c3e5a1","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQmF0Y2gifQ==","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_type":"Permanent Removal"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/parcel-activity/{parcelactivityid}":{"get":{"tags":["_Parcel_activity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get parcel_activity by id","description":"<p>Get parcel_activity by id.</p>\n<p>An intersecting entity. This links parcels to activities. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_activity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleparcel_activity_ogcr","parameters":[{"name":"parcelactivityid","in":"path","description":"The PARCELACTIVITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_activity":{"type":"object","properties":{"parcel_activity_id":{"type":"string"},"parcel_id":{"type":"string"},"activity_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_activity":{"parcel_activity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_id":"string","activity_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Parcel_activity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update parcel_activity","description":"<p>Update parcel_activity.</p>\n<p>An intersecting entity. This links parcels to activities. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_activity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateparcel_activity_ogcr","parameters":[{"name":"parcelactivityid","in":"path","description":"The PARCELACTIVITYID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_id":{"type":"string"},"activity_id":{"type":"string"}}},"example":{"parcel_id":"string","activity_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_activity":{"type":"object","properties":{"parcel_activity_id":{"type":"string"},"parcel_id":{"type":"string"},"activity_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_activity":{"parcel_activity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_id":"string","activity_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Parcel_activity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete parcel_activity by id","description":"<p>Delete parcel_activity by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_activity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteparcel_activity_ogcr","parameters":[{"name":"parcelactivityid","in":"path","description":"The PARCELACTIVITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_activity":{"type":"object","properties":{"parcel_activity_id":{"type":"string"},"parcel_id":{"type":"string"},"activity_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_activity":{"parcel_activity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_id":"string","activity_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Parcel_activity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update parcel_activity","description":"<p>Partially update parcel_activity: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>An intersecting entity. This links parcels to activities. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_activity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchparcel_activity_ogcr","parameters":[{"name":"parcelactivityid","in":"path","description":"The PARCELACTIVITYID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_id":{"type":"string"},"activity_id":{"type":"string"}}},"example":{"parcel_id":"string","activity_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_activity":{"type":"object","properties":{"parcel_activity_id":{"type":"string"},"parcel_id":{"type":"string"},"activity_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_activity":{"parcel_activity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_id":"string","activity_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/activity-verification":{"get":{"tags":["_Activity_verification(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public activity_verification List","description":"<p>Get Public activity_verification List.</p>\n<p>This is the initial certification done by the certifier scheme and auditors. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>parcel_id: (uu)id of the parcel that gets verified</li>\n<li>activity_id: ID of the project this parcel belongs to</li>\n<li>status_code: in_progress, verified, failed</li>\n<li>status_message: further explanation of status code</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: expected amount of CO2e tonnes removed or reduced</li>\n<li>supporting_document_id: Supporting documents for activity verification</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_verification\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>activity_verification_id</code>, <code>parcel_id</code>, <code>status_code</code>, <code>supporting_document_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPublicactivity_verificationList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_verification_list":{"type":"array","items":{"type":"object","properties":{"activity_verification":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"activity_verification_id":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"status_code":{"type":"string"},"activity_id":{"type":"string"},"status_message":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"parcel_id":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"activity_verification_list":[{"activity_verification":{"activity_verification_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_verification_id":"string","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","activity_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","status_code":"verified","status_message":"could not find owner","permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":5.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"supporting_document_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/public/chain-sync-status/{chainsyncstatusid}":{"get":{"tags":["_Chain_sync_status(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public chain_sync_status by id","description":"<p>Get Public chain_sync_status by id.</p>\n<p>Liveness record for OGCR-chain-cache: one record per chain, rewritten at the end of every mirror run. The other *_on_chain entities say what is on the chain; this says when anything last looked. Without it a quiet chain is indistinguishable from a dead mirror, because the newest mint could be old for either reason. Consumers should treat a record older than a few multiples of interval_seconds as stale.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_count: Activity tokens mirrored in this run.</li>\n<li>certification_count: Certification tokens mirrored in this run.</li>\n<li>chain_id: EVM chain id that was read.</li>\n<li>credit_balance_count: Carbon credit holder balances mirrored in this run.</li>\n<li>credit_batch_count: Carbon credit batch tokens mirrored in this run.</li>\n<li>error_count: Records that failed to upsert during the run.</li>\n<li>head_block: Chain head at the end of the run. Rising across runs is the clearest sign the chain itself is alive, as opposed to only the mirror.</li>\n<li>interval_seconds: Expected seconds between runs, from SYNC_INTERVAL_SECONDS. 0 when the cacher was run by hand. Lets a consumer decide what counts as stale without hardcoding the schedule.</li>\n<li>mirrored_types: Which mirrors ran, comma separated. Distinguishes a count of zero meaning \"none found\" from a mirror that was skipped because its contract is not configured.</li>\n<li>parcel_count: Parcel tokens mirrored in this run.</li>\n<li>run_status: \"ok\" when every configured mirror completed with no errors, \"partial\" when the chain was reachable but some records failed to write. A run that cannot reach the chain at all writes nothing, so the previous record simply ages.</li>\n<li>sync_key: Business key: \"chain-&lt;chain_id&gt;\". One record per chain, overwritten each run. A string key so it can be matched with a server-side query filter.</li>\n<li>synced_at: UTC RFC-3339 timestamp of when the run finished. This is the field a heartbeat is actually built on.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"chain_sync_status\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePublicchain_sync_status_ogcr","parameters":[{"name":"chainsyncstatusid","in":"path","description":"The CHAINSYNCSTATUSID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"chain_sync_status":{"type":"object","properties":{"activity_count":{"type":"integer"},"mirrored_types":{"type":"string"},"error_count":{"type":"integer"},"credit_balance_count":{"type":"integer"},"chain_sync_status_id":{"type":"string"},"sync_key":{"type":"string"},"credit_batch_count":{"type":"integer"},"synced_at":{"type":"string"},"certification_count":{"type":"integer"},"chain_id":{"type":"integer"},"parcel_count":{"type":"integer"},"interval_seconds":{"type":"integer"},"head_block":{"type":"integer"},"run_status":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"chain_sync_status":{"chain_sync_status_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_count":2,"certification_count":2,"chain_id":20253,"credit_balance_count":5,"credit_batch_count":2,"error_count":0,"head_block":12400,"interval_seconds":30,"mirrored_types":"parcel,activity,certification,credit","parcel_count":2,"run_status":"ok","sync_key":"chain-20253","synced_at":"2026-09-08T20:14:03Z"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/land-manager":{"get":{"tags":["_Land_manager(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get land_manager List","description":"<p>Get land_manager List.</p>\n<p>\u2018land manager\u2019 means any natural or legal person or public entity that owns land being used for an activity. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>land_manager_id: Internal identifier for the land manager entity</li>\n<li>legal_name: Name of the land manager</li>\n<li>email: Land manager email address</li>\n<li>phone: Land manager phone number</li>\n<li>ogcr_wallet_address: Wallet address to send NFTs and carbon credits to after evaluation period</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"land_manager\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>land_manager_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getland_managerList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"land_manager_list":{"type":"array","items":{"type":"object","properties":{"land_manager":{"type":"object","properties":{"email":{"type":"string"},"land_manager_id":{"type":"string"},"ogcr_wallet_address":{"type":"string"},"legal_name":{"type":"string"},"phone":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"land_manager_list":[{"land_manager":{"land_manager_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","land_manager_id":"lm_03PVAF03760","legal_name":"Bob Smith","email":"example.email@email.com","phone":"+49 987 654 321","ogcr_wallet_address":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Land_manager(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new land_manager","description":"<p>Create new land_manager.</p>\n<p>\u2018land manager\u2019 means any natural or legal person or public entity that owns land being used for an activity. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>land_manager_id: Internal identifier for the land manager entity</li>\n<li>legal_name: Name of the land manager</li>\n<li>email: Land manager email address</li>\n<li>phone: Land manager phone number</li>\n<li>ogcr_wallet_address: Wallet address to send NFTs and carbon credits to after evaluation period</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"land_manager\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createland_manager_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"land_manager_id":{"type":"string"},"ogcr_wallet_address":{"type":"string"},"legal_name":{"type":"string"},"phone":{"type":"string"}}},"example":{"land_manager_id":"lm_03PVAF03760","legal_name":"Bob Smith","email":"example.email@email.com","phone":"+49 987 654 321","ogcr_wallet_address":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"land_manager":{"type":"object","properties":{"email":{"type":"string"},"land_manager_id":{"type":"string"},"ogcr_wallet_address":{"type":"string"},"legal_name":{"type":"string"},"phone":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"land_manager":{"land_manager_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","land_manager_id":"lm_03PVAF03760","legal_name":"Bob Smith","email":"example.email@email.com","phone":"+49 987 654 321","ogcr_wallet_address":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/retirement-event-on-chain/{retirementeventonchainid}":{"get":{"tags":["_Retirement_event_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get retirement_event_on_chain by id","description":"<p>Get retirement_event_on_chain by id.</p>\n<p>Parsed entity retirement_event_on_chain. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>minted_at: On-chain block timestamp (mintedAt) from projectData, unix seconds.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_event_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleretirement_event_on_chain_ogcr","parameters":[{"name":"retirementeventonchainid","in":"path","description":"The RETIREMENTEVENTONCHAINID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_event_on_chain":{"type":"object","properties":{"end_use":{"type":"string"},"retirement_date":{"type":"string"},"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"amount":{"type":"number"},"token_id":{"type":"string"},"retirement_event_on_chain_id":{"type":"string"},"contract_address":{"type":"string"},"unit_type":{"type":"string"},"minted_at":{"type":"integer"},"retirement_reason":{"type":"string"},"retirement_event_id":{"type":"string"},"block_number":{"type":"number"},"carbon_credit_batch_id":{"type":"string"},"chain_id":{"type":"integer"},"beneficiary_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"retirement_event_on_chain":{"retirement_event_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_event_id":"string","token_id":"string","unit_type":"string","carbon_credit_batch_id":"string","amount":1.0,"owner_address":"string","beneficiary_name":"string","end_use":"string","retirement_reason":"string","retirement_date":"2020-01-01","minted_at":1,"token_uri":"string","contract_address":"string","chain_id":1,"tx_hash":"string","block_number":1.0},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Retirement_event_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update retirement_event_on_chain","description":"<p>Update retirement_event_on_chain.</p>\n<p>Parsed entity retirement_event_on_chain. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>minted_at: On-chain block timestamp (mintedAt) from projectData, unix seconds.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_event_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateretirement_event_on_chain_ogcr","parameters":[{"name":"retirementeventonchainid","in":"path","description":"The RETIREMENTEVENTONCHAINID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"end_use":{"type":"string"},"retirement_date":{"type":"string"},"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"amount":{"type":"number"},"token_id":{"type":"string"},"contract_address":{"type":"string"},"unit_type":{"type":"string"},"minted_at":{"type":"integer"},"retirement_reason":{"type":"string"},"retirement_event_id":{"type":"string"},"block_number":{"type":"number"},"carbon_credit_batch_id":{"type":"string"},"chain_id":{"type":"integer"},"beneficiary_name":{"type":"string"}}},"example":{"retirement_event_id":"string","token_id":"string","unit_type":"string","carbon_credit_batch_id":"string","amount":1.0,"owner_address":"string","beneficiary_name":"string","end_use":"string","retirement_reason":"string","retirement_date":"2020-01-01","minted_at":1,"token_uri":"string","contract_address":"string","chain_id":1,"tx_hash":"string","block_number":1.0}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_event_on_chain":{"type":"object","properties":{"end_use":{"type":"string"},"retirement_date":{"type":"string"},"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"amount":{"type":"number"},"token_id":{"type":"string"},"retirement_event_on_chain_id":{"type":"string"},"contract_address":{"type":"string"},"unit_type":{"type":"string"},"minted_at":{"type":"integer"},"retirement_reason":{"type":"string"},"retirement_event_id":{"type":"string"},"block_number":{"type":"number"},"carbon_credit_batch_id":{"type":"string"},"chain_id":{"type":"integer"},"beneficiary_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"retirement_event_on_chain":{"retirement_event_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_event_id":"string","token_id":"string","unit_type":"string","carbon_credit_batch_id":"string","amount":1.0,"owner_address":"string","beneficiary_name":"string","end_use":"string","retirement_reason":"string","retirement_date":"2020-01-01","minted_at":1,"token_uri":"string","contract_address":"string","chain_id":1,"tx_hash":"string","block_number":1.0},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Retirement_event_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete retirement_event_on_chain by id","description":"<p>Delete retirement_event_on_chain by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_event_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteretirement_event_on_chain_ogcr","parameters":[{"name":"retirementeventonchainid","in":"path","description":"The RETIREMENTEVENTONCHAINID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_event_on_chain":{"type":"object","properties":{"end_use":{"type":"string"},"retirement_date":{"type":"string"},"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"amount":{"type":"number"},"token_id":{"type":"string"},"retirement_event_on_chain_id":{"type":"string"},"contract_address":{"type":"string"},"unit_type":{"type":"string"},"minted_at":{"type":"integer"},"retirement_reason":{"type":"string"},"retirement_event_id":{"type":"string"},"block_number":{"type":"number"},"carbon_credit_batch_id":{"type":"string"},"chain_id":{"type":"integer"},"beneficiary_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"retirement_event_on_chain":{"retirement_event_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_event_id":"string","token_id":"string","unit_type":"string","carbon_credit_batch_id":"string","amount":1.0,"owner_address":"string","beneficiary_name":"string","end_use":"string","retirement_reason":"string","retirement_date":"2020-01-01","minted_at":1,"token_uri":"string","contract_address":"string","chain_id":1,"tx_hash":"string","block_number":1.0},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Retirement_event_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update retirement_event_on_chain","description":"<p>Partially update retirement_event_on_chain: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Parsed entity retirement_event_on_chain. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>minted_at: On-chain block timestamp (mintedAt) from projectData, unix seconds.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_event_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchretirement_event_on_chain_ogcr","parameters":[{"name":"retirementeventonchainid","in":"path","description":"The RETIREMENTEVENTONCHAINID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"end_use":{"type":"string"},"retirement_date":{"type":"string"},"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"amount":{"type":"number"},"token_id":{"type":"string"},"contract_address":{"type":"string"},"unit_type":{"type":"string"},"minted_at":{"type":"integer"},"retirement_reason":{"type":"string"},"retirement_event_id":{"type":"string"},"block_number":{"type":"number"},"carbon_credit_batch_id":{"type":"string"},"chain_id":{"type":"integer"},"beneficiary_name":{"type":"string"}}},"example":{"retirement_event_id":"string","token_id":"string","unit_type":"string","carbon_credit_batch_id":"string","amount":1.0,"owner_address":"string","beneficiary_name":"string","end_use":"string","retirement_reason":"string","retirement_date":"2020-01-01","minted_at":1,"token_uri":"string","contract_address":"string","chain_id":1,"tx_hash":"string","block_number":1.0}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_event_on_chain":{"type":"object","properties":{"end_use":{"type":"string"},"retirement_date":{"type":"string"},"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"amount":{"type":"number"},"token_id":{"type":"string"},"retirement_event_on_chain_id":{"type":"string"},"contract_address":{"type":"string"},"unit_type":{"type":"string"},"minted_at":{"type":"integer"},"retirement_reason":{"type":"string"},"retirement_event_id":{"type":"string"},"block_number":{"type":"number"},"carbon_credit_batch_id":{"type":"string"},"chain_id":{"type":"integer"},"beneficiary_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"retirement_event_on_chain":{"retirement_event_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_event_id":"string","token_id":"string","unit_type":"string","carbon_credit_batch_id":"string","amount":1.0,"owner_address":"string","beneficiary_name":"string","end_use":"string","retirement_reason":"string","retirement_date":"2020-01-01","minted_at":1,"token_uri":"string","contract_address":"string","chain_id":1,"tx_hash":"string","block_number":1.0},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/parcel-on-chain/{parcelonchainid}":{"get":{"tags":["_Parcel_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get parcel_on_chain by id","description":"<p>Get parcel_on_chain by id.</p>\n<p>Cache of ParcelNFT data minted on the OGCR chain (chain id 20253). One record per parcel_id, populated by OGCR-chain-cache reading the chain. Does not mutate the source <code>parcel</code> entity.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>block_number: Block number the mint was included in.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: ParcelNFT contract address the token was read from.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>parcel_hash: parcel_hash stored on-chain: keccak256 of the raw parcel entity body.</li>\n<li>parcel_id: Links to the <code>parcel</code> dynamic entity. The on-chain ParcelNFT is keyed by this id.</li>\n<li>parcel_uri: parcel_uri stored on-chain: link back to the OBP parcel entity.</li>\n<li>token_id: ParcelNFT token id minted for this parcel.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>tx_hash: Mint transaction hash (from the ParcelMinted event).</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleparcel_on_chain_ogcr","parameters":[{"name":"parcelonchainid","in":"path","description":"The PARCELONCHAINID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_on_chain":{"type":"object","properties":{"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"token_id":{"type":"integer"},"parcel_id":{"type":"string"},"block_number":{"type":"integer"},"parcel_uri":{"type":"string"},"chain_id":{"type":"integer"},"parcel_on_chain_id":{"type":"string"},"owner_address":{"type":"string"},"contract_address":{"type":"string"},"parcel_hash":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_on_chain":{"parcel_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","block_number":12345,"chain_id":20253,"contract_address":"0x62227531b82259561CC9ad4413188F08E536598a","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","parcel_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","parcel_id":"parcel_AB12CD34EF","parcel_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/parcel/parcel_AB12CD34EF","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiUGFyY2VsIn0=","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Parcel_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update parcel_on_chain","description":"<p>Update parcel_on_chain.</p>\n<p>Cache of ParcelNFT data minted on the OGCR chain (chain id 20253). One record per parcel_id, populated by OGCR-chain-cache reading the chain. Does not mutate the source <code>parcel</code> entity.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>block_number: Block number the mint was included in.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: ParcelNFT contract address the token was read from.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>parcel_hash: parcel_hash stored on-chain: keccak256 of the raw parcel entity body.</li>\n<li>parcel_id: Links to the <code>parcel</code> dynamic entity. The on-chain ParcelNFT is keyed by this id.</li>\n<li>parcel_uri: parcel_uri stored on-chain: link back to the OBP parcel entity.</li>\n<li>token_id: ParcelNFT token id minted for this parcel.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>tx_hash: Mint transaction hash (from the ParcelMinted event).</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateparcel_on_chain_ogcr","parameters":[{"name":"parcelonchainid","in":"path","description":"The PARCELONCHAINID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"token_id":{"type":"integer"},"parcel_id":{"type":"string"},"block_number":{"type":"integer"},"parcel_uri":{"type":"string"},"chain_id":{"type":"integer"},"contract_address":{"type":"string"},"parcel_hash":{"type":"string"}}},"example":{"block_number":12345,"chain_id":20253,"contract_address":"0x62227531b82259561CC9ad4413188F08E536598a","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","parcel_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","parcel_id":"parcel_AB12CD34EF","parcel_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/parcel/parcel_AB12CD34EF","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiUGFyY2VsIn0=","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_on_chain":{"type":"object","properties":{"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"token_id":{"type":"integer"},"parcel_id":{"type":"string"},"block_number":{"type":"integer"},"parcel_uri":{"type":"string"},"chain_id":{"type":"integer"},"parcel_on_chain_id":{"type":"string"},"owner_address":{"type":"string"},"contract_address":{"type":"string"},"parcel_hash":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_on_chain":{"parcel_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","block_number":12345,"chain_id":20253,"contract_address":"0x62227531b82259561CC9ad4413188F08E536598a","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","parcel_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","parcel_id":"parcel_AB12CD34EF","parcel_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/parcel/parcel_AB12CD34EF","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiUGFyY2VsIn0=","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Parcel_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete parcel_on_chain by id","description":"<p>Delete parcel_on_chain by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteparcel_on_chain_ogcr","parameters":[{"name":"parcelonchainid","in":"path","description":"The PARCELONCHAINID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_on_chain":{"type":"object","properties":{"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"token_id":{"type":"integer"},"parcel_id":{"type":"string"},"block_number":{"type":"integer"},"parcel_uri":{"type":"string"},"chain_id":{"type":"integer"},"parcel_on_chain_id":{"type":"string"},"owner_address":{"type":"string"},"contract_address":{"type":"string"},"parcel_hash":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_on_chain":{"parcel_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","block_number":12345,"chain_id":20253,"contract_address":"0x62227531b82259561CC9ad4413188F08E536598a","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","parcel_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","parcel_id":"parcel_AB12CD34EF","parcel_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/parcel/parcel_AB12CD34EF","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiUGFyY2VsIn0=","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Parcel_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update parcel_on_chain","description":"<p>Partially update parcel_on_chain: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Cache of ParcelNFT data minted on the OGCR chain (chain id 20253). One record per parcel_id, populated by OGCR-chain-cache reading the chain. Does not mutate the source <code>parcel</code> entity.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>block_number: Block number the mint was included in.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: ParcelNFT contract address the token was read from.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>parcel_hash: parcel_hash stored on-chain: keccak256 of the raw parcel entity body.</li>\n<li>parcel_id: Links to the <code>parcel</code> dynamic entity. The on-chain ParcelNFT is keyed by this id.</li>\n<li>parcel_uri: parcel_uri stored on-chain: link back to the OBP parcel entity.</li>\n<li>token_id: ParcelNFT token id minted for this parcel.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>tx_hash: Mint transaction hash (from the ParcelMinted event).</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchparcel_on_chain_ogcr","parameters":[{"name":"parcelonchainid","in":"path","description":"The PARCELONCHAINID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"token_id":{"type":"integer"},"parcel_id":{"type":"string"},"block_number":{"type":"integer"},"parcel_uri":{"type":"string"},"chain_id":{"type":"integer"},"contract_address":{"type":"string"},"parcel_hash":{"type":"string"}}},"example":{"block_number":12345,"chain_id":20253,"contract_address":"0x62227531b82259561CC9ad4413188F08E536598a","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","parcel_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","parcel_id":"parcel_AB12CD34EF","parcel_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/parcel/parcel_AB12CD34EF","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiUGFyY2VsIn0=","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_on_chain":{"type":"object","properties":{"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"token_id":{"type":"integer"},"parcel_id":{"type":"string"},"block_number":{"type":"integer"},"parcel_uri":{"type":"string"},"chain_id":{"type":"integer"},"parcel_on_chain_id":{"type":"string"},"owner_address":{"type":"string"},"contract_address":{"type":"string"},"parcel_hash":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_on_chain":{"parcel_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","block_number":12345,"chain_id":20253,"contract_address":"0x62227531b82259561CC9ad4413188F08E536598a","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","parcel_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","parcel_id":"parcel_AB12CD34EF","parcel_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/parcel/parcel_AB12CD34EF","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiUGFyY2VsIn0=","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/supporting-document/{supportingdocumentid}":{"get":{"tags":["_Supporting_document(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get supporting_document by id","description":"<p>Get supporting_document by id.</p>\n<p>Parsed entity supporting_document. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>supporting_document_id: ISO 3166-1 alpha-2 country code for where the activity occurs.</li>\n<li>title: Title of the document</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"supporting_document\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglesupporting_document_ogcr","parameters":[{"name":"supportingdocumentid","in":"path","description":"The SUPPORTINGDOCUMENTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"supporting_document":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"title":{"type":"string"},"sha256_of_document":{"type":"string"},"url":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"supporting_document":{"supporting_document_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supporting_document_id":"DE","title":"Germany","sha256_of_document":"string","url":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Supporting_document(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update supporting_document","description":"<p>Update supporting_document.</p>\n<p>Parsed entity supporting_document. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>supporting_document_id: ISO 3166-1 alpha-2 country code for where the activity occurs.</li>\n<li>title: Title of the document</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"supporting_document\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updatesupporting_document_ogcr","parameters":[{"name":"supportingdocumentid","in":"path","description":"The SUPPORTINGDOCUMENTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"title":{"type":"string"},"sha256_of_document":{"type":"string"},"url":{"type":"string"}}},"example":{"supporting_document_id":"DE","title":"Germany","sha256_of_document":"string","url":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"supporting_document":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"title":{"type":"string"},"sha256_of_document":{"type":"string"},"url":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"supporting_document":{"supporting_document_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supporting_document_id":"DE","title":"Germany","sha256_of_document":"string","url":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Supporting_document(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete supporting_document by id","description":"<p>Delete supporting_document by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"supporting_document\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletesupporting_document_ogcr","parameters":[{"name":"supportingdocumentid","in":"path","description":"The SUPPORTINGDOCUMENTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"supporting_document":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"title":{"type":"string"},"sha256_of_document":{"type":"string"},"url":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"supporting_document":{"supporting_document_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supporting_document_id":"DE","title":"Germany","sha256_of_document":"string","url":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Supporting_document(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update supporting_document","description":"<p>Partially update supporting_document: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Parsed entity supporting_document. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>supporting_document_id: ISO 3166-1 alpha-2 country code for where the activity occurs.</li>\n<li>title: Title of the document</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"supporting_document\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchsupporting_document_ogcr","parameters":[{"name":"supportingdocumentid","in":"path","description":"The SUPPORTINGDOCUMENTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"title":{"type":"string"},"sha256_of_document":{"type":"string"},"url":{"type":"string"}}},"example":{"supporting_document_id":"DE","title":"Germany","sha256_of_document":"string","url":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"supporting_document":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"title":{"type":"string"},"sha256_of_document":{"type":"string"},"url":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"supporting_document":{"supporting_document_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supporting_document_id":"DE","title":"Germany","sha256_of_document":"string","url":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/user-certification-scheme-relationship":{"get":{"tags":["_User_certification_scheme_relationship(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get user_certification_scheme_relationship List","description":"<p>Get user_certification_scheme_relationship List.</p>\n<p>Describes the relationship between a User (the logged in User via OAuth2/OIDC or a Consent) and the Certification Scheme. This intersecting entity allows a many to many relationship between Users and Certification Scheme. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>user_id: (Authenticated) User</li>\n<li>certification_scheme_id: the certification scheme (uu)id</li>\n<li>relationship_to_certification_scheme: relationship describes the user's relationship to the certification scheme: the user is the subject, the certification body is the  object</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"user_certification_scheme_relationship\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p><em>(no fields on this entity are declared <code>indexed</code>, so only the legacy bare-parameter filter below is available.)</em></p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getuser_certification_scheme_relationshipList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"user_certification_scheme_relationship_list":{"type":"array","items":{"type":"object","properties":{"user_certification_scheme_relationship":{"type":"object","properties":{"user_certification_scheme_relationship_id":{"type":"string"},"user_id":{"type":"string"},"certification_scheme_id":{"type":"string"},"relationship_to_certification_scheme":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"user_certification_scheme_relationship_list":[{"user_certification_scheme_relationship":{"user_certification_scheme_relationship_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_scheme_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_certification_scheme":"Managing Director, Employee, Accountant"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_User_certification_scheme_relationship(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new user_certification_scheme_relationship","description":"<p>Create new user_certification_scheme_relationship.</p>\n<p>Describes the relationship between a User (the logged in User via OAuth2/OIDC or a Consent) and the Certification Scheme. This intersecting entity allows a many to many relationship between Users and Certification Scheme. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>user_id: (Authenticated) User</li>\n<li>certification_scheme_id: the certification scheme (uu)id</li>\n<li>relationship_to_certification_scheme: relationship describes the user's relationship to the certification scheme: the user is the subject, the certification body is the  object</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"user_certification_scheme_relationship\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createuser_certification_scheme_relationship_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string"},"certification_scheme_id":{"type":"string"},"relationship_to_certification_scheme":{"type":"string"}}},"example":{"user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_scheme_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_certification_scheme":"Managing Director, Employee, Accountant"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"user_certification_scheme_relationship":{"type":"object","properties":{"user_certification_scheme_relationship_id":{"type":"string"},"user_id":{"type":"string"},"certification_scheme_id":{"type":"string"},"relationship_to_certification_scheme":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"user_certification_scheme_relationship":{"user_certification_scheme_relationship_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_scheme_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_certification_scheme":"Managing Director, Employee, Accountant"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/parcel-activity":{"get":{"tags":["_Parcel_activity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get parcel_activity List","description":"<p>Get parcel_activity List.</p>\n<p>An intersecting entity. This links parcels to activities. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_activity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>parcel_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>activity_id</code> → <code>activity</code>, <code>parcel_id</code> → <code>parcel</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getparcel_activityList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_activity_list":{"type":"array","items":{"type":"object","properties":{"parcel_activity":{"type":"object","properties":{"parcel_activity_id":{"type":"string"},"parcel_id":{"type":"string"},"activity_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"parcel_activity_list":[{"parcel_activity":{"parcel_activity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_id":"string","activity_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Parcel_activity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new parcel_activity","description":"<p>Create new parcel_activity.</p>\n<p>An intersecting entity. This links parcels to activities. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_activity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createparcel_activity_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_id":{"type":"string"},"activity_id":{"type":"string"}}},"example":{"parcel_id":"string","activity_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_activity":{"type":"object","properties":{"parcel_activity_id":{"type":"string"},"parcel_id":{"type":"string"},"activity_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_activity":{"parcel_activity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_id":"string","activity_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/country":{"get":{"tags":["_Country(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public country List","description":"<p>Get Public country List.</p>\n<p>Parsed entity country. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>country_id: ISO 3166-1 alpha-2 country code for where the activity occurs.</li>\n<li>country_name: Name of the country</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"country\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>country_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPubliccountryList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"country_list":{"type":"array","items":{"type":"object","properties":{"country":{"type":"object","properties":{"country_id":{"type":"string"},"country_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"country_list":[{"country":{"country_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","country_id":"DE","country_name":"Germany"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/carbon-credit-balance-on-chain/{carboncreditbalanceonchainid}":{"get":{"tags":["_Carbon_credit_balance_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get carbon_credit_balance_on_chain by id","description":"<p>Get carbon_credit_balance_on_chain by id.</p>\n<p>Cache of CarbonCredit (ERC-20) balances on the OGCR chain (chain id 20253). One record per holding address, covering both operator wallets and the ERC-6551 token-bound accounts of credit batches. Populated by OGCR-chain-cache, which derives the holder set from Transfer events and then reads each balance at the current head. Balances are current-state, not historical: each record is only true as of block_number.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>balance: CarbonCredit balance in smallest units, as read at block_number. Decimal string because a uint256 does not fit an integer field. Divide by 10^decimals for tonnes CO2e.</li>\n<li>batch_token_id: When holder_type is token_bound_account, the CarbonCreditBatchNFT token id this account belongs to. 0 otherwise. Join to <code>carbon_credit_batch_on_chain</code>.token_id.</li>\n<li>block_number: Block height the balance was read at.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: CarbonCredit ERC-20 contract address the balance was read from.</li>\n<li>decimals: Decimals of the CarbonCredit ERC-20, for rendering balance.</li>\n<li>holder_type: Whether this address is a plain wallet or the ERC-6551 token-bound account of a credit batch. One of: wallet, token_bound_account. A token_bound_account balance is credits still held inside their batch; a wallet balance is credits withdrawn from a batch and now pooled.</li>\n<li>owner_address: Address holding the balance, lowercase-insensitive checksum form. The business key for this record. Match against operator.ogcr_wallet_address or land_manager.ogcr_wallet_address to find a party's holdings.</li>\n<li>symbol: Symbol of the CarbonCredit ERC-20.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"carbon_credit_balance_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglecarbon_credit_balance_on_chain_ogcr","parameters":[{"name":"carboncreditbalanceonchainid","in":"path","description":"The CARBONCREDITBALANCEONCHAINID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"carbon_credit_balance_on_chain":{"type":"object","properties":{"balance":{"type":"string"},"owner_address":{"type":"string"},"symbol":{"type":"string"},"carbon_credit_balance_on_chain_id":{"type":"string"},"holder_type":{"type":"string"},"batch_token_id":{"type":"integer"},"block_number":{"type":"integer"},"chain_id":{"type":"integer"},"contract_address":{"type":"string"},"decimals":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"carbon_credit_balance_on_chain":{"carbon_credit_balance_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","balance":"1000000000000000000","batch_token_id":1,"block_number":12400,"chain_id":20253,"contract_address":"0x1B4bC0dE8b6A1A2b3C4d5E6f7A8b9C0d1E2f3A4b","decimals":18,"holder_type":"token_bound_account","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","symbol":"CC"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Carbon_credit_balance_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update carbon_credit_balance_on_chain","description":"<p>Update carbon_credit_balance_on_chain.</p>\n<p>Cache of CarbonCredit (ERC-20) balances on the OGCR chain (chain id 20253). One record per holding address, covering both operator wallets and the ERC-6551 token-bound accounts of credit batches. Populated by OGCR-chain-cache, which derives the holder set from Transfer events and then reads each balance at the current head. Balances are current-state, not historical: each record is only true as of block_number.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>balance: CarbonCredit balance in smallest units, as read at block_number. Decimal string because a uint256 does not fit an integer field. Divide by 10^decimals for tonnes CO2e.</li>\n<li>batch_token_id: When holder_type is token_bound_account, the CarbonCreditBatchNFT token id this account belongs to. 0 otherwise. Join to <code>carbon_credit_batch_on_chain</code>.token_id.</li>\n<li>block_number: Block height the balance was read at.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: CarbonCredit ERC-20 contract address the balance was read from.</li>\n<li>decimals: Decimals of the CarbonCredit ERC-20, for rendering balance.</li>\n<li>holder_type: Whether this address is a plain wallet or the ERC-6551 token-bound account of a credit batch. One of: wallet, token_bound_account. A token_bound_account balance is credits still held inside their batch; a wallet balance is credits withdrawn from a batch and now pooled.</li>\n<li>owner_address: Address holding the balance, lowercase-insensitive checksum form. The business key for this record. Match against operator.ogcr_wallet_address or land_manager.ogcr_wallet_address to find a party's holdings.</li>\n<li>symbol: Symbol of the CarbonCredit ERC-20.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"carbon_credit_balance_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updatecarbon_credit_balance_on_chain_ogcr","parameters":[{"name":"carboncreditbalanceonchainid","in":"path","description":"The CARBONCREDITBALANCEONCHAINID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"balance":{"type":"string"},"owner_address":{"type":"string"},"symbol":{"type":"string"},"holder_type":{"type":"string"},"batch_token_id":{"type":"integer"},"block_number":{"type":"integer"},"chain_id":{"type":"integer"},"contract_address":{"type":"string"},"decimals":{"type":"integer"}}},"example":{"balance":"1000000000000000000","batch_token_id":1,"block_number":12400,"chain_id":20253,"contract_address":"0x1B4bC0dE8b6A1A2b3C4d5E6f7A8b9C0d1E2f3A4b","decimals":18,"holder_type":"token_bound_account","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","symbol":"CC"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"carbon_credit_balance_on_chain":{"type":"object","properties":{"balance":{"type":"string"},"owner_address":{"type":"string"},"symbol":{"type":"string"},"carbon_credit_balance_on_chain_id":{"type":"string"},"holder_type":{"type":"string"},"batch_token_id":{"type":"integer"},"block_number":{"type":"integer"},"chain_id":{"type":"integer"},"contract_address":{"type":"string"},"decimals":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"carbon_credit_balance_on_chain":{"carbon_credit_balance_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","balance":"1000000000000000000","batch_token_id":1,"block_number":12400,"chain_id":20253,"contract_address":"0x1B4bC0dE8b6A1A2b3C4d5E6f7A8b9C0d1E2f3A4b","decimals":18,"holder_type":"token_bound_account","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","symbol":"CC"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Carbon_credit_balance_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete carbon_credit_balance_on_chain by id","description":"<p>Delete carbon_credit_balance_on_chain by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"carbon_credit_balance_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletecarbon_credit_balance_on_chain_ogcr","parameters":[{"name":"carboncreditbalanceonchainid","in":"path","description":"The CARBONCREDITBALANCEONCHAINID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"carbon_credit_balance_on_chain":{"type":"object","properties":{"balance":{"type":"string"},"owner_address":{"type":"string"},"symbol":{"type":"string"},"carbon_credit_balance_on_chain_id":{"type":"string"},"holder_type":{"type":"string"},"batch_token_id":{"type":"integer"},"block_number":{"type":"integer"},"chain_id":{"type":"integer"},"contract_address":{"type":"string"},"decimals":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"carbon_credit_balance_on_chain":{"carbon_credit_balance_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","balance":"1000000000000000000","batch_token_id":1,"block_number":12400,"chain_id":20253,"contract_address":"0x1B4bC0dE8b6A1A2b3C4d5E6f7A8b9C0d1E2f3A4b","decimals":18,"holder_type":"token_bound_account","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","symbol":"CC"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Carbon_credit_balance_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update carbon_credit_balance_on_chain","description":"<p>Partially update carbon_credit_balance_on_chain: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Cache of CarbonCredit (ERC-20) balances on the OGCR chain (chain id 20253). One record per holding address, covering both operator wallets and the ERC-6551 token-bound accounts of credit batches. Populated by OGCR-chain-cache, which derives the holder set from Transfer events and then reads each balance at the current head. Balances are current-state, not historical: each record is only true as of block_number.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>balance: CarbonCredit balance in smallest units, as read at block_number. Decimal string because a uint256 does not fit an integer field. Divide by 10^decimals for tonnes CO2e.</li>\n<li>batch_token_id: When holder_type is token_bound_account, the CarbonCreditBatchNFT token id this account belongs to. 0 otherwise. Join to <code>carbon_credit_batch_on_chain</code>.token_id.</li>\n<li>block_number: Block height the balance was read at.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: CarbonCredit ERC-20 contract address the balance was read from.</li>\n<li>decimals: Decimals of the CarbonCredit ERC-20, for rendering balance.</li>\n<li>holder_type: Whether this address is a plain wallet or the ERC-6551 token-bound account of a credit batch. One of: wallet, token_bound_account. A token_bound_account balance is credits still held inside their batch; a wallet balance is credits withdrawn from a batch and now pooled.</li>\n<li>owner_address: Address holding the balance, lowercase-insensitive checksum form. The business key for this record. Match against operator.ogcr_wallet_address or land_manager.ogcr_wallet_address to find a party's holdings.</li>\n<li>symbol: Symbol of the CarbonCredit ERC-20.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"carbon_credit_balance_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchcarbon_credit_balance_on_chain_ogcr","parameters":[{"name":"carboncreditbalanceonchainid","in":"path","description":"The CARBONCREDITBALANCEONCHAINID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"balance":{"type":"string"},"owner_address":{"type":"string"},"symbol":{"type":"string"},"holder_type":{"type":"string"},"batch_token_id":{"type":"integer"},"block_number":{"type":"integer"},"chain_id":{"type":"integer"},"contract_address":{"type":"string"},"decimals":{"type":"integer"}}},"example":{"balance":"1000000000000000000","batch_token_id":1,"block_number":12400,"chain_id":20253,"contract_address":"0x1B4bC0dE8b6A1A2b3C4d5E6f7A8b9C0d1E2f3A4b","decimals":18,"holder_type":"token_bound_account","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","symbol":"CC"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"carbon_credit_balance_on_chain":{"type":"object","properties":{"balance":{"type":"string"},"owner_address":{"type":"string"},"symbol":{"type":"string"},"carbon_credit_balance_on_chain_id":{"type":"string"},"holder_type":{"type":"string"},"batch_token_id":{"type":"integer"},"block_number":{"type":"integer"},"chain_id":{"type":"integer"},"contract_address":{"type":"string"},"decimals":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"carbon_credit_balance_on_chain":{"carbon_credit_balance_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","balance":"1000000000000000000","batch_token_id":1,"block_number":12400,"chain_id":20253,"contract_address":"0x1B4bC0dE8b6A1A2b3C4d5E6f7A8b9C0d1E2f3A4b","decimals":18,"holder_type":"token_bound_account","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","symbol":"CC"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/sustainable-development-goal/{sustainabledevelopmentgoalid}":{"get":{"tags":["_Sustainable_development_goal(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get sustainable_development_goal by id","description":"<p>Get sustainable_development_goal by id.</p>\n<p>This is the lookup table for sustainable development goals. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"sustainable_development_goal\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglesustainable_development_goal_ogcr","parameters":[{"name":"sustainabledevelopmentgoalid","in":"path","description":"The SUSTAINABLEDEVELOPMENTGOALID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"sustainable_development_goal":{"type":"object","properties":{"sustainable_development_goal_id":{"type":"string"},"sustainable_development_goal_name":{"type":"string"},"sustainable_development_goal_link":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"sustainable_development_goal":{"sustainable_development_goal_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","sustainable_development_goal_id":"string","sustainable_development_goal_name":"string","sustainable_development_goal_link":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Sustainable_development_goal(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update sustainable_development_goal","description":"<p>Update sustainable_development_goal.</p>\n<p>This is the lookup table for sustainable development goals. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"sustainable_development_goal\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updatesustainable_development_goal_ogcr","parameters":[{"name":"sustainabledevelopmentgoalid","in":"path","description":"The SUSTAINABLEDEVELOPMENTGOALID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"sustainable_development_goal_id":{"type":"string"},"sustainable_development_goal_name":{"type":"string"},"sustainable_development_goal_link":{"type":"string"}}},"example":{"sustainable_development_goal_id":"string","sustainable_development_goal_name":"string","sustainable_development_goal_link":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"sustainable_development_goal":{"type":"object","properties":{"sustainable_development_goal_id":{"type":"string"},"sustainable_development_goal_name":{"type":"string"},"sustainable_development_goal_link":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"sustainable_development_goal":{"sustainable_development_goal_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","sustainable_development_goal_id":"string","sustainable_development_goal_name":"string","sustainable_development_goal_link":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Sustainable_development_goal(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete sustainable_development_goal by id","description":"<p>Delete sustainable_development_goal by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"sustainable_development_goal\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletesustainable_development_goal_ogcr","parameters":[{"name":"sustainabledevelopmentgoalid","in":"path","description":"The SUSTAINABLEDEVELOPMENTGOALID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"sustainable_development_goal":{"type":"object","properties":{"sustainable_development_goal_id":{"type":"string"},"sustainable_development_goal_name":{"type":"string"},"sustainable_development_goal_link":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"sustainable_development_goal":{"sustainable_development_goal_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","sustainable_development_goal_id":"string","sustainable_development_goal_name":"string","sustainable_development_goal_link":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Sustainable_development_goal(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update sustainable_development_goal","description":"<p>Partially update sustainable_development_goal: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>This is the lookup table for sustainable development goals. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"sustainable_development_goal\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchsustainable_development_goal_ogcr","parameters":[{"name":"sustainabledevelopmentgoalid","in":"path","description":"The SUSTAINABLEDEVELOPMENTGOALID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"sustainable_development_goal_id":{"type":"string"},"sustainable_development_goal_name":{"type":"string"},"sustainable_development_goal_link":{"type":"string"}}},"example":{"sustainable_development_goal_id":"string","sustainable_development_goal_name":"string","sustainable_development_goal_link":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"sustainable_development_goal":{"type":"object","properties":{"sustainable_development_goal_id":{"type":"string"},"sustainable_development_goal_name":{"type":"string"},"sustainable_development_goal_link":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"sustainable_development_goal":{"sustainable_development_goal_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","sustainable_development_goal_id":"string","sustainable_development_goal_name":"string","sustainable_development_goal_link":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/certificate-of-compliance/{certificateofcomplianceid}":{"get":{"tags":["_Certificate_of_compliance(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public certificate_of_compliance by id","description":"<p>Get Public certificate_of_compliance by id.</p>\n<p>\u2018certificate of compliance\u2019 means a conformity statement issued by a certification body certifying that an activity complies with this Regulation;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certificate_of_compliance_id: ID of the certificate of compliance</li>\n<li>certification_scheme_id: ID of the certification scheme</li>\n<li>certification_body_id: ID of the certification body</li>\n<li>activity_id: ID of the activity being certified.</li>\n<li>country_id: Country of issuance</li>\n<li>issue_date: Issuance data</li>\n<li>expiry_date: Expiry date</li>\n<li>carbon_removals_under_baseline: Carbon removals that would have occurred under the baseline, without the activity (CO2e tonnes)</li>\n<li>soil_emissions_under_baseline: Soil emissions that would have occurred under the baseline (CO2e tonnes)</li>\n<li>permanent_net_carbon_removal_benefit: Permanent net carbon removal benefit certified for the activity (CO2e tonnes)</li>\n<li>carbon_farming_temporary_net_carbon_removal_benefit: Temporary net carbon removal benefit from carbon farming certified for the activity (CO2e tonnes)</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: Net soil emission reduction benefit from carbon farming certified for the activity (CO2e tonnes)</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: Temporary net carbon removal benefit from carbon storage in products certified for the activity (CO2e tonnes)</li>\n<li>unit_type: Unit category produced during this activity. (Permanent Removal,<br />\nCarbon Farming Sequestration, Soil Emission Reduction, Carbon Storage in Product)</li>\n<li>certification_status: The status of a certificate. Either \"Certified\" or \"Expired\"</li>\n<li>certification_scheme_rules_and_procedures: Reference to the rules and procedures of the certification scheme under which the certificate was issued</li>\n<li>certification_annual_reports: Reference to the annual reports of the certification scheme</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certificate_of_compliance\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePubliccertificate_of_compliance_ogcr","parameters":[{"name":"certificateofcomplianceid","in":"path","description":"The CERTIFICATEOFCOMPLIANCEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certificate_of_compliance":{"type":"object","properties":{"certification_annual_reports":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"carbon_removals_under_baseline":{"type":"number"},"certification_scheme_rules_and_procedures":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"number"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"expiry_date":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"certification_status":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"country_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"certificate_of_compliance":{"certificate_of_compliance_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certificate_of_compliance_id":"3dece208-c95c-11f0-9041-54e1adfac5b3","certification_scheme_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b2","activity_id":"a_05OFWI037022","audit_report_id":"string","country_id":"DE","issue_date":"2026-12-25","expiry_date":"2031-12-25","carbon_removals_under_baseline":6.5,"soil_emissions_under_baseline":6.5,"permanent_net_carbon_removal_benefit":6.5,"carbon_farming_temporary_net_carbon_removal_benefit":6.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"unit_type":"Carbon Farming Sequestration","certification_status":"Verified","certification_scheme_rules_and_procedures":"https://scheme.example.org/rules-and-procedures-v2.1.pdf","certification_annual_reports":"https://scheme.example.org/annual-report-2026.pdf"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/user-certification-body-relationship/{usercertificationbodyrelationshipid}":{"get":{"tags":["_User_certification_body_relationship(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get user_certification_body_relationship by id","description":"<p>Get user_certification_body_relationship by id.</p>\n<p>Describes the relationship between a User (the logged in User via OAuth2/OIDC or a Consent) and the Certification Body. This intersecting entity allows a many to many relationship between Users and Certification Bodies. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>user_id: (Authenticated) User</li>\n<li>certification_body_id: the certification body (uu)id</li>\n<li>relationship_to_certification_body: relationship describes the user's relationship to the certification body: the user is the subject, the certification body is the  object</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"user_certification_body_relationship\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleuser_certification_body_relationship_ogcr","parameters":[{"name":"usercertificationbodyrelationshipid","in":"path","description":"The USERCERTIFICATIONBODYRELATIONSHIPID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"user_certification_body_relationship":{"type":"object","properties":{"user_certification_body_relationship_id":{"type":"string"},"user_id":{"type":"string"},"certification_body_id":{"type":"string"},"relationship_to_certification_body":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"user_certification_body_relationship":{"user_certification_body_relationship_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_certification_body":"Managing Director, Employee, Accountant"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_User_certification_body_relationship(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update user_certification_body_relationship","description":"<p>Update user_certification_body_relationship.</p>\n<p>Describes the relationship between a User (the logged in User via OAuth2/OIDC or a Consent) and the Certification Body. This intersecting entity allows a many to many relationship between Users and Certification Bodies. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>user_id: (Authenticated) User</li>\n<li>certification_body_id: the certification body (uu)id</li>\n<li>relationship_to_certification_body: relationship describes the user's relationship to the certification body: the user is the subject, the certification body is the  object</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"user_certification_body_relationship\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateuser_certification_body_relationship_ogcr","parameters":[{"name":"usercertificationbodyrelationshipid","in":"path","description":"The USERCERTIFICATIONBODYRELATIONSHIPID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string"},"certification_body_id":{"type":"string"},"relationship_to_certification_body":{"type":"string"}}},"example":{"user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_certification_body":"Managing Director, Employee, Accountant"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"user_certification_body_relationship":{"type":"object","properties":{"user_certification_body_relationship_id":{"type":"string"},"user_id":{"type":"string"},"certification_body_id":{"type":"string"},"relationship_to_certification_body":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"user_certification_body_relationship":{"user_certification_body_relationship_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_certification_body":"Managing Director, Employee, Accountant"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_User_certification_body_relationship(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete user_certification_body_relationship by id","description":"<p>Delete user_certification_body_relationship by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"user_certification_body_relationship\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteuser_certification_body_relationship_ogcr","parameters":[{"name":"usercertificationbodyrelationshipid","in":"path","description":"The USERCERTIFICATIONBODYRELATIONSHIPID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"user_certification_body_relationship":{"type":"object","properties":{"user_certification_body_relationship_id":{"type":"string"},"user_id":{"type":"string"},"certification_body_id":{"type":"string"},"relationship_to_certification_body":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"user_certification_body_relationship":{"user_certification_body_relationship_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_certification_body":"Managing Director, Employee, Accountant"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_User_certification_body_relationship(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update user_certification_body_relationship","description":"<p>Partially update user_certification_body_relationship: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Describes the relationship between a User (the logged in User via OAuth2/OIDC or a Consent) and the Certification Body. This intersecting entity allows a many to many relationship between Users and Certification Bodies. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>user_id: (Authenticated) User</li>\n<li>certification_body_id: the certification body (uu)id</li>\n<li>relationship_to_certification_body: relationship describes the user's relationship to the certification body: the user is the subject, the certification body is the  object</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"user_certification_body_relationship\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchuser_certification_body_relationship_ogcr","parameters":[{"name":"usercertificationbodyrelationshipid","in":"path","description":"The USERCERTIFICATIONBODYRELATIONSHIPID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string"},"certification_body_id":{"type":"string"},"relationship_to_certification_body":{"type":"string"}}},"example":{"user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_certification_body":"Managing Director, Employee, Accountant"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"user_certification_body_relationship":{"type":"object","properties":{"user_certification_body_relationship_id":{"type":"string"},"user_id":{"type":"string"},"certification_body_id":{"type":"string"},"relationship_to_certification_body":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"user_certification_body_relationship":{"user_certification_body_relationship_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_certification_body":"Managing Director, Employee, Accountant"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/retirement-event/{retirementeventid}":{"get":{"tags":["_Retirement_event(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get retirement_event by id","description":"<p>Get retirement_event by id.</p>\n<p>Parsed entity retirement_event. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>retirement_event_id: Internal identifier for the retirement event</li>\n<li>carbon_credit_batch_id: Batch the retired credits are drawn from</li>\n<li>unit_type: Unit category being retired, must match the batch</li>\n<li>amount: Quantity of CO2e tonnes to retire</li>\n<li>owner_address: Wallet/TBA the credits are retired from</li>\n<li>beneficiary_name: The \"entity that uses the certified units\" (Annex III(h))</li>\n<li>end_use: Declared end-use of the unit (Recital 42)</li>\n<li>retirement_reason: Free-text claim statement</li>\n<li>status_code: in_progress, failed</li>\n<li>status_message: further explanation of status code</li>\n<li>retirement_date: Date retirement was requested</li>\n<li>certificate_of_compliance_id: Traces the unit back to its certificate</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_event\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleretirement_event_ogcr","parameters":[{"name":"retirementeventid","in":"path","description":"The RETIREMENTEVENTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_event":{"type":"object","properties":{"end_use":{"type":"string"},"unit_type":{"type":"string"},"retirement_date":{"type":"string"},"owner_address":{"type":"string"},"status_message":{"type":"string"},"carbon_credit_batch_id":{"type":"string"},"beneficiary_name":{"type":"string"},"status_code":{"type":"string"},"retirement_reason":{"type":"string"},"retirement_event_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"amount":{"type":"number"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"retirement_event":{"retirement_event_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_event_id":"ret_01JS0347FKH","carbon_credit_batch_id":"batch_03OGNWO397234DQ","unit_type":"string","amount":1.0,"owner_address":"string","beneficiary_name":"string","end_use":"string","retirement_reason":"string","status_code":"string","status_message":"string","retirement_date":"2020-01-01","certificate_of_compliance_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Retirement_event(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update retirement_event","description":"<p>Update retirement_event.</p>\n<p>Parsed entity retirement_event. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>retirement_event_id: Internal identifier for the retirement event</li>\n<li>carbon_credit_batch_id: Batch the retired credits are drawn from</li>\n<li>unit_type: Unit category being retired, must match the batch</li>\n<li>amount: Quantity of CO2e tonnes to retire</li>\n<li>owner_address: Wallet/TBA the credits are retired from</li>\n<li>beneficiary_name: The \"entity that uses the certified units\" (Annex III(h))</li>\n<li>end_use: Declared end-use of the unit (Recital 42)</li>\n<li>retirement_reason: Free-text claim statement</li>\n<li>status_code: in_progress, failed</li>\n<li>status_message: further explanation of status code</li>\n<li>retirement_date: Date retirement was requested</li>\n<li>certificate_of_compliance_id: Traces the unit back to its certificate</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_event\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateretirement_event_ogcr","parameters":[{"name":"retirementeventid","in":"path","description":"The RETIREMENTEVENTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"end_use":{"type":"string"},"unit_type":{"type":"string"},"retirement_date":{"type":"string"},"owner_address":{"type":"string"},"status_message":{"type":"string"},"carbon_credit_batch_id":{"type":"string"},"beneficiary_name":{"type":"string"},"status_code":{"type":"string"},"retirement_reason":{"type":"string"},"retirement_event_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"amount":{"type":"number"}}},"example":{"retirement_event_id":"ret_01JS0347FKH","carbon_credit_batch_id":"batch_03OGNWO397234DQ","unit_type":"string","amount":1.0,"owner_address":"string","beneficiary_name":"string","end_use":"string","retirement_reason":"string","status_code":"string","status_message":"string","retirement_date":"2020-01-01","certificate_of_compliance_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_event":{"type":"object","properties":{"end_use":{"type":"string"},"unit_type":{"type":"string"},"retirement_date":{"type":"string"},"owner_address":{"type":"string"},"status_message":{"type":"string"},"carbon_credit_batch_id":{"type":"string"},"beneficiary_name":{"type":"string"},"status_code":{"type":"string"},"retirement_reason":{"type":"string"},"retirement_event_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"amount":{"type":"number"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"retirement_event":{"retirement_event_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_event_id":"ret_01JS0347FKH","carbon_credit_batch_id":"batch_03OGNWO397234DQ","unit_type":"string","amount":1.0,"owner_address":"string","beneficiary_name":"string","end_use":"string","retirement_reason":"string","status_code":"string","status_message":"string","retirement_date":"2020-01-01","certificate_of_compliance_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Retirement_event(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete retirement_event by id","description":"<p>Delete retirement_event by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_event\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteretirement_event_ogcr","parameters":[{"name":"retirementeventid","in":"path","description":"The RETIREMENTEVENTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_event":{"type":"object","properties":{"end_use":{"type":"string"},"unit_type":{"type":"string"},"retirement_date":{"type":"string"},"owner_address":{"type":"string"},"status_message":{"type":"string"},"carbon_credit_batch_id":{"type":"string"},"beneficiary_name":{"type":"string"},"status_code":{"type":"string"},"retirement_reason":{"type":"string"},"retirement_event_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"amount":{"type":"number"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"retirement_event":{"retirement_event_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_event_id":"ret_01JS0347FKH","carbon_credit_batch_id":"batch_03OGNWO397234DQ","unit_type":"string","amount":1.0,"owner_address":"string","beneficiary_name":"string","end_use":"string","retirement_reason":"string","status_code":"string","status_message":"string","retirement_date":"2020-01-01","certificate_of_compliance_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Retirement_event(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update retirement_event","description":"<p>Partially update retirement_event: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Parsed entity retirement_event. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>retirement_event_id: Internal identifier for the retirement event</li>\n<li>carbon_credit_batch_id: Batch the retired credits are drawn from</li>\n<li>unit_type: Unit category being retired, must match the batch</li>\n<li>amount: Quantity of CO2e tonnes to retire</li>\n<li>owner_address: Wallet/TBA the credits are retired from</li>\n<li>beneficiary_name: The \"entity that uses the certified units\" (Annex III(h))</li>\n<li>end_use: Declared end-use of the unit (Recital 42)</li>\n<li>retirement_reason: Free-text claim statement</li>\n<li>status_code: in_progress, failed</li>\n<li>status_message: further explanation of status code</li>\n<li>retirement_date: Date retirement was requested</li>\n<li>certificate_of_compliance_id: Traces the unit back to its certificate</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_event\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchretirement_event_ogcr","parameters":[{"name":"retirementeventid","in":"path","description":"The RETIREMENTEVENTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"end_use":{"type":"string"},"unit_type":{"type":"string"},"retirement_date":{"type":"string"},"owner_address":{"type":"string"},"status_message":{"type":"string"},"carbon_credit_batch_id":{"type":"string"},"beneficiary_name":{"type":"string"},"status_code":{"type":"string"},"retirement_reason":{"type":"string"},"retirement_event_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"amount":{"type":"number"}}},"example":{"retirement_event_id":"ret_01JS0347FKH","carbon_credit_batch_id":"batch_03OGNWO397234DQ","unit_type":"string","amount":1.0,"owner_address":"string","beneficiary_name":"string","end_use":"string","retirement_reason":"string","status_code":"string","status_message":"string","retirement_date":"2020-01-01","certificate_of_compliance_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_event":{"type":"object","properties":{"end_use":{"type":"string"},"unit_type":{"type":"string"},"retirement_date":{"type":"string"},"owner_address":{"type":"string"},"status_message":{"type":"string"},"carbon_credit_batch_id":{"type":"string"},"beneficiary_name":{"type":"string"},"status_code":{"type":"string"},"retirement_reason":{"type":"string"},"retirement_event_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"amount":{"type":"number"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"retirement_event":{"retirement_event_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_event_id":"ret_01JS0347FKH","carbon_credit_batch_id":"batch_03OGNWO397234DQ","unit_type":"string","amount":1.0,"owner_address":"string","beneficiary_name":"string","end_use":"string","retirement_reason":"string","status_code":"string","status_message":"string","retirement_date":"2020-01-01","certificate_of_compliance_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/buffer-pool/{bufferpoolid}":{"get":{"tags":["_Buffer_pool(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get buffer_pool by id","description":"<p>Get buffer_pool by id.</p>\n<p>Parsed entity buffer_pool. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>buffer_pool_id: (uu)id of the buffer pool</li>\n<li>name: Human-readable name</li>\n<li>activity_id: ID of the activity</li>\n<li>unit_type: Which unit type it holds (the CRCF requires unit types to stay distinct)</li>\n<li>certification_scheme_id: Scheme that runs the pool</li>\n<li>rules_uri: The document defining contribution, cancellation and release rules</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"buffer_pool\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglebuffer_pool_ogcr","parameters":[{"name":"bufferpoolid","in":"path","description":"The BUFFERPOOLID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"buffer_pool":{"type":"object","properties":{"name":{"type":"string"},"buffer_pool_id":{"type":"string"},"activity_id":{"type":"string"},"rules_uri":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"buffer_pool":{"buffer_pool_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","buffer_pool_id":"string","name":"string","activity_id":"string","unit_type":"string","certification_scheme_id":"string","rules_uri":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Buffer_pool(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update buffer_pool","description":"<p>Update buffer_pool.</p>\n<p>Parsed entity buffer_pool. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>buffer_pool_id: (uu)id of the buffer pool</li>\n<li>name: Human-readable name</li>\n<li>activity_id: ID of the activity</li>\n<li>unit_type: Which unit type it holds (the CRCF requires unit types to stay distinct)</li>\n<li>certification_scheme_id: Scheme that runs the pool</li>\n<li>rules_uri: The document defining contribution, cancellation and release rules</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"buffer_pool\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updatebuffer_pool_ogcr","parameters":[{"name":"bufferpoolid","in":"path","description":"The BUFFERPOOLID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"buffer_pool_id":{"type":"string"},"activity_id":{"type":"string"},"rules_uri":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"}}},"example":{"buffer_pool_id":"string","name":"string","activity_id":"string","unit_type":"string","certification_scheme_id":"string","rules_uri":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"buffer_pool":{"type":"object","properties":{"name":{"type":"string"},"buffer_pool_id":{"type":"string"},"activity_id":{"type":"string"},"rules_uri":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"buffer_pool":{"buffer_pool_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","buffer_pool_id":"string","name":"string","activity_id":"string","unit_type":"string","certification_scheme_id":"string","rules_uri":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Buffer_pool(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete buffer_pool by id","description":"<p>Delete buffer_pool by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"buffer_pool\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletebuffer_pool_ogcr","parameters":[{"name":"bufferpoolid","in":"path","description":"The BUFFERPOOLID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"buffer_pool":{"type":"object","properties":{"name":{"type":"string"},"buffer_pool_id":{"type":"string"},"activity_id":{"type":"string"},"rules_uri":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"buffer_pool":{"buffer_pool_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","buffer_pool_id":"string","name":"string","activity_id":"string","unit_type":"string","certification_scheme_id":"string","rules_uri":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Buffer_pool(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update buffer_pool","description":"<p>Partially update buffer_pool: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Parsed entity buffer_pool. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>buffer_pool_id: (uu)id of the buffer pool</li>\n<li>name: Human-readable name</li>\n<li>activity_id: ID of the activity</li>\n<li>unit_type: Which unit type it holds (the CRCF requires unit types to stay distinct)</li>\n<li>certification_scheme_id: Scheme that runs the pool</li>\n<li>rules_uri: The document defining contribution, cancellation and release rules</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"buffer_pool\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchbuffer_pool_ogcr","parameters":[{"name":"bufferpoolid","in":"path","description":"The BUFFERPOOLID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"buffer_pool_id":{"type":"string"},"activity_id":{"type":"string"},"rules_uri":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"}}},"example":{"buffer_pool_id":"string","name":"string","activity_id":"string","unit_type":"string","certification_scheme_id":"string","rules_uri":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"buffer_pool":{"type":"object","properties":{"name":{"type":"string"},"buffer_pool_id":{"type":"string"},"activity_id":{"type":"string"},"rules_uri":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"buffer_pool":{"buffer_pool_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","buffer_pool_id":"string","name":"string","activity_id":"string","unit_type":"string","certification_scheme_id":"string","rules_uri":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/sustainable-development-goals/{sustainabledevelopmentgoalsid}":{"get":{"tags":["_Sustainable_development_goals(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public sustainable_development_goals by id","description":"<p>Get Public sustainable_development_goals by id.</p>\n<p>Entity for listing sustainable development goals being addressed by an activity. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"sustainable_development_goals\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePublicsustainable_development_goals_ogcr","parameters":[{"name":"sustainabledevelopmentgoalsid","in":"path","description":"The SUSTAINABLEDEVELOPMENTGOALSID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"sustainable_development_goals":{"type":"object","properties":{"sustainable_development_goals_id":{"type":"string"},"activity_id":{"type":"string"},"sustainable_development_goal_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"sustainable_development_goals":{"sustainable_development_goals_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","sustainable_development_goal_id":"CLIMATE_ACTION"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/authority/{authorityid}":{"get":{"tags":["_Authority(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get authority by id","description":"<p>Get authority by id.</p>\n<p>An EU or national public body that accredits, recognises or supervises. A Member State is not an entity, only the country_code on its authorities. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>authority_id: Internal identifier for the authority.</li>\n<li>legal_name: Official name of the authority.</li>\n<li>authority_type: Controlled vocabulary: eu_institution, national_competent_authority, national_accreditation_body.</li>\n<li>country_id: ISO 3166-1 alpha-2 code of the Member State. Null for EU-level bodies.</li>\n<li>department: Optional unit within the authority.</li>\n<li>email: Official contact address.</li>\n<li>website: Public URL for the authority.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"authority\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleauthority_ogcr","parameters":[{"name":"authorityid","in":"path","description":"The AUTHORITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"authority":{"type":"object","properties":{"email":{"type":"string"},"department":{"type":"string"},"legal_name":{"type":"string"},"authority_id":{"type":"string"},"country_id":{"type":"string"},"authority_type":{"type":"string"},"website":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"authority":{"authority_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","authority_id":"auth_01HZZ4K7Q2M","legal_name":"Deutsche Akkreditierungsstelle GmbH","authority_type":"national_accreditation_body","country_id":"DE","department":"DG CLIMA","email":"registry@example.eu","website":"https://example.eu"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Authority(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update authority","description":"<p>Update authority.</p>\n<p>An EU or national public body that accredits, recognises or supervises. A Member State is not an entity, only the country_code on its authorities. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>authority_id: Internal identifier for the authority.</li>\n<li>legal_name: Official name of the authority.</li>\n<li>authority_type: Controlled vocabulary: eu_institution, national_competent_authority, national_accreditation_body.</li>\n<li>country_id: ISO 3166-1 alpha-2 code of the Member State. Null for EU-level bodies.</li>\n<li>department: Optional unit within the authority.</li>\n<li>email: Official contact address.</li>\n<li>website: Public URL for the authority.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"authority\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateauthority_ogcr","parameters":[{"name":"authorityid","in":"path","description":"The AUTHORITYID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"department":{"type":"string"},"legal_name":{"type":"string"},"authority_id":{"type":"string"},"country_id":{"type":"string"},"authority_type":{"type":"string"},"website":{"type":"string"}}},"example":{"authority_id":"auth_01HZZ4K7Q2M","legal_name":"Deutsche Akkreditierungsstelle GmbH","authority_type":"national_accreditation_body","country_id":"DE","department":"DG CLIMA","email":"registry@example.eu","website":"https://example.eu"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"authority":{"type":"object","properties":{"email":{"type":"string"},"department":{"type":"string"},"legal_name":{"type":"string"},"authority_id":{"type":"string"},"country_id":{"type":"string"},"authority_type":{"type":"string"},"website":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"authority":{"authority_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","authority_id":"auth_01HZZ4K7Q2M","legal_name":"Deutsche Akkreditierungsstelle GmbH","authority_type":"national_accreditation_body","country_id":"DE","department":"DG CLIMA","email":"registry@example.eu","website":"https://example.eu"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Authority(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete authority by id","description":"<p>Delete authority by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"authority\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteauthority_ogcr","parameters":[{"name":"authorityid","in":"path","description":"The AUTHORITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"authority":{"type":"object","properties":{"email":{"type":"string"},"department":{"type":"string"},"legal_name":{"type":"string"},"authority_id":{"type":"string"},"country_id":{"type":"string"},"authority_type":{"type":"string"},"website":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"authority":{"authority_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","authority_id":"auth_01HZZ4K7Q2M","legal_name":"Deutsche Akkreditierungsstelle GmbH","authority_type":"national_accreditation_body","country_id":"DE","department":"DG CLIMA","email":"registry@example.eu","website":"https://example.eu"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Authority(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update authority","description":"<p>Partially update authority: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>An EU or national public body that accredits, recognises or supervises. A Member State is not an entity, only the country_code on its authorities. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>authority_id: Internal identifier for the authority.</li>\n<li>legal_name: Official name of the authority.</li>\n<li>authority_type: Controlled vocabulary: eu_institution, national_competent_authority, national_accreditation_body.</li>\n<li>country_id: ISO 3166-1 alpha-2 code of the Member State. Null for EU-level bodies.</li>\n<li>department: Optional unit within the authority.</li>\n<li>email: Official contact address.</li>\n<li>website: Public URL for the authority.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"authority\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchauthority_ogcr","parameters":[{"name":"authorityid","in":"path","description":"The AUTHORITYID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"department":{"type":"string"},"legal_name":{"type":"string"},"authority_id":{"type":"string"},"country_id":{"type":"string"},"authority_type":{"type":"string"},"website":{"type":"string"}}},"example":{"authority_id":"auth_01HZZ4K7Q2M","legal_name":"Deutsche Akkreditierungsstelle GmbH","authority_type":"national_accreditation_body","country_id":"DE","department":"DG CLIMA","email":"registry@example.eu","website":"https://example.eu"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"authority":{"type":"object","properties":{"email":{"type":"string"},"department":{"type":"string"},"legal_name":{"type":"string"},"authority_id":{"type":"string"},"country_id":{"type":"string"},"authority_type":{"type":"string"},"website":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"authority":{"authority_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","authority_id":"auth_01HZZ4K7Q2M","legal_name":"Deutsche Akkreditierungsstelle GmbH","authority_type":"national_accreditation_body","country_id":"DE","department":"DG CLIMA","email":"registry@example.eu","website":"https://example.eu"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/parcel-on-chain/{parcelonchainid}":{"get":{"tags":["_Parcel_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public parcel_on_chain by id","description":"<p>Get Public parcel_on_chain by id.</p>\n<p>Cache of ParcelNFT data minted on the OGCR chain (chain id 20253). One record per parcel_id, populated by OGCR-chain-cache reading the chain. Does not mutate the source <code>parcel</code> entity.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>block_number: Block number the mint was included in.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: ParcelNFT contract address the token was read from.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>parcel_hash: parcel_hash stored on-chain: keccak256 of the raw parcel entity body.</li>\n<li>parcel_id: Links to the <code>parcel</code> dynamic entity. The on-chain ParcelNFT is keyed by this id.</li>\n<li>parcel_uri: parcel_uri stored on-chain: link back to the OBP parcel entity.</li>\n<li>token_id: ParcelNFT token id minted for this parcel.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>tx_hash: Mint transaction hash (from the ParcelMinted event).</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePublicparcel_on_chain_ogcr","parameters":[{"name":"parcelonchainid","in":"path","description":"The PARCELONCHAINID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_on_chain":{"type":"object","properties":{"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"token_id":{"type":"integer"},"parcel_id":{"type":"string"},"block_number":{"type":"integer"},"parcel_uri":{"type":"string"},"chain_id":{"type":"integer"},"parcel_on_chain_id":{"type":"string"},"owner_address":{"type":"string"},"contract_address":{"type":"string"},"parcel_hash":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"parcel_on_chain":{"parcel_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","block_number":12345,"chain_id":20253,"contract_address":"0x62227531b82259561CC9ad4413188F08E536598a","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","parcel_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","parcel_id":"parcel_AB12CD34EF","parcel_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/parcel/parcel_AB12CD34EF","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiUGFyY2VsIn0=","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/supervisory-finding/{supervisoryfindingid}":{"get":{"tags":["_Supervisory_finding(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get supervisory_finding by id","description":"<p>Get supervisory_finding by id.</p>\n<p>A Member State finding of non-conformity (Art. 10). This is separate from the audit report's non_conformities_list, which the certification body writes. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>supervisory_finding_id: Internal identifier for the finding.</li>\n<li>authority_id: The authority that raised the finding.</li>\n<li>certification_body_id: The body the finding concerns.</li>\n<li>certification_scheme_id: The scheme informed. Optional.</li>\n<li>audit_report_id: The audit report concerned, if any. Optional.</li>\n<li>finding_date: Date the non-conformity was identified.</li>\n<li>description: What was found.</li>\n<li>notified_date: Date the body and scheme were informed.</li>\n<li>published: Whether the finding is public in the registry.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"supervisory_finding\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglesupervisory_finding_ogcr","parameters":[{"name":"supervisoryfindingid","in":"path","description":"The SUPERVISORYFINDINGID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"supervisory_finding":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"description":{"type":"string"},"notified_date":{"type":"string"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"authority_id":{"type":"string"},"supervisory_finding_id":{"type":"string"},"published":{"type":"boolean"},"finding_date":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"supervisory_finding":{"supervisory_finding_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supervisory_finding_id":"sf_01HZZ6P9S4Q","authority_id":"auth_01HZZ4K7Q2M","certification_body_id":"cb_01HZZ1M2A3B4C","certification_scheme_id":"cs_01HZZ1K0X5F6Q7R8S9T0","audit_report_id":"ar_01HZZ7R1T5U","finding_date":"2027-03-10","description":"Audit sampling below scheme minimum","notified_date":"2027-03-11","published":true},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Supervisory_finding(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update supervisory_finding","description":"<p>Update supervisory_finding.</p>\n<p>A Member State finding of non-conformity (Art. 10). This is separate from the audit report's non_conformities_list, which the certification body writes. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>supervisory_finding_id: Internal identifier for the finding.</li>\n<li>authority_id: The authority that raised the finding.</li>\n<li>certification_body_id: The body the finding concerns.</li>\n<li>certification_scheme_id: The scheme informed. Optional.</li>\n<li>audit_report_id: The audit report concerned, if any. Optional.</li>\n<li>finding_date: Date the non-conformity was identified.</li>\n<li>description: What was found.</li>\n<li>notified_date: Date the body and scheme were informed.</li>\n<li>published: Whether the finding is public in the registry.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"supervisory_finding\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updatesupervisory_finding_ogcr","parameters":[{"name":"supervisoryfindingid","in":"path","description":"The SUPERVISORYFINDINGID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"description":{"type":"string"},"notified_date":{"type":"string"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"authority_id":{"type":"string"},"supervisory_finding_id":{"type":"string"},"published":{"type":"boolean"},"finding_date":{"type":"string"}}},"example":{"supervisory_finding_id":"sf_01HZZ6P9S4Q","authority_id":"auth_01HZZ4K7Q2M","certification_body_id":"cb_01HZZ1M2A3B4C","certification_scheme_id":"cs_01HZZ1K0X5F6Q7R8S9T0","audit_report_id":"ar_01HZZ7R1T5U","finding_date":"2027-03-10","description":"Audit sampling below scheme minimum","notified_date":"2027-03-11","published":true}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"supervisory_finding":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"description":{"type":"string"},"notified_date":{"type":"string"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"authority_id":{"type":"string"},"supervisory_finding_id":{"type":"string"},"published":{"type":"boolean"},"finding_date":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"supervisory_finding":{"supervisory_finding_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supervisory_finding_id":"sf_01HZZ6P9S4Q","authority_id":"auth_01HZZ4K7Q2M","certification_body_id":"cb_01HZZ1M2A3B4C","certification_scheme_id":"cs_01HZZ1K0X5F6Q7R8S9T0","audit_report_id":"ar_01HZZ7R1T5U","finding_date":"2027-03-10","description":"Audit sampling below scheme minimum","notified_date":"2027-03-11","published":true},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Supervisory_finding(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete supervisory_finding by id","description":"<p>Delete supervisory_finding by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"supervisory_finding\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletesupervisory_finding_ogcr","parameters":[{"name":"supervisoryfindingid","in":"path","description":"The SUPERVISORYFINDINGID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"supervisory_finding":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"description":{"type":"string"},"notified_date":{"type":"string"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"authority_id":{"type":"string"},"supervisory_finding_id":{"type":"string"},"published":{"type":"boolean"},"finding_date":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"supervisory_finding":{"supervisory_finding_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supervisory_finding_id":"sf_01HZZ6P9S4Q","authority_id":"auth_01HZZ4K7Q2M","certification_body_id":"cb_01HZZ1M2A3B4C","certification_scheme_id":"cs_01HZZ1K0X5F6Q7R8S9T0","audit_report_id":"ar_01HZZ7R1T5U","finding_date":"2027-03-10","description":"Audit sampling below scheme minimum","notified_date":"2027-03-11","published":true},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Supervisory_finding(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update supervisory_finding","description":"<p>Partially update supervisory_finding: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>A Member State finding of non-conformity (Art. 10). This is separate from the audit report's non_conformities_list, which the certification body writes. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>supervisory_finding_id: Internal identifier for the finding.</li>\n<li>authority_id: The authority that raised the finding.</li>\n<li>certification_body_id: The body the finding concerns.</li>\n<li>certification_scheme_id: The scheme informed. Optional.</li>\n<li>audit_report_id: The audit report concerned, if any. Optional.</li>\n<li>finding_date: Date the non-conformity was identified.</li>\n<li>description: What was found.</li>\n<li>notified_date: Date the body and scheme were informed.</li>\n<li>published: Whether the finding is public in the registry.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"supervisory_finding\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchsupervisory_finding_ogcr","parameters":[{"name":"supervisoryfindingid","in":"path","description":"The SUPERVISORYFINDINGID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"description":{"type":"string"},"notified_date":{"type":"string"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"authority_id":{"type":"string"},"supervisory_finding_id":{"type":"string"},"published":{"type":"boolean"},"finding_date":{"type":"string"}}},"example":{"supervisory_finding_id":"sf_01HZZ6P9S4Q","authority_id":"auth_01HZZ4K7Q2M","certification_body_id":"cb_01HZZ1M2A3B4C","certification_scheme_id":"cs_01HZZ1K0X5F6Q7R8S9T0","audit_report_id":"ar_01HZZ7R1T5U","finding_date":"2027-03-10","description":"Audit sampling below scheme minimum","notified_date":"2027-03-11","published":true}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"supervisory_finding":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"description":{"type":"string"},"notified_date":{"type":"string"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"authority_id":{"type":"string"},"supervisory_finding_id":{"type":"string"},"published":{"type":"boolean"},"finding_date":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"supervisory_finding":{"supervisory_finding_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supervisory_finding_id":"sf_01HZZ6P9S4Q","authority_id":"auth_01HZZ4K7Q2M","certification_body_id":"cb_01HZZ1M2A3B4C","certification_scheme_id":"cs_01HZZ1K0X5F6Q7R8S9T0","audit_report_id":"ar_01HZZ7R1T5U","finding_date":"2027-03-10","description":"Audit sampling below scheme minimum","notified_date":"2027-03-11","published":true},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/activity-non-conformity":{"get":{"tags":["_Activity_non_conformity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public activity_non_conformity List","description":"<p>Get Public activity_non_conformity List.</p>\n<p>\u2018non-conformity\u2019 means a failure by an operator or a certification body to comply with the rules and procedures, established by the certification scheme, of which they are members or under which they operate. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>category: critical, major and minor</li>\n<li>remediation_timeline: Timeline for remediation of non-conformities</li>\n<li>sanction: Sanction imposed for the non-conformity, e.g. warning, suspension or withdrawal of certification</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_non_conformity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>audit_report_id</code>, <code>certification_body_id</code>, <code>certification_scheme_id</code>, <code>non_conformity_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPublicactivity_non_conformityList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_non_conformity_list":{"type":"array","items":{"type":"object","properties":{"activity_non_conformity":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"non_conformity_id":{"type":"string"},"sanction":{"type":"string"},"audit_report_id":{"type":"string"},"remediation_timeline":{"type":"string"},"activity_non_conformity_id":{"type":"string"},"certification_body_id":{"type":"string"},"category":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"activity_non_conformity_list":[{"activity_non_conformity":{"activity_non_conformity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","non_conformity_id":"string","audit_report_id":"string","category":"string","remediation_timeline":"string","sanction":"warning","certification_scheme_id":"string","certification_body_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/certificate-of-compliance":{"get":{"tags":["_Certificate_of_compliance(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get certificate_of_compliance List","description":"<p>Get certificate_of_compliance List.</p>\n<p>\u2018certificate of compliance\u2019 means a conformity statement issued by a certification body certifying that an activity complies with this Regulation;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certificate_of_compliance_id: ID of the certificate of compliance</li>\n<li>certification_scheme_id: ID of the certification scheme</li>\n<li>certification_body_id: ID of the certification body</li>\n<li>activity_id: ID of the activity being certified.</li>\n<li>country_id: Country of issuance</li>\n<li>issue_date: Issuance data</li>\n<li>expiry_date: Expiry date</li>\n<li>carbon_removals_under_baseline: Carbon removals that would have occurred under the baseline, without the activity (CO2e tonnes)</li>\n<li>soil_emissions_under_baseline: Soil emissions that would have occurred under the baseline (CO2e tonnes)</li>\n<li>permanent_net_carbon_removal_benefit: Permanent net carbon removal benefit certified for the activity (CO2e tonnes)</li>\n<li>carbon_farming_temporary_net_carbon_removal_benefit: Temporary net carbon removal benefit from carbon farming certified for the activity (CO2e tonnes)</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: Net soil emission reduction benefit from carbon farming certified for the activity (CO2e tonnes)</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: Temporary net carbon removal benefit from carbon storage in products certified for the activity (CO2e tonnes)</li>\n<li>unit_type: Unit category produced during this activity. (Permanent Removal,<br />\nCarbon Farming Sequestration, Soil Emission Reduction, Carbon Storage in Product)</li>\n<li>certification_status: The status of a certificate. Either \"Certified\" or \"Expired\"</li>\n<li>certification_scheme_rules_and_procedures: Reference to the rules and procedures of the certification scheme under which the certificate was issued</li>\n<li>certification_annual_reports: Reference to the annual reports of the certification scheme</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certificate_of_compliance\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>audit_report_id</code>, <code>certificate_of_compliance_id</code>, <code>certification_body_id</code>, <code>certification_scheme_id</code>, <code>country_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>activity_id</code> → <code>activity</code>, <code>audit_report_id</code> → <code>audit_report</code>, <code>certification_body_id</code> → <code>certification_body</code>, <code>certification_scheme_id</code> → <code>certification_scheme</code>, <code>country_id</code> → <code>country</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getcertificate_of_complianceList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certificate_of_compliance_list":{"type":"array","items":{"type":"object","properties":{"certificate_of_compliance":{"type":"object","properties":{"certification_annual_reports":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"carbon_removals_under_baseline":{"type":"number"},"certification_scheme_rules_and_procedures":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"number"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"expiry_date":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"certification_status":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"country_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"certificate_of_compliance_list":[{"certificate_of_compliance":{"certificate_of_compliance_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certificate_of_compliance_id":"3dece208-c95c-11f0-9041-54e1adfac5b3","certification_scheme_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b2","activity_id":"a_05OFWI037022","audit_report_id":"string","country_id":"DE","issue_date":"2026-12-25","expiry_date":"2031-12-25","carbon_removals_under_baseline":6.5,"soil_emissions_under_baseline":6.5,"permanent_net_carbon_removal_benefit":6.5,"carbon_farming_temporary_net_carbon_removal_benefit":6.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"unit_type":"Carbon Farming Sequestration","certification_status":"Verified","certification_scheme_rules_and_procedures":"https://scheme.example.org/rules-and-procedures-v2.1.pdf","certification_annual_reports":"https://scheme.example.org/annual-report-2026.pdf"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Certificate_of_compliance(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new certificate_of_compliance","description":"<p>Create new certificate_of_compliance.</p>\n<p>\u2018certificate of compliance\u2019 means a conformity statement issued by a certification body certifying that an activity complies with this Regulation;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certificate_of_compliance_id: ID of the certificate of compliance</li>\n<li>certification_scheme_id: ID of the certification scheme</li>\n<li>certification_body_id: ID of the certification body</li>\n<li>activity_id: ID of the activity being certified.</li>\n<li>country_id: Country of issuance</li>\n<li>issue_date: Issuance data</li>\n<li>expiry_date: Expiry date</li>\n<li>carbon_removals_under_baseline: Carbon removals that would have occurred under the baseline, without the activity (CO2e tonnes)</li>\n<li>soil_emissions_under_baseline: Soil emissions that would have occurred under the baseline (CO2e tonnes)</li>\n<li>permanent_net_carbon_removal_benefit: Permanent net carbon removal benefit certified for the activity (CO2e tonnes)</li>\n<li>carbon_farming_temporary_net_carbon_removal_benefit: Temporary net carbon removal benefit from carbon farming certified for the activity (CO2e tonnes)</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: Net soil emission reduction benefit from carbon farming certified for the activity (CO2e tonnes)</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: Temporary net carbon removal benefit from carbon storage in products certified for the activity (CO2e tonnes)</li>\n<li>unit_type: Unit category produced during this activity. (Permanent Removal,<br />\nCarbon Farming Sequestration, Soil Emission Reduction, Carbon Storage in Product)</li>\n<li>certification_status: The status of a certificate. Either \"Certified\" or \"Expired\"</li>\n<li>certification_scheme_rules_and_procedures: Reference to the rules and procedures of the certification scheme under which the certificate was issued</li>\n<li>certification_annual_reports: Reference to the annual reports of the certification scheme</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certificate_of_compliance\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createcertificate_of_compliance_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"certification_annual_reports":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"carbon_removals_under_baseline":{"type":"number"},"certification_scheme_rules_and_procedures":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"number"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"expiry_date":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"certification_status":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"country_id":{"type":"string"}}},"example":{"certificate_of_compliance_id":"3dece208-c95c-11f0-9041-54e1adfac5b3","certification_scheme_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b2","activity_id":"a_05OFWI037022","audit_report_id":"string","country_id":"DE","issue_date":"2026-12-25","expiry_date":"2031-12-25","carbon_removals_under_baseline":6.5,"soil_emissions_under_baseline":6.5,"permanent_net_carbon_removal_benefit":6.5,"carbon_farming_temporary_net_carbon_removal_benefit":6.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"unit_type":"Carbon Farming Sequestration","certification_status":"Verified","certification_scheme_rules_and_procedures":"https://scheme.example.org/rules-and-procedures-v2.1.pdf","certification_annual_reports":"https://scheme.example.org/annual-report-2026.pdf"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certificate_of_compliance":{"type":"object","properties":{"certification_annual_reports":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"carbon_removals_under_baseline":{"type":"number"},"certification_scheme_rules_and_procedures":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"number"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"expiry_date":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"certification_status":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"country_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certificate_of_compliance":{"certificate_of_compliance_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certificate_of_compliance_id":"3dece208-c95c-11f0-9041-54e1adfac5b3","certification_scheme_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b2","activity_id":"a_05OFWI037022","audit_report_id":"string","country_id":"DE","issue_date":"2026-12-25","expiry_date":"2031-12-25","carbon_removals_under_baseline":6.5,"soil_emissions_under_baseline":6.5,"permanent_net_carbon_removal_benefit":6.5,"carbon_farming_temporary_net_carbon_removal_benefit":6.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"unit_type":"Carbon Farming Sequestration","certification_status":"Verified","certification_scheme_rules_and_procedures":"https://scheme.example.org/rules-and-procedures-v2.1.pdf","certification_annual_reports":"https://scheme.example.org/annual-report-2026.pdf"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/retirement-event/{retirementeventid}":{"get":{"tags":["_Retirement_event(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public retirement_event by id","description":"<p>Get Public retirement_event by id.</p>\n<p>Parsed entity retirement_event. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>retirement_event_id: Internal identifier for the retirement event</li>\n<li>carbon_credit_batch_id: Batch the retired credits are drawn from</li>\n<li>unit_type: Unit category being retired, must match the batch</li>\n<li>amount: Quantity of CO2e tonnes to retire</li>\n<li>owner_address: Wallet/TBA the credits are retired from</li>\n<li>beneficiary_name: The \"entity that uses the certified units\" (Annex III(h))</li>\n<li>end_use: Declared end-use of the unit (Recital 42)</li>\n<li>retirement_reason: Free-text claim statement</li>\n<li>status_code: in_progress, failed</li>\n<li>status_message: further explanation of status code</li>\n<li>retirement_date: Date retirement was requested</li>\n<li>certificate_of_compliance_id: Traces the unit back to its certificate</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_event\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePublicretirement_event_ogcr","parameters":[{"name":"retirementeventid","in":"path","description":"The RETIREMENTEVENTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_event":{"type":"object","properties":{"end_use":{"type":"string"},"unit_type":{"type":"string"},"retirement_date":{"type":"string"},"owner_address":{"type":"string"},"status_message":{"type":"string"},"carbon_credit_batch_id":{"type":"string"},"beneficiary_name":{"type":"string"},"status_code":{"type":"string"},"retirement_reason":{"type":"string"},"retirement_event_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"amount":{"type":"number"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"retirement_event":{"retirement_event_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_event_id":"ret_01JS0347FKH","carbon_credit_batch_id":"batch_03OGNWO397234DQ","unit_type":"string","amount":1.0,"owner_address":"string","beneficiary_name":"string","end_use":"string","retirement_reason":"string","status_code":"string","status_message":"string","retirement_date":"2020-01-01","certificate_of_compliance_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/operator/{operatorid}":{"get":{"tags":["_Operator(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get operator by id","description":"<p>Get operator by id.</p>\n<p>\u2018operator\u2019 means any natural or legal person or public entity that operates or controls an activity, or to whom or to which decisive economic power over the technical functioning of the activity has been delegated;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>operator_id: Internal identifier for the operator entity</li>\n<li>legal_name: Legal name of the Operator.</li>\n<li>email: Operator email address.</li>\n<li>phone: Operator contact phone in international format.</li>\n<li>address_line_1: Operator primary street address (street name, building number, P.O. Box if applicable)</li>\n<li>address_line_2: Operator secondary, optional details like apartment, suite, unit, floor, or building name</li>\n<li>postcode: Operator postcode</li>\n<li>country_id: ISO 3166-1 alpha-2 country code for operator address.</li>\n<li>ogcr_wallet_address: Wallet address to send NFTs and carbon credits to after evaluation period</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"operator\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleoperator_ogcr","parameters":[{"name":"operatorid","in":"path","description":"The OPERATORID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"operator":{"type":"object","properties":{"email":{"type":"string"},"postcode":{"type":"string"},"operator_id":{"type":"string"},"ogcr_wallet_address":{"type":"string"},"address_line_2":{"type":"string"},"legal_name":{"type":"string"},"country_id":{"type":"string"},"address_line_1":{"type":"string"},"phone":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"operator":{"operator_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","operator_id":"op_01JS0347FKH","legal_name":"Agreena","email":"contact@example.com","phone":"+49 123 456 789","address_line_1":"Green Street, 20","address_line_2":"Suite 400","postcode":"10115\" or \"W1K 3JP","country_id":"DE","ogcr_wallet_address":"0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Operator(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update operator","description":"<p>Update operator.</p>\n<p>\u2018operator\u2019 means any natural or legal person or public entity that operates or controls an activity, or to whom or to which decisive economic power over the technical functioning of the activity has been delegated;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>operator_id: Internal identifier for the operator entity</li>\n<li>legal_name: Legal name of the Operator.</li>\n<li>email: Operator email address.</li>\n<li>phone: Operator contact phone in international format.</li>\n<li>address_line_1: Operator primary street address (street name, building number, P.O. Box if applicable)</li>\n<li>address_line_2: Operator secondary, optional details like apartment, suite, unit, floor, or building name</li>\n<li>postcode: Operator postcode</li>\n<li>country_id: ISO 3166-1 alpha-2 country code for operator address.</li>\n<li>ogcr_wallet_address: Wallet address to send NFTs and carbon credits to after evaluation period</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"operator\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateoperator_ogcr","parameters":[{"name":"operatorid","in":"path","description":"The OPERATORID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"postcode":{"type":"string"},"operator_id":{"type":"string"},"ogcr_wallet_address":{"type":"string"},"address_line_2":{"type":"string"},"legal_name":{"type":"string"},"country_id":{"type":"string"},"address_line_1":{"type":"string"},"phone":{"type":"string"}}},"example":{"operator_id":"op_01JS0347FKH","legal_name":"Agreena","email":"contact@example.com","phone":"+49 123 456 789","address_line_1":"Green Street, 20","address_line_2":"Suite 400","postcode":"10115\" or \"W1K 3JP","country_id":"DE","ogcr_wallet_address":"0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"operator":{"type":"object","properties":{"email":{"type":"string"},"postcode":{"type":"string"},"operator_id":{"type":"string"},"ogcr_wallet_address":{"type":"string"},"address_line_2":{"type":"string"},"legal_name":{"type":"string"},"country_id":{"type":"string"},"address_line_1":{"type":"string"},"phone":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"operator":{"operator_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","operator_id":"op_01JS0347FKH","legal_name":"Agreena","email":"contact@example.com","phone":"+49 123 456 789","address_line_1":"Green Street, 20","address_line_2":"Suite 400","postcode":"10115\" or \"W1K 3JP","country_id":"DE","ogcr_wallet_address":"0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Operator(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete operator by id","description":"<p>Delete operator by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"operator\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteoperator_ogcr","parameters":[{"name":"operatorid","in":"path","description":"The OPERATORID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"operator":{"type":"object","properties":{"email":{"type":"string"},"postcode":{"type":"string"},"operator_id":{"type":"string"},"ogcr_wallet_address":{"type":"string"},"address_line_2":{"type":"string"},"legal_name":{"type":"string"},"country_id":{"type":"string"},"address_line_1":{"type":"string"},"phone":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"operator":{"operator_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","operator_id":"op_01JS0347FKH","legal_name":"Agreena","email":"contact@example.com","phone":"+49 123 456 789","address_line_1":"Green Street, 20","address_line_2":"Suite 400","postcode":"10115\" or \"W1K 3JP","country_id":"DE","ogcr_wallet_address":"0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Operator(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update operator","description":"<p>Partially update operator: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>\u2018operator\u2019 means any natural or legal person or public entity that operates or controls an activity, or to whom or to which decisive economic power over the technical functioning of the activity has been delegated;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>operator_id: Internal identifier for the operator entity</li>\n<li>legal_name: Legal name of the Operator.</li>\n<li>email: Operator email address.</li>\n<li>phone: Operator contact phone in international format.</li>\n<li>address_line_1: Operator primary street address (street name, building number, P.O. Box if applicable)</li>\n<li>address_line_2: Operator secondary, optional details like apartment, suite, unit, floor, or building name</li>\n<li>postcode: Operator postcode</li>\n<li>country_id: ISO 3166-1 alpha-2 country code for operator address.</li>\n<li>ogcr_wallet_address: Wallet address to send NFTs and carbon credits to after evaluation period</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"operator\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchoperator_ogcr","parameters":[{"name":"operatorid","in":"path","description":"The OPERATORID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"postcode":{"type":"string"},"operator_id":{"type":"string"},"ogcr_wallet_address":{"type":"string"},"address_line_2":{"type":"string"},"legal_name":{"type":"string"},"country_id":{"type":"string"},"address_line_1":{"type":"string"},"phone":{"type":"string"}}},"example":{"operator_id":"op_01JS0347FKH","legal_name":"Agreena","email":"contact@example.com","phone":"+49 123 456 789","address_line_1":"Green Street, 20","address_line_2":"Suite 400","postcode":"10115\" or \"W1K 3JP","country_id":"DE","ogcr_wallet_address":"0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"operator":{"type":"object","properties":{"email":{"type":"string"},"postcode":{"type":"string"},"operator_id":{"type":"string"},"ogcr_wallet_address":{"type":"string"},"address_line_2":{"type":"string"},"legal_name":{"type":"string"},"country_id":{"type":"string"},"address_line_1":{"type":"string"},"phone":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"operator":{"operator_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","operator_id":"op_01JS0347FKH","legal_name":"Agreena","email":"contact@example.com","phone":"+49 123 456 789","address_line_1":"Green Street, 20","address_line_2":"Suite 400","postcode":"10115\" or \"W1K 3JP","country_id":"DE","ogcr_wallet_address":"0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/growing-season/{growingseasonid}":{"get":{"tags":["_Growing_season(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get growing_season by id","description":"<p>Get growing_season by id.</p>\n<p>Records one growing season of a specific crop on a specific parcel. Because a single parcel can host multiple crops across seasons (rotation) or simultaneously (intercropping), this entity is separate from the parcel and linked to it via parcel_id. Each record captures what was grown, when, on how much area, and how much was harvested. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>growing_season_id: Unique internal identifier automatically assigned to each crop season record.</li>\n<li>parcel_id: The identifier of the parcel on which this crop was grown. Links this crop season to the parcel's geometry, ownership, and dNFT records.</li>\n<li>crop_id: Reference to the crop type entry in the Crop reference table. Determines commodity category and emission factor for Scope 3 calculations.</li>\n<li>start_date: The date the crop was sown or planted on this parcel. Used to define the growing season window for MRV alignment and corporate reporting period matching.</li>\n<li>end_date: The date the crop was harvested or the growing season ended. Together with season_start_date, this defines the period covered by any yield and dMRV observations for this crop instance.</li>\n<li>year: The calendar year in which the majority of this growing season falls. Used as a simple label for annual reporting and filtering, especially when a season spans two calendar years.</li>\n<li>is_cover_crop: Indicates whether this crop is grown primarily to protect or enrich the soil between main cash crop seasons, rather than for commercial harvest. Cover crops are a key carbon farming practice that can affect SOC baselines and additionality assessments.</li>\n<li>crop_area_ha: The area of the parcel actually planted with this crop, in hectares. This may be less than the total parcel area if part of the parcel is left as buffer strips, tracks, or planted with a different crop. Required for dMRV spatial weighting (SOC and biomass estimates are per hectare and must be scaled to area) and for Scope 3 supply shed area aggregation.</li>\n<li>yield_kg_per_ha: The harvested yield of this crop expressed in kilograms per hectare. This is the core denominator for emission intensity calculations under the GHG Protocol FLAG approach (e.g., kg CO2e per tonne of wheat), which agrifood companies use for Scope 3 reporting.</li>\n<li>yield_total_kg: Total harvested yield for this crop season on this parcel, in kilograms. Can be entered directly by the farmer or derived from yield_kg_ha × crop_area_ha. Used to report sourcing volumes in lease contracts.</li>\n<li>yield_source: Indicates how the yield figure was obtained, affecting the assurance level buyers can claim in CSRD or SBTi reports. Controlled vocabulary: farmer_reported, dMRV_estimated, third_party_verified.</li>\n<li>farming_practice: The farming management approach applied during this growing season. This is what distinguishes a carbon farming activity from a conventional baseline and drives additionality. Controlled vocabulary: conventional, no_till, reduced_till, organic, regenerative, agroforestry.</li>\n<li>fertiliser_use_kg_per_ha: Total nitrogen fertiliser applied during this season, in kilograms per hectare. Used to estimate N2O emissions (a potent greenhouse gas from agricultural soils), which must be subtracted from the net carbon benefit under CRCF accounting rules.</li>\n<li>residue_management: How crop residues (straw, stems, leaves) are handled after harvest. This directly affects soil organic carbon dynamics. Controlled vocabulary: incorporated (ploughed back in), removed (baled and sold), burned.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"growing_season\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglegrowing_season_ogcr","parameters":[{"name":"growingseasonid","in":"path","description":"The GROWINGSEASONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"growing_season":{"type":"object","properties":{"yield_kg_per_ha":{"type":"number"},"start_date":{"type":"string"},"crop_id":{"type":"string"},"crop_area_ha":{"type":"number"},"yield_total_kg":{"type":"number"},"year":{"type":"integer"},"is_cover_crop":{"type":"boolean"},"yield_source":{"type":"string"},"end_date":{"type":"string"},"parcel_id":{"type":"string"},"fertiliser_use_kg_per_ha":{"type":"number"},"farming_practice":{"type":"string"},"growing_season_id":{"type":"string"},"residue_management":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"growing_season":{"growing_season_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","growing_season_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","crop_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","start_date":"2026-10-15","end_date":"2027-07-20","year":2027,"is_cover_crop":true,"crop_area_ha":7.4,"yield_kg_per_ha":6200.0,"yield_total_kg":45880.0,"yield_source":"farmer_reported","farming_practice":"no_till","fertiliser_use_kg_per_ha":120.0,"residue_management":"incorporated"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Growing_season(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update growing_season","description":"<p>Update growing_season.</p>\n<p>Records one growing season of a specific crop on a specific parcel. Because a single parcel can host multiple crops across seasons (rotation) or simultaneously (intercropping), this entity is separate from the parcel and linked to it via parcel_id. Each record captures what was grown, when, on how much area, and how much was harvested. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>growing_season_id: Unique internal identifier automatically assigned to each crop season record.</li>\n<li>parcel_id: The identifier of the parcel on which this crop was grown. Links this crop season to the parcel's geometry, ownership, and dNFT records.</li>\n<li>crop_id: Reference to the crop type entry in the Crop reference table. Determines commodity category and emission factor for Scope 3 calculations.</li>\n<li>start_date: The date the crop was sown or planted on this parcel. Used to define the growing season window for MRV alignment and corporate reporting period matching.</li>\n<li>end_date: The date the crop was harvested or the growing season ended. Together with season_start_date, this defines the period covered by any yield and dMRV observations for this crop instance.</li>\n<li>year: The calendar year in which the majority of this growing season falls. Used as a simple label for annual reporting and filtering, especially when a season spans two calendar years.</li>\n<li>is_cover_crop: Indicates whether this crop is grown primarily to protect or enrich the soil between main cash crop seasons, rather than for commercial harvest. Cover crops are a key carbon farming practice that can affect SOC baselines and additionality assessments.</li>\n<li>crop_area_ha: The area of the parcel actually planted with this crop, in hectares. This may be less than the total parcel area if part of the parcel is left as buffer strips, tracks, or planted with a different crop. Required for dMRV spatial weighting (SOC and biomass estimates are per hectare and must be scaled to area) and for Scope 3 supply shed area aggregation.</li>\n<li>yield_kg_per_ha: The harvested yield of this crop expressed in kilograms per hectare. This is the core denominator for emission intensity calculations under the GHG Protocol FLAG approach (e.g., kg CO2e per tonne of wheat), which agrifood companies use for Scope 3 reporting.</li>\n<li>yield_total_kg: Total harvested yield for this crop season on this parcel, in kilograms. Can be entered directly by the farmer or derived from yield_kg_ha × crop_area_ha. Used to report sourcing volumes in lease contracts.</li>\n<li>yield_source: Indicates how the yield figure was obtained, affecting the assurance level buyers can claim in CSRD or SBTi reports. Controlled vocabulary: farmer_reported, dMRV_estimated, third_party_verified.</li>\n<li>farming_practice: The farming management approach applied during this growing season. This is what distinguishes a carbon farming activity from a conventional baseline and drives additionality. Controlled vocabulary: conventional, no_till, reduced_till, organic, regenerative, agroforestry.</li>\n<li>fertiliser_use_kg_per_ha: Total nitrogen fertiliser applied during this season, in kilograms per hectare. Used to estimate N2O emissions (a potent greenhouse gas from agricultural soils), which must be subtracted from the net carbon benefit under CRCF accounting rules.</li>\n<li>residue_management: How crop residues (straw, stems, leaves) are handled after harvest. This directly affects soil organic carbon dynamics. Controlled vocabulary: incorporated (ploughed back in), removed (baled and sold), burned.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"growing_season\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updategrowing_season_ogcr","parameters":[{"name":"growingseasonid","in":"path","description":"The GROWINGSEASONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"yield_kg_per_ha":{"type":"number"},"start_date":{"type":"string"},"crop_id":{"type":"string"},"crop_area_ha":{"type":"number"},"yield_total_kg":{"type":"number"},"year":{"type":"integer"},"is_cover_crop":{"type":"boolean"},"yield_source":{"type":"string"},"end_date":{"type":"string"},"parcel_id":{"type":"string"},"fertiliser_use_kg_per_ha":{"type":"number"},"farming_practice":{"type":"string"},"growing_season_id":{"type":"string"},"residue_management":{"type":"string"}}},"example":{"growing_season_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","crop_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","start_date":"2026-10-15","end_date":"2027-07-20","year":2027,"is_cover_crop":true,"crop_area_ha":7.4,"yield_kg_per_ha":6200.0,"yield_total_kg":45880.0,"yield_source":"farmer_reported","farming_practice":"no_till","fertiliser_use_kg_per_ha":120.0,"residue_management":"incorporated"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"growing_season":{"type":"object","properties":{"yield_kg_per_ha":{"type":"number"},"start_date":{"type":"string"},"crop_id":{"type":"string"},"crop_area_ha":{"type":"number"},"yield_total_kg":{"type":"number"},"year":{"type":"integer"},"is_cover_crop":{"type":"boolean"},"yield_source":{"type":"string"},"end_date":{"type":"string"},"parcel_id":{"type":"string"},"fertiliser_use_kg_per_ha":{"type":"number"},"farming_practice":{"type":"string"},"growing_season_id":{"type":"string"},"residue_management":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"growing_season":{"growing_season_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","growing_season_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","crop_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","start_date":"2026-10-15","end_date":"2027-07-20","year":2027,"is_cover_crop":true,"crop_area_ha":7.4,"yield_kg_per_ha":6200.0,"yield_total_kg":45880.0,"yield_source":"farmer_reported","farming_practice":"no_till","fertiliser_use_kg_per_ha":120.0,"residue_management":"incorporated"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Growing_season(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete growing_season by id","description":"<p>Delete growing_season by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"growing_season\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletegrowing_season_ogcr","parameters":[{"name":"growingseasonid","in":"path","description":"The GROWINGSEASONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"growing_season":{"type":"object","properties":{"yield_kg_per_ha":{"type":"number"},"start_date":{"type":"string"},"crop_id":{"type":"string"},"crop_area_ha":{"type":"number"},"yield_total_kg":{"type":"number"},"year":{"type":"integer"},"is_cover_crop":{"type":"boolean"},"yield_source":{"type":"string"},"end_date":{"type":"string"},"parcel_id":{"type":"string"},"fertiliser_use_kg_per_ha":{"type":"number"},"farming_practice":{"type":"string"},"growing_season_id":{"type":"string"},"residue_management":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"growing_season":{"growing_season_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","growing_season_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","crop_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","start_date":"2026-10-15","end_date":"2027-07-20","year":2027,"is_cover_crop":true,"crop_area_ha":7.4,"yield_kg_per_ha":6200.0,"yield_total_kg":45880.0,"yield_source":"farmer_reported","farming_practice":"no_till","fertiliser_use_kg_per_ha":120.0,"residue_management":"incorporated"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Growing_season(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update growing_season","description":"<p>Partially update growing_season: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Records one growing season of a specific crop on a specific parcel. Because a single parcel can host multiple crops across seasons (rotation) or simultaneously (intercropping), this entity is separate from the parcel and linked to it via parcel_id. Each record captures what was grown, when, on how much area, and how much was harvested. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>growing_season_id: Unique internal identifier automatically assigned to each crop season record.</li>\n<li>parcel_id: The identifier of the parcel on which this crop was grown. Links this crop season to the parcel's geometry, ownership, and dNFT records.</li>\n<li>crop_id: Reference to the crop type entry in the Crop reference table. Determines commodity category and emission factor for Scope 3 calculations.</li>\n<li>start_date: The date the crop was sown or planted on this parcel. Used to define the growing season window for MRV alignment and corporate reporting period matching.</li>\n<li>end_date: The date the crop was harvested or the growing season ended. Together with season_start_date, this defines the period covered by any yield and dMRV observations for this crop instance.</li>\n<li>year: The calendar year in which the majority of this growing season falls. Used as a simple label for annual reporting and filtering, especially when a season spans two calendar years.</li>\n<li>is_cover_crop: Indicates whether this crop is grown primarily to protect or enrich the soil between main cash crop seasons, rather than for commercial harvest. Cover crops are a key carbon farming practice that can affect SOC baselines and additionality assessments.</li>\n<li>crop_area_ha: The area of the parcel actually planted with this crop, in hectares. This may be less than the total parcel area if part of the parcel is left as buffer strips, tracks, or planted with a different crop. Required for dMRV spatial weighting (SOC and biomass estimates are per hectare and must be scaled to area) and for Scope 3 supply shed area aggregation.</li>\n<li>yield_kg_per_ha: The harvested yield of this crop expressed in kilograms per hectare. This is the core denominator for emission intensity calculations under the GHG Protocol FLAG approach (e.g., kg CO2e per tonne of wheat), which agrifood companies use for Scope 3 reporting.</li>\n<li>yield_total_kg: Total harvested yield for this crop season on this parcel, in kilograms. Can be entered directly by the farmer or derived from yield_kg_ha × crop_area_ha. Used to report sourcing volumes in lease contracts.</li>\n<li>yield_source: Indicates how the yield figure was obtained, affecting the assurance level buyers can claim in CSRD or SBTi reports. Controlled vocabulary: farmer_reported, dMRV_estimated, third_party_verified.</li>\n<li>farming_practice: The farming management approach applied during this growing season. This is what distinguishes a carbon farming activity from a conventional baseline and drives additionality. Controlled vocabulary: conventional, no_till, reduced_till, organic, regenerative, agroforestry.</li>\n<li>fertiliser_use_kg_per_ha: Total nitrogen fertiliser applied during this season, in kilograms per hectare. Used to estimate N2O emissions (a potent greenhouse gas from agricultural soils), which must be subtracted from the net carbon benefit under CRCF accounting rules.</li>\n<li>residue_management: How crop residues (straw, stems, leaves) are handled after harvest. This directly affects soil organic carbon dynamics. Controlled vocabulary: incorporated (ploughed back in), removed (baled and sold), burned.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"growing_season\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchgrowing_season_ogcr","parameters":[{"name":"growingseasonid","in":"path","description":"The GROWINGSEASONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"yield_kg_per_ha":{"type":"number"},"start_date":{"type":"string"},"crop_id":{"type":"string"},"crop_area_ha":{"type":"number"},"yield_total_kg":{"type":"number"},"year":{"type":"integer"},"is_cover_crop":{"type":"boolean"},"yield_source":{"type":"string"},"end_date":{"type":"string"},"parcel_id":{"type":"string"},"fertiliser_use_kg_per_ha":{"type":"number"},"farming_practice":{"type":"string"},"growing_season_id":{"type":"string"},"residue_management":{"type":"string"}}},"example":{"growing_season_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","crop_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","start_date":"2026-10-15","end_date":"2027-07-20","year":2027,"is_cover_crop":true,"crop_area_ha":7.4,"yield_kg_per_ha":6200.0,"yield_total_kg":45880.0,"yield_source":"farmer_reported","farming_practice":"no_till","fertiliser_use_kg_per_ha":120.0,"residue_management":"incorporated"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"growing_season":{"type":"object","properties":{"yield_kg_per_ha":{"type":"number"},"start_date":{"type":"string"},"crop_id":{"type":"string"},"crop_area_ha":{"type":"number"},"yield_total_kg":{"type":"number"},"year":{"type":"integer"},"is_cover_crop":{"type":"boolean"},"yield_source":{"type":"string"},"end_date":{"type":"string"},"parcel_id":{"type":"string"},"fertiliser_use_kg_per_ha":{"type":"number"},"farming_practice":{"type":"string"},"growing_season_id":{"type":"string"},"residue_management":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"growing_season":{"growing_season_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","growing_season_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","crop_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","start_date":"2026-10-15","end_date":"2027-07-20","year":2027,"is_cover_crop":true,"crop_area_ha":7.4,"yield_kg_per_ha":6200.0,"yield_total_kg":45880.0,"yield_source":"farmer_reported","farming_practice":"no_till","fertiliser_use_kg_per_ha":120.0,"residue_management":"incorporated"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/carbon-credit-batch-on-chain/{carboncreditbatchonchainid}":{"get":{"tags":["_Carbon_credit_batch_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get carbon_credit_batch_on_chain by id","description":"<p>Get carbon_credit_batch_on_chain by id.</p>\n<p>Cache of CarbonCreditBatchNFT data minted on the OGCR chain (chain id 20253). One record per carbon_credit_batch_id: the units of one unit type issued for an activity over one monitoring period. Each batch owns an ERC-6551 token-bound account that holds its CarbonCredit (ERC-20) balance. Populated by OGCR-chain-cache reading the chain. Join to <code>activity_on_chain</code> on activity_id (or activity_nft_id = token_id) to reach the OBP activity.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_hash: activity_hash stored on-chain: keccak256 of the raw activity entity body.</li>\n<li>activity_id: activity_id this batch was issued for, as stored on-chain.</li>\n<li>activity_name: Activity name as stored on-chain.</li>\n<li>activity_nft_id: ActivityNFT token id this batch was issued against. Join to <code>activity_on_chain</code>.token_id to reach the OBP activity_id.</li>\n<li>activity_url: activity_url stored on-chain: link back to the OBP activity entity.</li>\n<li>amount: Units issued for the batch, fixed at mint, in CarbonCredit base units (18 decimals): 6.5 tonnes is 6500000000000000000. Decimal string because a uint256 does not fit an integer field. The live balance is credit_balance.</li>\n<li>batch_name: Display name of the batch by unit type, as stored on-chain.</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>block_number_balance: Block height the credit_balance was read at. Unlike the mint fields, the balance is current-state, not historical, so it is only true as of this block.</li>\n<li>carbon_credit_batch_id: Business key for this record, as stored on-chain. The contract permits one batch token per id (tokenIdByBatchId), so it is used to match records for upsert.</li>\n<li>certificate_of_compliance_hash: certificate_of_compliance_hash stored on-chain: keccak256 of the raw certificate_of_compliance entity body.</li>\n<li>certificate_of_compliance_uri: certificate_of_compliance_uri stored on-chain: link back to the OBP certificate_of_compliance entity.</li>\n<li>certification_body_hash: certification_body_hash stored on-chain: keccak256 of the raw certification body entity body.</li>\n<li>certification_body_url: certification_body_url stored on-chain: link back to the OBP certification body entity.</li>\n<li>certification_scheme_hash: certification_scheme_hash stored on-chain: keccak256 of the raw certification scheme entity body.</li>\n<li>certification_scheme_url: certification_scheme_url stored on-chain: link back to the OBP certification_scheme entity.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: CarbonCreditBatchNFT contract address the token was read from.</li>\n<li>country_id: Country id as stored on-chain.</li>\n<li>credit_balance: CarbonCredit (ERC-20) balance held by token_bound_account, in smallest units, as read at block_number_balance. Decimal string because a uint256 does not fit an integer field. Divide by 10^credit_decimals for tonnes CO2e. Empty when no CarbonCredit contract address is configured.</li>\n<li>credit_contract_address: CarbonCredit ERC-20 contract address the balance was read from.</li>\n<li>credit_decimals: Decimals of the CarbonCredit ERC-20, for rendering credit_balance. 0 when no CarbonCredit contract address is configured.</li>\n<li>expiry_date: Batch expiry date as stored on-chain.</li>\n<li>issue_date: Batch issue date as stored on-chain.</li>\n<li>monitoring_period_end_date: Monitoring period end date as stored on-chain.</li>\n<li>monitoring_period_start_date: Monitoring period start date as stored on-chain.</li>\n<li>operator_hash: operator_hash stored on-chain: keccak256 of the raw operator entity body.</li>\n<li>operator_url: operator_url stored on-chain: link back to the OBP operator entity.</li>\n<li>owner_address: Current owner of the batch NFT (operator OGCR wallet address). Owning the NFT gates the right to move the credits held in its token-bound account.</li>\n<li>status_code: Batch status as stored on-chain.</li>\n<li>token_bound_account: ERC-6551 token-bound account for this batch. This address holds the batch's CarbonCredit (ERC-20) balance.</li>\n<li>token_id: CarbonCreditBatchNFT token id, unique per contract. Records are matched on carbon_credit_batch_id rather than this, so that the match uses a string field.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI, rendered on-chain from the batch data).</li>\n<li>tx_hash: Mint transaction hash (from the BatchMinted event).</li>\n<li>unit_type: CRCF unit type this batch represents, as stored on-chain.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"carbon_credit_batch_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglecarbon_credit_batch_on_chain_ogcr","parameters":[{"name":"carboncreditbatchonchainid","in":"path","description":"The CARBONCREDITBATCHONCHAINID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"carbon_credit_batch_on_chain":{"type":"object","properties":{"activity_nft_id":{"type":"integer"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"block_number_balance":{"type":"integer"},"contract_address":{"type":"string"},"operator_hash":{"type":"string"},"carbon_credit_batch_on_chain_id":{"type":"string"},"unit_type":{"type":"string"},"credit_contract_address":{"type":"string"},"token_uri":{"type":"string"},"certificate_of_compliance_hash":{"type":"string"},"status_code":{"type":"string"},"credit_decimals":{"type":"integer"},"monitoring_period_end_date":{"type":"string"},"amount":{"type":"string"},"issue_date":{"type":"string"},"certificate_of_compliance_uri":{"type":"string"},"activity_url":{"type":"string"},"token_bound_account":{"type":"string"},"certification_scheme_hash":{"type":"string"},"certification_scheme_url":{"type":"string"},"certification_body_url":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"integer"},"activity_name":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"batch_name":{"type":"string"},"operator_url":{"type":"string"},"activity_hash":{"type":"string"},"block_number":{"type":"integer"},"carbon_credit_batch_id":{"type":"string"},"country_id":{"type":"string"},"certification_body_hash":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"},"credit_balance":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"carbon_credit_batch_on_chain":{"carbon_credit_batch_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_name":"Reforestation 2024","activity_nft_id":1,"activity_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/activity/activity_AB12CD34EF","amount":"6500000000000000000","batch_name":"Permanent Removals Carbon Credit Batch","block_number":12345,"block_number_balance":12400,"carbon_credit_batch_id":"verification_AB12:permanent_removal","certificate_of_compliance_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certificate_of_compliance_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certificate_of_compliance/coc_AB12CD34EF","certification_body_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_body_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/certification_body/body_VERRA","certification_scheme_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_scheme_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/certification_scheme/scheme_SALUS","chain_id":20253,"contract_address":"0x38cF23C52Bb4B13F051Aec09580a2dE845a7FA35","country_id":"DK","credit_balance":"1000000000000000000","credit_contract_address":"0x1B4bC0dE8b6A1A2b3C4d5E6f7A8b9C0d1E2f3A4b","credit_decimals":18,"expiry_date":"2030-01-01","issue_date":"2025-01-01","monitoring_period_end_date":"2024-12-31","monitoring_period_start_date":"2024-01-01","operator_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","operator_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/operator/op_01JS0347FKH","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","status_code":"issued","token_bound_account":"0x9F2fCc7C4E1C0eA0dB1A0EbD79b0Cc7Ee4c3e5a1","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQmF0Y2gifQ==","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_type":"Permanent Removal"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Carbon_credit_batch_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update carbon_credit_batch_on_chain","description":"<p>Update carbon_credit_batch_on_chain.</p>\n<p>Cache of CarbonCreditBatchNFT data minted on the OGCR chain (chain id 20253). One record per carbon_credit_batch_id: the units of one unit type issued for an activity over one monitoring period. Each batch owns an ERC-6551 token-bound account that holds its CarbonCredit (ERC-20) balance. Populated by OGCR-chain-cache reading the chain. Join to <code>activity_on_chain</code> on activity_id (or activity_nft_id = token_id) to reach the OBP activity.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_hash: activity_hash stored on-chain: keccak256 of the raw activity entity body.</li>\n<li>activity_id: activity_id this batch was issued for, as stored on-chain.</li>\n<li>activity_name: Activity name as stored on-chain.</li>\n<li>activity_nft_id: ActivityNFT token id this batch was issued against. Join to <code>activity_on_chain</code>.token_id to reach the OBP activity_id.</li>\n<li>activity_url: activity_url stored on-chain: link back to the OBP activity entity.</li>\n<li>amount: Units issued for the batch, fixed at mint, in CarbonCredit base units (18 decimals): 6.5 tonnes is 6500000000000000000. Decimal string because a uint256 does not fit an integer field. The live balance is credit_balance.</li>\n<li>batch_name: Display name of the batch by unit type, as stored on-chain.</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>block_number_balance: Block height the credit_balance was read at. Unlike the mint fields, the balance is current-state, not historical, so it is only true as of this block.</li>\n<li>carbon_credit_batch_id: Business key for this record, as stored on-chain. The contract permits one batch token per id (tokenIdByBatchId), so it is used to match records for upsert.</li>\n<li>certificate_of_compliance_hash: certificate_of_compliance_hash stored on-chain: keccak256 of the raw certificate_of_compliance entity body.</li>\n<li>certificate_of_compliance_uri: certificate_of_compliance_uri stored on-chain: link back to the OBP certificate_of_compliance entity.</li>\n<li>certification_body_hash: certification_body_hash stored on-chain: keccak256 of the raw certification body entity body.</li>\n<li>certification_body_url: certification_body_url stored on-chain: link back to the OBP certification body entity.</li>\n<li>certification_scheme_hash: certification_scheme_hash stored on-chain: keccak256 of the raw certification scheme entity body.</li>\n<li>certification_scheme_url: certification_scheme_url stored on-chain: link back to the OBP certification_scheme entity.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: CarbonCreditBatchNFT contract address the token was read from.</li>\n<li>country_id: Country id as stored on-chain.</li>\n<li>credit_balance: CarbonCredit (ERC-20) balance held by token_bound_account, in smallest units, as read at block_number_balance. Decimal string because a uint256 does not fit an integer field. Divide by 10^credit_decimals for tonnes CO2e. Empty when no CarbonCredit contract address is configured.</li>\n<li>credit_contract_address: CarbonCredit ERC-20 contract address the balance was read from.</li>\n<li>credit_decimals: Decimals of the CarbonCredit ERC-20, for rendering credit_balance. 0 when no CarbonCredit contract address is configured.</li>\n<li>expiry_date: Batch expiry date as stored on-chain.</li>\n<li>issue_date: Batch issue date as stored on-chain.</li>\n<li>monitoring_period_end_date: Monitoring period end date as stored on-chain.</li>\n<li>monitoring_period_start_date: Monitoring period start date as stored on-chain.</li>\n<li>operator_hash: operator_hash stored on-chain: keccak256 of the raw operator entity body.</li>\n<li>operator_url: operator_url stored on-chain: link back to the OBP operator entity.</li>\n<li>owner_address: Current owner of the batch NFT (operator OGCR wallet address). Owning the NFT gates the right to move the credits held in its token-bound account.</li>\n<li>status_code: Batch status as stored on-chain.</li>\n<li>token_bound_account: ERC-6551 token-bound account for this batch. This address holds the batch's CarbonCredit (ERC-20) balance.</li>\n<li>token_id: CarbonCreditBatchNFT token id, unique per contract. Records are matched on carbon_credit_batch_id rather than this, so that the match uses a string field.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI, rendered on-chain from the batch data).</li>\n<li>tx_hash: Mint transaction hash (from the BatchMinted event).</li>\n<li>unit_type: CRCF unit type this batch represents, as stored on-chain.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"carbon_credit_batch_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updatecarbon_credit_batch_on_chain_ogcr","parameters":[{"name":"carboncreditbatchonchainid","in":"path","description":"The CARBONCREDITBATCHONCHAINID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"activity_nft_id":{"type":"integer"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"block_number_balance":{"type":"integer"},"contract_address":{"type":"string"},"operator_hash":{"type":"string"},"unit_type":{"type":"string"},"credit_contract_address":{"type":"string"},"token_uri":{"type":"string"},"certificate_of_compliance_hash":{"type":"string"},"status_code":{"type":"string"},"credit_decimals":{"type":"integer"},"monitoring_period_end_date":{"type":"string"},"amount":{"type":"string"},"issue_date":{"type":"string"},"certificate_of_compliance_uri":{"type":"string"},"activity_url":{"type":"string"},"token_bound_account":{"type":"string"},"certification_scheme_hash":{"type":"string"},"certification_scheme_url":{"type":"string"},"certification_body_url":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"integer"},"activity_name":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"batch_name":{"type":"string"},"operator_url":{"type":"string"},"activity_hash":{"type":"string"},"block_number":{"type":"integer"},"carbon_credit_batch_id":{"type":"string"},"country_id":{"type":"string"},"certification_body_hash":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"},"credit_balance":{"type":"string"}}},"example":{"activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_name":"Reforestation 2024","activity_nft_id":1,"activity_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/activity/activity_AB12CD34EF","amount":"6500000000000000000","batch_name":"Permanent Removals Carbon Credit Batch","block_number":12345,"block_number_balance":12400,"carbon_credit_batch_id":"verification_AB12:permanent_removal","certificate_of_compliance_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certificate_of_compliance_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certificate_of_compliance/coc_AB12CD34EF","certification_body_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_body_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/certification_body/body_VERRA","certification_scheme_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_scheme_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/certification_scheme/scheme_SALUS","chain_id":20253,"contract_address":"0x38cF23C52Bb4B13F051Aec09580a2dE845a7FA35","country_id":"DK","credit_balance":"1000000000000000000","credit_contract_address":"0x1B4bC0dE8b6A1A2b3C4d5E6f7A8b9C0d1E2f3A4b","credit_decimals":18,"expiry_date":"2030-01-01","issue_date":"2025-01-01","monitoring_period_end_date":"2024-12-31","monitoring_period_start_date":"2024-01-01","operator_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","operator_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/operator/op_01JS0347FKH","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","status_code":"issued","token_bound_account":"0x9F2fCc7C4E1C0eA0dB1A0EbD79b0Cc7Ee4c3e5a1","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQmF0Y2gifQ==","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_type":"Permanent Removal"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"carbon_credit_batch_on_chain":{"type":"object","properties":{"activity_nft_id":{"type":"integer"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"block_number_balance":{"type":"integer"},"contract_address":{"type":"string"},"operator_hash":{"type":"string"},"carbon_credit_batch_on_chain_id":{"type":"string"},"unit_type":{"type":"string"},"credit_contract_address":{"type":"string"},"token_uri":{"type":"string"},"certificate_of_compliance_hash":{"type":"string"},"status_code":{"type":"string"},"credit_decimals":{"type":"integer"},"monitoring_period_end_date":{"type":"string"},"amount":{"type":"string"},"issue_date":{"type":"string"},"certificate_of_compliance_uri":{"type":"string"},"activity_url":{"type":"string"},"token_bound_account":{"type":"string"},"certification_scheme_hash":{"type":"string"},"certification_scheme_url":{"type":"string"},"certification_body_url":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"integer"},"activity_name":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"batch_name":{"type":"string"},"operator_url":{"type":"string"},"activity_hash":{"type":"string"},"block_number":{"type":"integer"},"carbon_credit_batch_id":{"type":"string"},"country_id":{"type":"string"},"certification_body_hash":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"},"credit_balance":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"carbon_credit_batch_on_chain":{"carbon_credit_batch_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_name":"Reforestation 2024","activity_nft_id":1,"activity_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/activity/activity_AB12CD34EF","amount":"6500000000000000000","batch_name":"Permanent Removals Carbon Credit Batch","block_number":12345,"block_number_balance":12400,"carbon_credit_batch_id":"verification_AB12:permanent_removal","certificate_of_compliance_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certificate_of_compliance_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certificate_of_compliance/coc_AB12CD34EF","certification_body_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_body_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/certification_body/body_VERRA","certification_scheme_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_scheme_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/certification_scheme/scheme_SALUS","chain_id":20253,"contract_address":"0x38cF23C52Bb4B13F051Aec09580a2dE845a7FA35","country_id":"DK","credit_balance":"1000000000000000000","credit_contract_address":"0x1B4bC0dE8b6A1A2b3C4d5E6f7A8b9C0d1E2f3A4b","credit_decimals":18,"expiry_date":"2030-01-01","issue_date":"2025-01-01","monitoring_period_end_date":"2024-12-31","monitoring_period_start_date":"2024-01-01","operator_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","operator_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/operator/op_01JS0347FKH","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","status_code":"issued","token_bound_account":"0x9F2fCc7C4E1C0eA0dB1A0EbD79b0Cc7Ee4c3e5a1","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQmF0Y2gifQ==","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_type":"Permanent Removal"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Carbon_credit_batch_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete carbon_credit_batch_on_chain by id","description":"<p>Delete carbon_credit_batch_on_chain by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"carbon_credit_batch_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletecarbon_credit_batch_on_chain_ogcr","parameters":[{"name":"carboncreditbatchonchainid","in":"path","description":"The CARBONCREDITBATCHONCHAINID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"carbon_credit_batch_on_chain":{"type":"object","properties":{"activity_nft_id":{"type":"integer"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"block_number_balance":{"type":"integer"},"contract_address":{"type":"string"},"operator_hash":{"type":"string"},"carbon_credit_batch_on_chain_id":{"type":"string"},"unit_type":{"type":"string"},"credit_contract_address":{"type":"string"},"token_uri":{"type":"string"},"certificate_of_compliance_hash":{"type":"string"},"status_code":{"type":"string"},"credit_decimals":{"type":"integer"},"monitoring_period_end_date":{"type":"string"},"amount":{"type":"string"},"issue_date":{"type":"string"},"certificate_of_compliance_uri":{"type":"string"},"activity_url":{"type":"string"},"token_bound_account":{"type":"string"},"certification_scheme_hash":{"type":"string"},"certification_scheme_url":{"type":"string"},"certification_body_url":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"integer"},"activity_name":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"batch_name":{"type":"string"},"operator_url":{"type":"string"},"activity_hash":{"type":"string"},"block_number":{"type":"integer"},"carbon_credit_batch_id":{"type":"string"},"country_id":{"type":"string"},"certification_body_hash":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"},"credit_balance":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"carbon_credit_batch_on_chain":{"carbon_credit_batch_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_name":"Reforestation 2024","activity_nft_id":1,"activity_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/activity/activity_AB12CD34EF","amount":"6500000000000000000","batch_name":"Permanent Removals Carbon Credit Batch","block_number":12345,"block_number_balance":12400,"carbon_credit_batch_id":"verification_AB12:permanent_removal","certificate_of_compliance_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certificate_of_compliance_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certificate_of_compliance/coc_AB12CD34EF","certification_body_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_body_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/certification_body/body_VERRA","certification_scheme_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_scheme_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/certification_scheme/scheme_SALUS","chain_id":20253,"contract_address":"0x38cF23C52Bb4B13F051Aec09580a2dE845a7FA35","country_id":"DK","credit_balance":"1000000000000000000","credit_contract_address":"0x1B4bC0dE8b6A1A2b3C4d5E6f7A8b9C0d1E2f3A4b","credit_decimals":18,"expiry_date":"2030-01-01","issue_date":"2025-01-01","monitoring_period_end_date":"2024-12-31","monitoring_period_start_date":"2024-01-01","operator_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","operator_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/operator/op_01JS0347FKH","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","status_code":"issued","token_bound_account":"0x9F2fCc7C4E1C0eA0dB1A0EbD79b0Cc7Ee4c3e5a1","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQmF0Y2gifQ==","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_type":"Permanent Removal"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Carbon_credit_batch_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update carbon_credit_batch_on_chain","description":"<p>Partially update carbon_credit_batch_on_chain: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Cache of CarbonCreditBatchNFT data minted on the OGCR chain (chain id 20253). One record per carbon_credit_batch_id: the units of one unit type issued for an activity over one monitoring period. Each batch owns an ERC-6551 token-bound account that holds its CarbonCredit (ERC-20) balance. Populated by OGCR-chain-cache reading the chain. Join to <code>activity_on_chain</code> on activity_id (or activity_nft_id = token_id) to reach the OBP activity.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_hash: activity_hash stored on-chain: keccak256 of the raw activity entity body.</li>\n<li>activity_id: activity_id this batch was issued for, as stored on-chain.</li>\n<li>activity_name: Activity name as stored on-chain.</li>\n<li>activity_nft_id: ActivityNFT token id this batch was issued against. Join to <code>activity_on_chain</code>.token_id to reach the OBP activity_id.</li>\n<li>activity_url: activity_url stored on-chain: link back to the OBP activity entity.</li>\n<li>amount: Units issued for the batch, fixed at mint, in CarbonCredit base units (18 decimals): 6.5 tonnes is 6500000000000000000. Decimal string because a uint256 does not fit an integer field. The live balance is credit_balance.</li>\n<li>batch_name: Display name of the batch by unit type, as stored on-chain.</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>block_number_balance: Block height the credit_balance was read at. Unlike the mint fields, the balance is current-state, not historical, so it is only true as of this block.</li>\n<li>carbon_credit_batch_id: Business key for this record, as stored on-chain. The contract permits one batch token per id (tokenIdByBatchId), so it is used to match records for upsert.</li>\n<li>certificate_of_compliance_hash: certificate_of_compliance_hash stored on-chain: keccak256 of the raw certificate_of_compliance entity body.</li>\n<li>certificate_of_compliance_uri: certificate_of_compliance_uri stored on-chain: link back to the OBP certificate_of_compliance entity.</li>\n<li>certification_body_hash: certification_body_hash stored on-chain: keccak256 of the raw certification body entity body.</li>\n<li>certification_body_url: certification_body_url stored on-chain: link back to the OBP certification body entity.</li>\n<li>certification_scheme_hash: certification_scheme_hash stored on-chain: keccak256 of the raw certification scheme entity body.</li>\n<li>certification_scheme_url: certification_scheme_url stored on-chain: link back to the OBP certification_scheme entity.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: CarbonCreditBatchNFT contract address the token was read from.</li>\n<li>country_id: Country id as stored on-chain.</li>\n<li>credit_balance: CarbonCredit (ERC-20) balance held by token_bound_account, in smallest units, as read at block_number_balance. Decimal string because a uint256 does not fit an integer field. Divide by 10^credit_decimals for tonnes CO2e. Empty when no CarbonCredit contract address is configured.</li>\n<li>credit_contract_address: CarbonCredit ERC-20 contract address the balance was read from.</li>\n<li>credit_decimals: Decimals of the CarbonCredit ERC-20, for rendering credit_balance. 0 when no CarbonCredit contract address is configured.</li>\n<li>expiry_date: Batch expiry date as stored on-chain.</li>\n<li>issue_date: Batch issue date as stored on-chain.</li>\n<li>monitoring_period_end_date: Monitoring period end date as stored on-chain.</li>\n<li>monitoring_period_start_date: Monitoring period start date as stored on-chain.</li>\n<li>operator_hash: operator_hash stored on-chain: keccak256 of the raw operator entity body.</li>\n<li>operator_url: operator_url stored on-chain: link back to the OBP operator entity.</li>\n<li>owner_address: Current owner of the batch NFT (operator OGCR wallet address). Owning the NFT gates the right to move the credits held in its token-bound account.</li>\n<li>status_code: Batch status as stored on-chain.</li>\n<li>token_bound_account: ERC-6551 token-bound account for this batch. This address holds the batch's CarbonCredit (ERC-20) balance.</li>\n<li>token_id: CarbonCreditBatchNFT token id, unique per contract. Records are matched on carbon_credit_batch_id rather than this, so that the match uses a string field.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI, rendered on-chain from the batch data).</li>\n<li>tx_hash: Mint transaction hash (from the BatchMinted event).</li>\n<li>unit_type: CRCF unit type this batch represents, as stored on-chain.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"carbon_credit_batch_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchcarbon_credit_batch_on_chain_ogcr","parameters":[{"name":"carboncreditbatchonchainid","in":"path","description":"The CARBONCREDITBATCHONCHAINID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"activity_nft_id":{"type":"integer"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"block_number_balance":{"type":"integer"},"contract_address":{"type":"string"},"operator_hash":{"type":"string"},"unit_type":{"type":"string"},"credit_contract_address":{"type":"string"},"token_uri":{"type":"string"},"certificate_of_compliance_hash":{"type":"string"},"status_code":{"type":"string"},"credit_decimals":{"type":"integer"},"monitoring_period_end_date":{"type":"string"},"amount":{"type":"string"},"issue_date":{"type":"string"},"certificate_of_compliance_uri":{"type":"string"},"activity_url":{"type":"string"},"token_bound_account":{"type":"string"},"certification_scheme_hash":{"type":"string"},"certification_scheme_url":{"type":"string"},"certification_body_url":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"integer"},"activity_name":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"batch_name":{"type":"string"},"operator_url":{"type":"string"},"activity_hash":{"type":"string"},"block_number":{"type":"integer"},"carbon_credit_batch_id":{"type":"string"},"country_id":{"type":"string"},"certification_body_hash":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"},"credit_balance":{"type":"string"}}},"example":{"activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_name":"Reforestation 2024","activity_nft_id":1,"activity_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/activity/activity_AB12CD34EF","amount":"6500000000000000000","batch_name":"Permanent Removals Carbon Credit Batch","block_number":12345,"block_number_balance":12400,"carbon_credit_batch_id":"verification_AB12:permanent_removal","certificate_of_compliance_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certificate_of_compliance_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certificate_of_compliance/coc_AB12CD34EF","certification_body_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_body_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/certification_body/body_VERRA","certification_scheme_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_scheme_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/certification_scheme/scheme_SALUS","chain_id":20253,"contract_address":"0x38cF23C52Bb4B13F051Aec09580a2dE845a7FA35","country_id":"DK","credit_balance":"1000000000000000000","credit_contract_address":"0x1B4bC0dE8b6A1A2b3C4d5E6f7A8b9C0d1E2f3A4b","credit_decimals":18,"expiry_date":"2030-01-01","issue_date":"2025-01-01","monitoring_period_end_date":"2024-12-31","monitoring_period_start_date":"2024-01-01","operator_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","operator_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/operator/op_01JS0347FKH","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","status_code":"issued","token_bound_account":"0x9F2fCc7C4E1C0eA0dB1A0EbD79b0Cc7Ee4c3e5a1","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQmF0Y2gifQ==","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_type":"Permanent Removal"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"carbon_credit_batch_on_chain":{"type":"object","properties":{"activity_nft_id":{"type":"integer"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"block_number_balance":{"type":"integer"},"contract_address":{"type":"string"},"operator_hash":{"type":"string"},"carbon_credit_batch_on_chain_id":{"type":"string"},"unit_type":{"type":"string"},"credit_contract_address":{"type":"string"},"token_uri":{"type":"string"},"certificate_of_compliance_hash":{"type":"string"},"status_code":{"type":"string"},"credit_decimals":{"type":"integer"},"monitoring_period_end_date":{"type":"string"},"amount":{"type":"string"},"issue_date":{"type":"string"},"certificate_of_compliance_uri":{"type":"string"},"activity_url":{"type":"string"},"token_bound_account":{"type":"string"},"certification_scheme_hash":{"type":"string"},"certification_scheme_url":{"type":"string"},"certification_body_url":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"integer"},"activity_name":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"batch_name":{"type":"string"},"operator_url":{"type":"string"},"activity_hash":{"type":"string"},"block_number":{"type":"integer"},"carbon_credit_batch_id":{"type":"string"},"country_id":{"type":"string"},"certification_body_hash":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"},"credit_balance":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"carbon_credit_batch_on_chain":{"carbon_credit_batch_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_name":"Reforestation 2024","activity_nft_id":1,"activity_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/activity/activity_AB12CD34EF","amount":"6500000000000000000","batch_name":"Permanent Removals Carbon Credit Batch","block_number":12345,"block_number_balance":12400,"carbon_credit_batch_id":"verification_AB12:permanent_removal","certificate_of_compliance_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certificate_of_compliance_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certificate_of_compliance/coc_AB12CD34EF","certification_body_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_body_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/certification_body/body_VERRA","certification_scheme_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_scheme_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/certification_scheme/scheme_SALUS","chain_id":20253,"contract_address":"0x38cF23C52Bb4B13F051Aec09580a2dE845a7FA35","country_id":"DK","credit_balance":"1000000000000000000","credit_contract_address":"0x1B4bC0dE8b6A1A2b3C4d5E6f7A8b9C0d1E2f3A4b","credit_decimals":18,"expiry_date":"2030-01-01","issue_date":"2025-01-01","monitoring_period_end_date":"2024-12-31","monitoring_period_start_date":"2024-01-01","operator_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","operator_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/operator/op_01JS0347FKH","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","status_code":"issued","token_bound_account":"0x9F2fCc7C4E1C0eA0dB1A0EbD79b0Cc7Ee4c3e5a1","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQmF0Y2gifQ==","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_type":"Permanent Removal"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/growing-season":{"get":{"tags":["_Growing_season(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get growing_season List","description":"<p>Get growing_season List.</p>\n<p>Records one growing season of a specific crop on a specific parcel. Because a single parcel can host multiple crops across seasons (rotation) or simultaneously (intercropping), this entity is separate from the parcel and linked to it via parcel_id. Each record captures what was grown, when, on how much area, and how much was harvested. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>growing_season_id: Unique internal identifier automatically assigned to each crop season record.</li>\n<li>parcel_id: The identifier of the parcel on which this crop was grown. Links this crop season to the parcel's geometry, ownership, and dNFT records.</li>\n<li>crop_id: Reference to the crop type entry in the Crop reference table. Determines commodity category and emission factor for Scope 3 calculations.</li>\n<li>start_date: The date the crop was sown or planted on this parcel. Used to define the growing season window for MRV alignment and corporate reporting period matching.</li>\n<li>end_date: The date the crop was harvested or the growing season ended. Together with season_start_date, this defines the period covered by any yield and dMRV observations for this crop instance.</li>\n<li>year: The calendar year in which the majority of this growing season falls. Used as a simple label for annual reporting and filtering, especially when a season spans two calendar years.</li>\n<li>is_cover_crop: Indicates whether this crop is grown primarily to protect or enrich the soil between main cash crop seasons, rather than for commercial harvest. Cover crops are a key carbon farming practice that can affect SOC baselines and additionality assessments.</li>\n<li>crop_area_ha: The area of the parcel actually planted with this crop, in hectares. This may be less than the total parcel area if part of the parcel is left as buffer strips, tracks, or planted with a different crop. Required for dMRV spatial weighting (SOC and biomass estimates are per hectare and must be scaled to area) and for Scope 3 supply shed area aggregation.</li>\n<li>yield_kg_per_ha: The harvested yield of this crop expressed in kilograms per hectare. This is the core denominator for emission intensity calculations under the GHG Protocol FLAG approach (e.g., kg CO2e per tonne of wheat), which agrifood companies use for Scope 3 reporting.</li>\n<li>yield_total_kg: Total harvested yield for this crop season on this parcel, in kilograms. Can be entered directly by the farmer or derived from yield_kg_ha × crop_area_ha. Used to report sourcing volumes in lease contracts.</li>\n<li>yield_source: Indicates how the yield figure was obtained, affecting the assurance level buyers can claim in CSRD or SBTi reports. Controlled vocabulary: farmer_reported, dMRV_estimated, third_party_verified.</li>\n<li>farming_practice: The farming management approach applied during this growing season. This is what distinguishes a carbon farming activity from a conventional baseline and drives additionality. Controlled vocabulary: conventional, no_till, reduced_till, organic, regenerative, agroforestry.</li>\n<li>fertiliser_use_kg_per_ha: Total nitrogen fertiliser applied during this season, in kilograms per hectare. Used to estimate N2O emissions (a potent greenhouse gas from agricultural soils), which must be subtracted from the net carbon benefit under CRCF accounting rules.</li>\n<li>residue_management: How crop residues (straw, stems, leaves) are handled after harvest. This directly affects soil organic carbon dynamics. Controlled vocabulary: incorporated (ploughed back in), removed (baled and sold), burned.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"growing_season\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>crop_id</code>, <code>growing_season_id</code>, <code>parcel_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>crop_id</code> → <code>crop</code>, <code>parcel_id</code> → <code>parcel</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getgrowing_seasonList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"growing_season_list":{"type":"array","items":{"type":"object","properties":{"growing_season":{"type":"object","properties":{"yield_kg_per_ha":{"type":"number"},"start_date":{"type":"string"},"crop_id":{"type":"string"},"crop_area_ha":{"type":"number"},"yield_total_kg":{"type":"number"},"year":{"type":"integer"},"is_cover_crop":{"type":"boolean"},"yield_source":{"type":"string"},"end_date":{"type":"string"},"parcel_id":{"type":"string"},"fertiliser_use_kg_per_ha":{"type":"number"},"farming_practice":{"type":"string"},"growing_season_id":{"type":"string"},"residue_management":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"growing_season_list":[{"growing_season":{"growing_season_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","growing_season_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","crop_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","start_date":"2026-10-15","end_date":"2027-07-20","year":2027,"is_cover_crop":true,"crop_area_ha":7.4,"yield_kg_per_ha":6200.0,"yield_total_kg":45880.0,"yield_source":"farmer_reported","farming_practice":"no_till","fertiliser_use_kg_per_ha":120.0,"residue_management":"incorporated"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Growing_season(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new growing_season","description":"<p>Create new growing_season.</p>\n<p>Records one growing season of a specific crop on a specific parcel. Because a single parcel can host multiple crops across seasons (rotation) or simultaneously (intercropping), this entity is separate from the parcel and linked to it via parcel_id. Each record captures what was grown, when, on how much area, and how much was harvested. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>growing_season_id: Unique internal identifier automatically assigned to each crop season record.</li>\n<li>parcel_id: The identifier of the parcel on which this crop was grown. Links this crop season to the parcel's geometry, ownership, and dNFT records.</li>\n<li>crop_id: Reference to the crop type entry in the Crop reference table. Determines commodity category and emission factor for Scope 3 calculations.</li>\n<li>start_date: The date the crop was sown or planted on this parcel. Used to define the growing season window for MRV alignment and corporate reporting period matching.</li>\n<li>end_date: The date the crop was harvested or the growing season ended. Together with season_start_date, this defines the period covered by any yield and dMRV observations for this crop instance.</li>\n<li>year: The calendar year in which the majority of this growing season falls. Used as a simple label for annual reporting and filtering, especially when a season spans two calendar years.</li>\n<li>is_cover_crop: Indicates whether this crop is grown primarily to protect or enrich the soil between main cash crop seasons, rather than for commercial harvest. Cover crops are a key carbon farming practice that can affect SOC baselines and additionality assessments.</li>\n<li>crop_area_ha: The area of the parcel actually planted with this crop, in hectares. This may be less than the total parcel area if part of the parcel is left as buffer strips, tracks, or planted with a different crop. Required for dMRV spatial weighting (SOC and biomass estimates are per hectare and must be scaled to area) and for Scope 3 supply shed area aggregation.</li>\n<li>yield_kg_per_ha: The harvested yield of this crop expressed in kilograms per hectare. This is the core denominator for emission intensity calculations under the GHG Protocol FLAG approach (e.g., kg CO2e per tonne of wheat), which agrifood companies use for Scope 3 reporting.</li>\n<li>yield_total_kg: Total harvested yield for this crop season on this parcel, in kilograms. Can be entered directly by the farmer or derived from yield_kg_ha × crop_area_ha. Used to report sourcing volumes in lease contracts.</li>\n<li>yield_source: Indicates how the yield figure was obtained, affecting the assurance level buyers can claim in CSRD or SBTi reports. Controlled vocabulary: farmer_reported, dMRV_estimated, third_party_verified.</li>\n<li>farming_practice: The farming management approach applied during this growing season. This is what distinguishes a carbon farming activity from a conventional baseline and drives additionality. Controlled vocabulary: conventional, no_till, reduced_till, organic, regenerative, agroforestry.</li>\n<li>fertiliser_use_kg_per_ha: Total nitrogen fertiliser applied during this season, in kilograms per hectare. Used to estimate N2O emissions (a potent greenhouse gas from agricultural soils), which must be subtracted from the net carbon benefit under CRCF accounting rules.</li>\n<li>residue_management: How crop residues (straw, stems, leaves) are handled after harvest. This directly affects soil organic carbon dynamics. Controlled vocabulary: incorporated (ploughed back in), removed (baled and sold), burned.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"growing_season\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_creategrowing_season_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"yield_kg_per_ha":{"type":"number"},"start_date":{"type":"string"},"crop_id":{"type":"string"},"crop_area_ha":{"type":"number"},"yield_total_kg":{"type":"number"},"year":{"type":"integer"},"is_cover_crop":{"type":"boolean"},"yield_source":{"type":"string"},"end_date":{"type":"string"},"parcel_id":{"type":"string"},"fertiliser_use_kg_per_ha":{"type":"number"},"farming_practice":{"type":"string"},"growing_season_id":{"type":"string"},"residue_management":{"type":"string"}}},"example":{"growing_season_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","crop_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","start_date":"2026-10-15","end_date":"2027-07-20","year":2027,"is_cover_crop":true,"crop_area_ha":7.4,"yield_kg_per_ha":6200.0,"yield_total_kg":45880.0,"yield_source":"farmer_reported","farming_practice":"no_till","fertiliser_use_kg_per_ha":120.0,"residue_management":"incorporated"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"growing_season":{"type":"object","properties":{"yield_kg_per_ha":{"type":"number"},"start_date":{"type":"string"},"crop_id":{"type":"string"},"crop_area_ha":{"type":"number"},"yield_total_kg":{"type":"number"},"year":{"type":"integer"},"is_cover_crop":{"type":"boolean"},"yield_source":{"type":"string"},"end_date":{"type":"string"},"parcel_id":{"type":"string"},"fertiliser_use_kg_per_ha":{"type":"number"},"farming_practice":{"type":"string"},"growing_season_id":{"type":"string"},"residue_management":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"growing_season":{"growing_season_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","growing_season_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","crop_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","start_date":"2026-10-15","end_date":"2027-07-20","year":2027,"is_cover_crop":true,"crop_area_ha":7.4,"yield_kg_per_ha":6200.0,"yield_total_kg":45880.0,"yield_source":"farmer_reported","farming_practice":"no_till","fertiliser_use_kg_per_ha":120.0,"residue_management":"incorporated"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/registry/activity-query":{"get":{"tags":["OGCR-Registry"],"summary":"Get one OGCR registry activity with its details","description":"<p>User Authentication is Optional. The User need not be logged in.</p>\n<p><strong>JSON response body fields:</strong></p>\n","operationId":"OBPv4.0.0-getRegistryActivityQuery_-411429693","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activities":{"type":"array","items":{"type":"object","properties":{}}},"count":{"type":"integer"}}},"example":{"activities":[{}],"count":1}}}},"500":{"description":"Internal Server Error"}}}},"/parcel-snapshot/{parcelsnapshotid}":{"get":{"tags":["_Parcel_snapshot(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get parcel_snapshot by id","description":"<p>Get parcel_snapshot by id.</p>\n<p>\"parcel snapshot\" is a point-in-time record of what was happening on a parcel over a defined period \u2014 for example which growing seasons and livestock herds were present. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>digital_mrv_observation_id: The dMRV observation that triggered this snapshot</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_snapshot\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleparcel_snapshot_ogcr","parameters":[{"name":"parcelsnapshotid","in":"path","description":"The PARCELSNAPSHOTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_snapshot":{"type":"object","properties":{"land_manager_id":{"type":"string"},"snapshot_start_date":{"type":"string"},"snapshot_end_date":{"type":"string"},"livestock_list":{},"parcel_id":{"type":"string"},"parcel_snapshot_id":{"type":"string"},"digital_mrv_observation_id":{"type":"string"},"growing_season_list":{}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_snapshot":{"parcel_snapshot_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_snapshot_id":"string","parcel_id":"string","land_manager_id":"string","snapshot_start_date":"2020-01-01","snapshot_end_date":"2020-01-01","digital_mrv_observation_id":"string","growing_season_list":{},"livestock_list":{}},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Parcel_snapshot(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update parcel_snapshot","description":"<p>Update parcel_snapshot.</p>\n<p>\"parcel snapshot\" is a point-in-time record of what was happening on a parcel over a defined period \u2014 for example which growing seasons and livestock herds were present. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>digital_mrv_observation_id: The dMRV observation that triggered this snapshot</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_snapshot\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateparcel_snapshot_ogcr","parameters":[{"name":"parcelsnapshotid","in":"path","description":"The PARCELSNAPSHOTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"land_manager_id":{"type":"string"},"snapshot_start_date":{"type":"string"},"snapshot_end_date":{"type":"string"},"livestock_list":{},"parcel_id":{"type":"string"},"parcel_snapshot_id":{"type":"string"},"digital_mrv_observation_id":{"type":"string"},"growing_season_list":{}}},"example":{"parcel_snapshot_id":"string","parcel_id":"string","land_manager_id":"string","snapshot_start_date":"2020-01-01","snapshot_end_date":"2020-01-01","digital_mrv_observation_id":"string","growing_season_list":{},"livestock_list":{}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_snapshot":{"type":"object","properties":{"land_manager_id":{"type":"string"},"snapshot_start_date":{"type":"string"},"snapshot_end_date":{"type":"string"},"livestock_list":{},"parcel_id":{"type":"string"},"parcel_snapshot_id":{"type":"string"},"digital_mrv_observation_id":{"type":"string"},"growing_season_list":{}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_snapshot":{"parcel_snapshot_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_snapshot_id":"string","parcel_id":"string","land_manager_id":"string","snapshot_start_date":"2020-01-01","snapshot_end_date":"2020-01-01","digital_mrv_observation_id":"string","growing_season_list":{},"livestock_list":{}},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Parcel_snapshot(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete parcel_snapshot by id","description":"<p>Delete parcel_snapshot by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_snapshot\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteparcel_snapshot_ogcr","parameters":[{"name":"parcelsnapshotid","in":"path","description":"The PARCELSNAPSHOTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_snapshot":{"type":"object","properties":{"land_manager_id":{"type":"string"},"snapshot_start_date":{"type":"string"},"snapshot_end_date":{"type":"string"},"livestock_list":{},"parcel_id":{"type":"string"},"parcel_snapshot_id":{"type":"string"},"digital_mrv_observation_id":{"type":"string"},"growing_season_list":{}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_snapshot":{"parcel_snapshot_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_snapshot_id":"string","parcel_id":"string","land_manager_id":"string","snapshot_start_date":"2020-01-01","snapshot_end_date":"2020-01-01","digital_mrv_observation_id":"string","growing_season_list":{},"livestock_list":{}},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Parcel_snapshot(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update parcel_snapshot","description":"<p>Partially update parcel_snapshot: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>\"parcel snapshot\" is a point-in-time record of what was happening on a parcel over a defined period \u2014 for example which growing seasons and livestock herds were present. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>digital_mrv_observation_id: The dMRV observation that triggered this snapshot</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_snapshot\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchparcel_snapshot_ogcr","parameters":[{"name":"parcelsnapshotid","in":"path","description":"The PARCELSNAPSHOTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"land_manager_id":{"type":"string"},"snapshot_start_date":{"type":"string"},"snapshot_end_date":{"type":"string"},"livestock_list":{},"parcel_id":{"type":"string"},"parcel_snapshot_id":{"type":"string"},"digital_mrv_observation_id":{"type":"string"},"growing_season_list":{}}},"example":{"parcel_snapshot_id":"string","parcel_id":"string","land_manager_id":"string","snapshot_start_date":"2020-01-01","snapshot_end_date":"2020-01-01","digital_mrv_observation_id":"string","growing_season_list":{},"livestock_list":{}}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_snapshot":{"type":"object","properties":{"land_manager_id":{"type":"string"},"snapshot_start_date":{"type":"string"},"snapshot_end_date":{"type":"string"},"livestock_list":{},"parcel_id":{"type":"string"},"parcel_snapshot_id":{"type":"string"},"digital_mrv_observation_id":{"type":"string"},"growing_season_list":{}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_snapshot":{"parcel_snapshot_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_snapshot_id":"string","parcel_id":"string","land_manager_id":"string","snapshot_start_date":"2020-01-01","snapshot_end_date":"2020-01-01","digital_mrv_observation_id":"string","growing_season_list":{},"livestock_list":{}},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/activity-co-benefit/{activitycobenefitid}":{"get":{"tags":["_Activity_co_benefit(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get activity_co_benefit by id","description":"<p>Get activity_co_benefit by id.</p>\n<p>Parsed entity activity_co_benefit. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_co_benefit\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleactivity_co_benefit_ogcr","parameters":[{"name":"activitycobenefitid","in":"path","description":"The ACTIVITYCOBENEFITID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_co_benefit":{"type":"object","properties":{"activity_co_benefit_id":{"type":"string"},"activity_id":{"type":"string"},"co_benefit_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_co_benefit":{"activity_co_benefit_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","co_benefit_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Activity_co_benefit(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update activity_co_benefit","description":"<p>Update activity_co_benefit.</p>\n<p>Parsed entity activity_co_benefit. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_co_benefit\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateactivity_co_benefit_ogcr","parameters":[{"name":"activitycobenefitid","in":"path","description":"The ACTIVITYCOBENEFITID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"activity_id":{"type":"string"},"co_benefit_id":{"type":"string"}}},"example":{"activity_id":"string","co_benefit_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_co_benefit":{"type":"object","properties":{"activity_co_benefit_id":{"type":"string"},"activity_id":{"type":"string"},"co_benefit_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_co_benefit":{"activity_co_benefit_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","co_benefit_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Activity_co_benefit(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete activity_co_benefit by id","description":"<p>Delete activity_co_benefit by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_co_benefit\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteactivity_co_benefit_ogcr","parameters":[{"name":"activitycobenefitid","in":"path","description":"The ACTIVITYCOBENEFITID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_co_benefit":{"type":"object","properties":{"activity_co_benefit_id":{"type":"string"},"activity_id":{"type":"string"},"co_benefit_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_co_benefit":{"activity_co_benefit_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","co_benefit_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Activity_co_benefit(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update activity_co_benefit","description":"<p>Partially update activity_co_benefit: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Parsed entity activity_co_benefit. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_co_benefit\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchactivity_co_benefit_ogcr","parameters":[{"name":"activitycobenefitid","in":"path","description":"The ACTIVITYCOBENEFITID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"activity_id":{"type":"string"},"co_benefit_id":{"type":"string"}}},"example":{"activity_id":"string","co_benefit_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_co_benefit":{"type":"object","properties":{"activity_co_benefit_id":{"type":"string"},"activity_id":{"type":"string"},"co_benefit_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_co_benefit":{"activity_co_benefit_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","co_benefit_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/certification-scheme":{"get":{"tags":["_Certification_scheme(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public certification_scheme List","description":"<p>Get Public certification_scheme List.</p>\n<p>\u2018certification scheme\u2019 means an organisation that certifies the compliance of activities and operators with the quality criteria and certification rules set out in this Regulation;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certification_scheme_id: Unique identifier for certification scheme entity.</li>\n<li>legal_name: Public name of the certification scheme.</li>\n<li>logo: URL or asset reference to a logo image for UI/PDF rendering.</li>\n<li>commission_decision_reference: \"the Commission decision recognising that scheme\"</li>\n<li>certification_methodology: Methodology(ies) the scheme applies (identifier + version).</li>\n<li>scheme_version_number: Scheme rulebook version used for this certification</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_scheme\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>certification_scheme_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPubliccertification_schemeList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_scheme_list":{"type":"array","items":{"type":"object","properties":{"certification_scheme":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"email":{"type":"string"},"logo":{"type":"string"},"scheme_version_number":{"type":"string"},"legal_name":{"type":"string"},"commission_decision_reference":{"type":"string"},"certification_methodology":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"certification_scheme_list":[{"certification_scheme":{"certification_scheme_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certification_scheme_id":"cs_01HZZ1K0X5F6Q7R8S9T0","legal_name":"CRCF Scheme","logo":"https://cdn.example.org/logos/dnv.png","email":"string","commission_decision_reference":"Commission Decision C(2026)1234","certification_methodology":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","scheme_version_number":"v1.3"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/operator":{"get":{"tags":["_Operator(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get operator List","description":"<p>Get operator List.</p>\n<p>\u2018operator\u2019 means any natural or legal person or public entity that operates or controls an activity, or to whom or to which decisive economic power over the technical functioning of the activity has been delegated;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>operator_id: Internal identifier for the operator entity</li>\n<li>legal_name: Legal name of the Operator.</li>\n<li>email: Operator email address.</li>\n<li>phone: Operator contact phone in international format.</li>\n<li>address_line_1: Operator primary street address (street name, building number, P.O. Box if applicable)</li>\n<li>address_line_2: Operator secondary, optional details like apartment, suite, unit, floor, or building name</li>\n<li>postcode: Operator postcode</li>\n<li>country_id: ISO 3166-1 alpha-2 country code for operator address.</li>\n<li>ogcr_wallet_address: Wallet address to send NFTs and carbon credits to after evaluation period</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"operator\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>country_id</code>, <code>operator_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>country_id</code> → <code>country</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getoperatorList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"operator_list":{"type":"array","items":{"type":"object","properties":{"operator":{"type":"object","properties":{"email":{"type":"string"},"postcode":{"type":"string"},"operator_id":{"type":"string"},"ogcr_wallet_address":{"type":"string"},"address_line_2":{"type":"string"},"legal_name":{"type":"string"},"country_id":{"type":"string"},"address_line_1":{"type":"string"},"phone":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"operator_list":[{"operator":{"operator_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","operator_id":"op_01JS0347FKH","legal_name":"Agreena","email":"contact@example.com","phone":"+49 123 456 789","address_line_1":"Green Street, 20","address_line_2":"Suite 400","postcode":"10115\" or \"W1K 3JP","country_id":"DE","ogcr_wallet_address":"0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Operator(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new operator","description":"<p>Create new operator.</p>\n<p>\u2018operator\u2019 means any natural or legal person or public entity that operates or controls an activity, or to whom or to which decisive economic power over the technical functioning of the activity has been delegated;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>operator_id: Internal identifier for the operator entity</li>\n<li>legal_name: Legal name of the Operator.</li>\n<li>email: Operator email address.</li>\n<li>phone: Operator contact phone in international format.</li>\n<li>address_line_1: Operator primary street address (street name, building number, P.O. Box if applicable)</li>\n<li>address_line_2: Operator secondary, optional details like apartment, suite, unit, floor, or building name</li>\n<li>postcode: Operator postcode</li>\n<li>country_id: ISO 3166-1 alpha-2 country code for operator address.</li>\n<li>ogcr_wallet_address: Wallet address to send NFTs and carbon credits to after evaluation period</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"operator\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createoperator_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"postcode":{"type":"string"},"operator_id":{"type":"string"},"ogcr_wallet_address":{"type":"string"},"address_line_2":{"type":"string"},"legal_name":{"type":"string"},"country_id":{"type":"string"},"address_line_1":{"type":"string"},"phone":{"type":"string"}}},"example":{"operator_id":"op_01JS0347FKH","legal_name":"Agreena","email":"contact@example.com","phone":"+49 123 456 789","address_line_1":"Green Street, 20","address_line_2":"Suite 400","postcode":"10115\" or \"W1K 3JP","country_id":"DE","ogcr_wallet_address":"0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"operator":{"type":"object","properties":{"email":{"type":"string"},"postcode":{"type":"string"},"operator_id":{"type":"string"},"ogcr_wallet_address":{"type":"string"},"address_line_2":{"type":"string"},"legal_name":{"type":"string"},"country_id":{"type":"string"},"address_line_1":{"type":"string"},"phone":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"operator":{"operator_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","operator_id":"op_01JS0347FKH","legal_name":"Agreena","email":"contact@example.com","phone":"+49 123 456 789","address_line_1":"Green Street, 20","address_line_2":"Suite 400","postcode":"10115\" or \"W1K 3JP","country_id":"DE","ogcr_wallet_address":"0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/certification-body-authority/{certificationbodyauthorityid}":{"get":{"tags":["_Certification_body_authority(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get certification_body_authority by id","description":"<p>Get certification_body_authority by id.</p>\n<p>A many-to-many junction between certification bodies and authorities. It covers what Art. 11(4) requires schemes to publish per body: who accredited or recognised it, and who monitors it. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certification_body_authority_id: Internal identifier for the link.</li>\n<li>certification_body_id: he certification body.</li>\n<li>authority_id: The authority.</li>\n<li>relationship_to_authority: Controlled vocabulary: accredited_by, recognised_by, monitored_by.</li>\n<li>scope: Scope of the accreditation or recognition. Replaces accreditation_scope and recognition_scope.</li>\n<li>start_date: Date the accreditation, recognition or monitoring began. Replaces accreditation_date and recognition_date.</li>\n<li>end_date: Expiry or end date, if any.</li>\n<li>reference: The authority's own certificate or decision number.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_body_authority\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglecertification_body_authority_ogcr","parameters":[{"name":"certificationbodyauthorityid","in":"path","description":"The CERTIFICATIONBODYAUTHORITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_body_authority":{"type":"object","properties":{"reference":{"type":"string"},"start_date":{"type":"string"},"certification_body_authority_id":{"type":"string"},"scope":{"type":"string"},"relationship_to_authority":{"type":"string"},"end_date":{"type":"string"},"certification_body_id":{"type":"string"},"authority_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certification_body_authority":{"certification_body_authority_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certification_body_authority_id":"cba_01HZZ5N8R3P","certification_body_id":"cb_01HZZ1M2A3B4C","authority_id":"auth_01HZZ4K7Q2M","relationship_to_authority":"accredited_by","scope":"Carbon farming, mineral soils","start_date":"2026-05-24","end_date":"2031-05-24","reference":"D-ZE-12345-01-00"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Certification_body_authority(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update certification_body_authority","description":"<p>Update certification_body_authority.</p>\n<p>A many-to-many junction between certification bodies and authorities. It covers what Art. 11(4) requires schemes to publish per body: who accredited or recognised it, and who monitors it. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certification_body_authority_id: Internal identifier for the link.</li>\n<li>certification_body_id: he certification body.</li>\n<li>authority_id: The authority.</li>\n<li>relationship_to_authority: Controlled vocabulary: accredited_by, recognised_by, monitored_by.</li>\n<li>scope: Scope of the accreditation or recognition. Replaces accreditation_scope and recognition_scope.</li>\n<li>start_date: Date the accreditation, recognition or monitoring began. Replaces accreditation_date and recognition_date.</li>\n<li>end_date: Expiry or end date, if any.</li>\n<li>reference: The authority's own certificate or decision number.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_body_authority\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updatecertification_body_authority_ogcr","parameters":[{"name":"certificationbodyauthorityid","in":"path","description":"The CERTIFICATIONBODYAUTHORITYID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"reference":{"type":"string"},"start_date":{"type":"string"},"certification_body_authority_id":{"type":"string"},"scope":{"type":"string"},"relationship_to_authority":{"type":"string"},"end_date":{"type":"string"},"certification_body_id":{"type":"string"},"authority_id":{"type":"string"}}},"example":{"certification_body_authority_id":"cba_01HZZ5N8R3P","certification_body_id":"cb_01HZZ1M2A3B4C","authority_id":"auth_01HZZ4K7Q2M","relationship_to_authority":"accredited_by","scope":"Carbon farming, mineral soils","start_date":"2026-05-24","end_date":"2031-05-24","reference":"D-ZE-12345-01-00"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_body_authority":{"type":"object","properties":{"reference":{"type":"string"},"start_date":{"type":"string"},"certification_body_authority_id":{"type":"string"},"scope":{"type":"string"},"relationship_to_authority":{"type":"string"},"end_date":{"type":"string"},"certification_body_id":{"type":"string"},"authority_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certification_body_authority":{"certification_body_authority_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certification_body_authority_id":"cba_01HZZ5N8R3P","certification_body_id":"cb_01HZZ1M2A3B4C","authority_id":"auth_01HZZ4K7Q2M","relationship_to_authority":"accredited_by","scope":"Carbon farming, mineral soils","start_date":"2026-05-24","end_date":"2031-05-24","reference":"D-ZE-12345-01-00"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Certification_body_authority(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete certification_body_authority by id","description":"<p>Delete certification_body_authority by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_body_authority\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletecertification_body_authority_ogcr","parameters":[{"name":"certificationbodyauthorityid","in":"path","description":"The CERTIFICATIONBODYAUTHORITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_body_authority":{"type":"object","properties":{"reference":{"type":"string"},"start_date":{"type":"string"},"certification_body_authority_id":{"type":"string"},"scope":{"type":"string"},"relationship_to_authority":{"type":"string"},"end_date":{"type":"string"},"certification_body_id":{"type":"string"},"authority_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certification_body_authority":{"certification_body_authority_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certification_body_authority_id":"cba_01HZZ5N8R3P","certification_body_id":"cb_01HZZ1M2A3B4C","authority_id":"auth_01HZZ4K7Q2M","relationship_to_authority":"accredited_by","scope":"Carbon farming, mineral soils","start_date":"2026-05-24","end_date":"2031-05-24","reference":"D-ZE-12345-01-00"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Certification_body_authority(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update certification_body_authority","description":"<p>Partially update certification_body_authority: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>A many-to-many junction between certification bodies and authorities. It covers what Art. 11(4) requires schemes to publish per body: who accredited or recognised it, and who monitors it. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certification_body_authority_id: Internal identifier for the link.</li>\n<li>certification_body_id: he certification body.</li>\n<li>authority_id: The authority.</li>\n<li>relationship_to_authority: Controlled vocabulary: accredited_by, recognised_by, monitored_by.</li>\n<li>scope: Scope of the accreditation or recognition. Replaces accreditation_scope and recognition_scope.</li>\n<li>start_date: Date the accreditation, recognition or monitoring began. Replaces accreditation_date and recognition_date.</li>\n<li>end_date: Expiry or end date, if any.</li>\n<li>reference: The authority's own certificate or decision number.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_body_authority\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchcertification_body_authority_ogcr","parameters":[{"name":"certificationbodyauthorityid","in":"path","description":"The CERTIFICATIONBODYAUTHORITYID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"reference":{"type":"string"},"start_date":{"type":"string"},"certification_body_authority_id":{"type":"string"},"scope":{"type":"string"},"relationship_to_authority":{"type":"string"},"end_date":{"type":"string"},"certification_body_id":{"type":"string"},"authority_id":{"type":"string"}}},"example":{"certification_body_authority_id":"cba_01HZZ5N8R3P","certification_body_id":"cb_01HZZ1M2A3B4C","authority_id":"auth_01HZZ4K7Q2M","relationship_to_authority":"accredited_by","scope":"Carbon farming, mineral soils","start_date":"2026-05-24","end_date":"2031-05-24","reference":"D-ZE-12345-01-00"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_body_authority":{"type":"object","properties":{"reference":{"type":"string"},"start_date":{"type":"string"},"certification_body_authority_id":{"type":"string"},"scope":{"type":"string"},"relationship_to_authority":{"type":"string"},"end_date":{"type":"string"},"certification_body_id":{"type":"string"},"authority_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certification_body_authority":{"certification_body_authority_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certification_body_authority_id":"cba_01HZZ5N8R3P","certification_body_id":"cb_01HZZ1M2A3B4C","authority_id":"auth_01HZZ4K7Q2M","relationship_to_authority":"accredited_by","scope":"Carbon farming, mineral soils","start_date":"2026-05-24","end_date":"2031-05-24","reference":"D-ZE-12345-01-00"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/activity/{activityid}":{"get":{"tags":["_Activity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get activity by id","description":"<p>Get activity by id.</p>\n<p>\u2018activity\u2019 means one or more practices or processes carried out by an operator, or a group of operators, resulting in a permanent/temporary carbon removal through carbon farming or carbon storage in products, or soil emission reductions. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_id: Internal identifier for the activity</li>\n<li>name: Human-readable activity name shown in UI and exports.</li>\n<li>summary: 1\u20132 sentence public summary, used in Activity listing.</li>\n<li>description: Longer narrative description (scope, intent, participants, context).</li>\n<li>website: Public URL with activity/operator details</li>\n<li>hero_image: Primary image URL for hero image</li>\n<li>image: Primary image URL or asset reference for UI cards.</li>\n<li>operator_id: Internal identifier for the operator entity</li>\n<li>activity_type: Activity category, based on technologies, practices and processes. (CARBON_FARMING, PERMANENT_REMOVAL, CARBON_STORAGE_IN_PRODUCTS)</li>\n<li>unit_types: Unit category that will be produced during this activity. (Permanent Removal,<br />\nCarbon Farming Sequestration, Soil Emission Reduction, Carbon Storage in Product)</li>\n<li>city: Primary city/municipality associated with the activity</li>\n<li>country_id: ISO 3166-1 alpha-2 country code for where the activity occurs.</li>\n<li>multipolygon_coordinates: GeoJSON MultiPolygon boundary of the activity area.</li>\n<li>start_date: Start date of the activity implementation period (when practices/process begin).</li>\n<li>end_date: End date of the activity implementation period.</li>\n<li>term_commitment: Commitment/contract duration for maintaining practices.</li>\n<li>cobenefits: Declared co-benefits</li>\n<li>methodologies: Methodology IDs/names and versions used to quantify outcomes</li>\n<li>monitoring_period_years: Planned monitoring duration in years</li>\n<li>monitoring_period_start_date: Start date of the monitoring window used for MRV/accounting</li>\n<li>monitoring_period_end_date: End date of the monitoring window</li>\n<li>certification_scheme_id: ID of the certification scheme chosen by the operator.</li>\n<li>internal_note: An internal note that will not be displayed to the public</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleactivity_ogcr","parameters":[{"name":"activityid","in":"path","description":"The ACTIVITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity":{"type":"object","properties":{"name":{"type":"string"},"start_date":{"type":"string"},"certification_scheme_id":{"type":"string"},"methodologies":{"type":"string"},"image":{"type":"string"},"description":{"type":"string"},"cobenefits":{"type":"string"},"internal_note":{"type":"string"},"multipolygon_coordinates":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"array","maxItems":2,"minItems":2,"items":{"type":"number"}}}}}}},"activity_type":{"type":"string"},"hero_image":{"type":"string"},"monitoring_period_end_date":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"summary":{"type":"string"},"website":{"type":"string"},"city":{"type":"string"},"term_commitment":{"type":"integer"},"end_date":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"unit_types":{"type":"string"},"monitoring_period_years":{"type":"integer"},"country_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity":{"activity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"a_05OFWI037022","name":"Brandenburg Regenerative Wheat","summary":"Wheat rotation adopting cover crops and reduced tillage across enrolled parcels.","description":"This activity aggregates multiple parcels under a single operator to monitor practice changes and estimate carbon stock change over the monitoring period.","website":"https://example.org/activities/brandenburg-wheat","hero_image":"https://cdn.example.org/activity-images/activity_123.png","image":"https://cdn.example.org/activity-images/activity_123.png","operator_id":"op_01JS0347FKH","activity_type":"CARBON_FARMING","unit_types":"Soil Emission Reduction","city":"Seelow","country_id":"DE","multipolygon_coordinates":{"type":"MultiPolygon","coordinates":[[[[14.3801,52.5201],[14.3901,52.5201],[14.3901,52.5301],[14.3801,52.5301],[14.3801,52.5201]]]]},"start_date":"2027-01-01","end_date":"2031-12-31","term_commitment":5,"cobenefits":"[\"biodiversity\", \"water_quality\", \"soil_health\"]","methodologies":"[{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}]","monitoring_period_years":5,"monitoring_period_start_date":"2027-01-01","monitoring_period_end_date":"2031-12-31","certification_scheme_id":"CRCF Scheme","internal_note":"I'm flagging this for review"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Activity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update activity","description":"<p>Update activity.</p>\n<p>\u2018activity\u2019 means one or more practices or processes carried out by an operator, or a group of operators, resulting in a permanent/temporary carbon removal through carbon farming or carbon storage in products, or soil emission reductions. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_id: Internal identifier for the activity</li>\n<li>name: Human-readable activity name shown in UI and exports.</li>\n<li>summary: 1\u20132 sentence public summary, used in Activity listing.</li>\n<li>description: Longer narrative description (scope, intent, participants, context).</li>\n<li>website: Public URL with activity/operator details</li>\n<li>hero_image: Primary image URL for hero image</li>\n<li>image: Primary image URL or asset reference for UI cards.</li>\n<li>operator_id: Internal identifier for the operator entity</li>\n<li>activity_type: Activity category, based on technologies, practices and processes. (CARBON_FARMING, PERMANENT_REMOVAL, CARBON_STORAGE_IN_PRODUCTS)</li>\n<li>unit_types: Unit category that will be produced during this activity. (Permanent Removal,<br />\nCarbon Farming Sequestration, Soil Emission Reduction, Carbon Storage in Product)</li>\n<li>city: Primary city/municipality associated with the activity</li>\n<li>country_id: ISO 3166-1 alpha-2 country code for where the activity occurs.</li>\n<li>multipolygon_coordinates: GeoJSON MultiPolygon boundary of the activity area.</li>\n<li>start_date: Start date of the activity implementation period (when practices/process begin).</li>\n<li>end_date: End date of the activity implementation period.</li>\n<li>term_commitment: Commitment/contract duration for maintaining practices.</li>\n<li>cobenefits: Declared co-benefits</li>\n<li>methodologies: Methodology IDs/names and versions used to quantify outcomes</li>\n<li>monitoring_period_years: Planned monitoring duration in years</li>\n<li>monitoring_period_start_date: Start date of the monitoring window used for MRV/accounting</li>\n<li>monitoring_period_end_date: End date of the monitoring window</li>\n<li>certification_scheme_id: ID of the certification scheme chosen by the operator.</li>\n<li>internal_note: An internal note that will not be displayed to the public</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateactivity_ogcr","parameters":[{"name":"activityid","in":"path","description":"The ACTIVITYID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"start_date":{"type":"string"},"certification_scheme_id":{"type":"string"},"methodologies":{"type":"string"},"image":{"type":"string"},"description":{"type":"string"},"cobenefits":{"type":"string"},"internal_note":{"type":"string"},"multipolygon_coordinates":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"array","maxItems":2,"minItems":2,"items":{"type":"number"}}}}}}},"activity_type":{"type":"string"},"hero_image":{"type":"string"},"monitoring_period_end_date":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"summary":{"type":"string"},"website":{"type":"string"},"city":{"type":"string"},"term_commitment":{"type":"integer"},"end_date":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"unit_types":{"type":"string"},"monitoring_period_years":{"type":"integer"},"country_id":{"type":"string"}}},"example":{"activity_id":"a_05OFWI037022","name":"Brandenburg Regenerative Wheat","summary":"Wheat rotation adopting cover crops and reduced tillage across enrolled parcels.","description":"This activity aggregates multiple parcels under a single operator to monitor practice changes and estimate carbon stock change over the monitoring period.","website":"https://example.org/activities/brandenburg-wheat","hero_image":"https://cdn.example.org/activity-images/activity_123.png","image":"https://cdn.example.org/activity-images/activity_123.png","operator_id":"op_01JS0347FKH","activity_type":"CARBON_FARMING","unit_types":"Soil Emission Reduction","city":"Seelow","country_id":"DE","multipolygon_coordinates":{"type":"MultiPolygon","coordinates":[[[[14.3801,52.5201],[14.3901,52.5201],[14.3901,52.5301],[14.3801,52.5301],[14.3801,52.5201]]]]},"start_date":"2027-01-01","end_date":"2031-12-31","term_commitment":5,"cobenefits":"[\"biodiversity\", \"water_quality\", \"soil_health\"]","methodologies":"[{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}]","monitoring_period_years":5,"monitoring_period_start_date":"2027-01-01","monitoring_period_end_date":"2031-12-31","certification_scheme_id":"CRCF Scheme","internal_note":"I'm flagging this for review"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity":{"type":"object","properties":{"name":{"type":"string"},"start_date":{"type":"string"},"certification_scheme_id":{"type":"string"},"methodologies":{"type":"string"},"image":{"type":"string"},"description":{"type":"string"},"cobenefits":{"type":"string"},"internal_note":{"type":"string"},"multipolygon_coordinates":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"array","maxItems":2,"minItems":2,"items":{"type":"number"}}}}}}},"activity_type":{"type":"string"},"hero_image":{"type":"string"},"monitoring_period_end_date":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"summary":{"type":"string"},"website":{"type":"string"},"city":{"type":"string"},"term_commitment":{"type":"integer"},"end_date":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"unit_types":{"type":"string"},"monitoring_period_years":{"type":"integer"},"country_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity":{"activity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"a_05OFWI037022","name":"Brandenburg Regenerative Wheat","summary":"Wheat rotation adopting cover crops and reduced tillage across enrolled parcels.","description":"This activity aggregates multiple parcels under a single operator to monitor practice changes and estimate carbon stock change over the monitoring period.","website":"https://example.org/activities/brandenburg-wheat","hero_image":"https://cdn.example.org/activity-images/activity_123.png","image":"https://cdn.example.org/activity-images/activity_123.png","operator_id":"op_01JS0347FKH","activity_type":"CARBON_FARMING","unit_types":"Soil Emission Reduction","city":"Seelow","country_id":"DE","multipolygon_coordinates":{"type":"MultiPolygon","coordinates":[[[[14.3801,52.5201],[14.3901,52.5201],[14.3901,52.5301],[14.3801,52.5301],[14.3801,52.5201]]]]},"start_date":"2027-01-01","end_date":"2031-12-31","term_commitment":5,"cobenefits":"[\"biodiversity\", \"water_quality\", \"soil_health\"]","methodologies":"[{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}]","monitoring_period_years":5,"monitoring_period_start_date":"2027-01-01","monitoring_period_end_date":"2031-12-31","certification_scheme_id":"CRCF Scheme","internal_note":"I'm flagging this for review"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Activity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete activity by id","description":"<p>Delete activity by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteactivity_ogcr","parameters":[{"name":"activityid","in":"path","description":"The ACTIVITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity":{"type":"object","properties":{"name":{"type":"string"},"start_date":{"type":"string"},"certification_scheme_id":{"type":"string"},"methodologies":{"type":"string"},"image":{"type":"string"},"description":{"type":"string"},"cobenefits":{"type":"string"},"internal_note":{"type":"string"},"multipolygon_coordinates":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"array","maxItems":2,"minItems":2,"items":{"type":"number"}}}}}}},"activity_type":{"type":"string"},"hero_image":{"type":"string"},"monitoring_period_end_date":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"summary":{"type":"string"},"website":{"type":"string"},"city":{"type":"string"},"term_commitment":{"type":"integer"},"end_date":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"unit_types":{"type":"string"},"monitoring_period_years":{"type":"integer"},"country_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity":{"activity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"a_05OFWI037022","name":"Brandenburg Regenerative Wheat","summary":"Wheat rotation adopting cover crops and reduced tillage across enrolled parcels.","description":"This activity aggregates multiple parcels under a single operator to monitor practice changes and estimate carbon stock change over the monitoring period.","website":"https://example.org/activities/brandenburg-wheat","hero_image":"https://cdn.example.org/activity-images/activity_123.png","image":"https://cdn.example.org/activity-images/activity_123.png","operator_id":"op_01JS0347FKH","activity_type":"CARBON_FARMING","unit_types":"Soil Emission Reduction","city":"Seelow","country_id":"DE","multipolygon_coordinates":{"type":"MultiPolygon","coordinates":[[[[14.3801,52.5201],[14.3901,52.5201],[14.3901,52.5301],[14.3801,52.5301],[14.3801,52.5201]]]]},"start_date":"2027-01-01","end_date":"2031-12-31","term_commitment":5,"cobenefits":"[\"biodiversity\", \"water_quality\", \"soil_health\"]","methodologies":"[{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}]","monitoring_period_years":5,"monitoring_period_start_date":"2027-01-01","monitoring_period_end_date":"2031-12-31","certification_scheme_id":"CRCF Scheme","internal_note":"I'm flagging this for review"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Activity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update activity","description":"<p>Partially update activity: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>\u2018activity\u2019 means one or more practices or processes carried out by an operator, or a group of operators, resulting in a permanent/temporary carbon removal through carbon farming or carbon storage in products, or soil emission reductions. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_id: Internal identifier for the activity</li>\n<li>name: Human-readable activity name shown in UI and exports.</li>\n<li>summary: 1\u20132 sentence public summary, used in Activity listing.</li>\n<li>description: Longer narrative description (scope, intent, participants, context).</li>\n<li>website: Public URL with activity/operator details</li>\n<li>hero_image: Primary image URL for hero image</li>\n<li>image: Primary image URL or asset reference for UI cards.</li>\n<li>operator_id: Internal identifier for the operator entity</li>\n<li>activity_type: Activity category, based on technologies, practices and processes. (CARBON_FARMING, PERMANENT_REMOVAL, CARBON_STORAGE_IN_PRODUCTS)</li>\n<li>unit_types: Unit category that will be produced during this activity. (Permanent Removal,<br />\nCarbon Farming Sequestration, Soil Emission Reduction, Carbon Storage in Product)</li>\n<li>city: Primary city/municipality associated with the activity</li>\n<li>country_id: ISO 3166-1 alpha-2 country code for where the activity occurs.</li>\n<li>multipolygon_coordinates: GeoJSON MultiPolygon boundary of the activity area.</li>\n<li>start_date: Start date of the activity implementation period (when practices/process begin).</li>\n<li>end_date: End date of the activity implementation period.</li>\n<li>term_commitment: Commitment/contract duration for maintaining practices.</li>\n<li>cobenefits: Declared co-benefits</li>\n<li>methodologies: Methodology IDs/names and versions used to quantify outcomes</li>\n<li>monitoring_period_years: Planned monitoring duration in years</li>\n<li>monitoring_period_start_date: Start date of the monitoring window used for MRV/accounting</li>\n<li>monitoring_period_end_date: End date of the monitoring window</li>\n<li>certification_scheme_id: ID of the certification scheme chosen by the operator.</li>\n<li>internal_note: An internal note that will not be displayed to the public</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchactivity_ogcr","parameters":[{"name":"activityid","in":"path","description":"The ACTIVITYID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"start_date":{"type":"string"},"certification_scheme_id":{"type":"string"},"methodologies":{"type":"string"},"image":{"type":"string"},"description":{"type":"string"},"cobenefits":{"type":"string"},"internal_note":{"type":"string"},"multipolygon_coordinates":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"array","maxItems":2,"minItems":2,"items":{"type":"number"}}}}}}},"activity_type":{"type":"string"},"hero_image":{"type":"string"},"monitoring_period_end_date":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"summary":{"type":"string"},"website":{"type":"string"},"city":{"type":"string"},"term_commitment":{"type":"integer"},"end_date":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"unit_types":{"type":"string"},"monitoring_period_years":{"type":"integer"},"country_id":{"type":"string"}}},"example":{"activity_id":"a_05OFWI037022","name":"Brandenburg Regenerative Wheat","summary":"Wheat rotation adopting cover crops and reduced tillage across enrolled parcels.","description":"This activity aggregates multiple parcels under a single operator to monitor practice changes and estimate carbon stock change over the monitoring period.","website":"https://example.org/activities/brandenburg-wheat","hero_image":"https://cdn.example.org/activity-images/activity_123.png","image":"https://cdn.example.org/activity-images/activity_123.png","operator_id":"op_01JS0347FKH","activity_type":"CARBON_FARMING","unit_types":"Soil Emission Reduction","city":"Seelow","country_id":"DE","multipolygon_coordinates":{"type":"MultiPolygon","coordinates":[[[[14.3801,52.5201],[14.3901,52.5201],[14.3901,52.5301],[14.3801,52.5301],[14.3801,52.5201]]]]},"start_date":"2027-01-01","end_date":"2031-12-31","term_commitment":5,"cobenefits":"[\"biodiversity\", \"water_quality\", \"soil_health\"]","methodologies":"[{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}]","monitoring_period_years":5,"monitoring_period_start_date":"2027-01-01","monitoring_period_end_date":"2031-12-31","certification_scheme_id":"CRCF Scheme","internal_note":"I'm flagging this for review"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity":{"type":"object","properties":{"name":{"type":"string"},"start_date":{"type":"string"},"certification_scheme_id":{"type":"string"},"methodologies":{"type":"string"},"image":{"type":"string"},"description":{"type":"string"},"cobenefits":{"type":"string"},"internal_note":{"type":"string"},"multipolygon_coordinates":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"array","maxItems":2,"minItems":2,"items":{"type":"number"}}}}}}},"activity_type":{"type":"string"},"hero_image":{"type":"string"},"monitoring_period_end_date":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"summary":{"type":"string"},"website":{"type":"string"},"city":{"type":"string"},"term_commitment":{"type":"integer"},"end_date":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"unit_types":{"type":"string"},"monitoring_period_years":{"type":"integer"},"country_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity":{"activity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"a_05OFWI037022","name":"Brandenburg Regenerative Wheat","summary":"Wheat rotation adopting cover crops and reduced tillage across enrolled parcels.","description":"This activity aggregates multiple parcels under a single operator to monitor practice changes and estimate carbon stock change over the monitoring period.","website":"https://example.org/activities/brandenburg-wheat","hero_image":"https://cdn.example.org/activity-images/activity_123.png","image":"https://cdn.example.org/activity-images/activity_123.png","operator_id":"op_01JS0347FKH","activity_type":"CARBON_FARMING","unit_types":"Soil Emission Reduction","city":"Seelow","country_id":"DE","multipolygon_coordinates":{"type":"MultiPolygon","coordinates":[[[[14.3801,52.5201],[14.3901,52.5201],[14.3901,52.5301],[14.3801,52.5301],[14.3801,52.5201]]]]},"start_date":"2027-01-01","end_date":"2031-12-31","term_commitment":5,"cobenefits":"[\"biodiversity\", \"water_quality\", \"soil_health\"]","methodologies":"[{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}]","monitoring_period_years":5,"monitoring_period_start_date":"2027-01-01","monitoring_period_end_date":"2031-12-31","certification_scheme_id":"CRCF Scheme","internal_note":"I'm flagging this for review"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/certificate-of-compliance-on-chain/{certificateofcomplianceonchainid}":{"get":{"tags":["_Certificate_of_compliance_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get certificate_of_compliance_on_chain by id","description":"<p>Get certificate_of_compliance_on_chain by id.</p>\n<p>For data from the block chain about about an activity. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certificate_of_compliance_id: Links to the <code>parcel</code> dynamic entity. The on-chain NFT is keyed by this id.</li>\n<li>certification_body_id: ID of the certification body</li>\n<li>token_id: CarbonProjectNFT token id minted for this parcel.</li>\n<li>minted_at: On-chain block timestamp (mintedAt) from projectData, unix seconds.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>contract_address: CarbonProjectNFT contract address the token was read from.</li>\n<li>chain_id: EVM chain id (OGCR chain = 2025).</li>\n<li>tx_hash: Mint transaction hash (from the CarbonProjectMinted</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>country_id: Country of issuance</li>\n<li>issue_date: Issuance data</li>\n<li>expiry_date: Expiry date</li>\n<li>carbon_removals_under_baseline: Carbon removals that would have occurred under the baseline, without the activity (CO2e tonnes)</li>\n<li>soil_emissions_under_baseline: Soil emissions that would have occurred under the baseline (CO2e tonnes)</li>\n<li>permanent_net_carbon_removal_benefit: Permanent net carbon removal benefit certified for the activity (CO2e tonnes)</li>\n<li>carbon_farming_temporary_net_carbon_removal_benefit: Temporary net carbon removal benefit from carbon farming certified for the activity (CO2e tonnes)</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: Net soil emission reduction benefit from carbon farming certified for the activity (CO2e tonnes)</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: Temporary net carbon removal benefit from carbon storage in products certified for the activity (CO2e tonnes)</li>\n<li>certification_status: Status of the certificate as stored on-chain. Either \"Certified\" or \"Expired\"</li>\n<li>certification_scheme_rules_and_procedures: Reference to the rules and procedures of the certification scheme under which the certificate was issued</li>\n<li>certification_annual_reports: Reference to the annual reports of the certification scheme</li>\n<li>activity_id: ID of the activity being certified.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certificate_of_compliance_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglecertificate_of_compliance_on_chain_ogcr","parameters":[{"name":"certificateofcomplianceonchainid","in":"path","description":"The CERTIFICATEOFCOMPLIANCEONCHAINID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certificate_of_compliance_on_chain":{"type":"object","properties":{"certification_annual_reports":{"type":"string"},"minted_at":{"type":"integer"},"token_uri":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"carbon_removals_under_baseline":{"type":"number"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"certification_scheme_rules_and_procedures":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"number"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"block_number":{"type":"integer"},"certificate_of_compliance_on_chain_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"token_id":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"contract_address":{"type":"string"},"certification_status":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"country_id":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certificate_of_compliance_on_chain":{"certificate_of_compliance_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certificate_of_compliance_id":"string","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b2","audit_report_id":"string","token_id":"parcel_AB12CD34EF","minted_at":1779280448,"owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","token_uri":"data:application/json;base64,eyJuYW1lIjoiQ2FyYm9uIn0=","contract_address":"0xeec918d74c746167564401103096D45BbD494B74","chain_id":2025,"tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","block_number":12345,"country_id":"DE","issue_date":"2026-12-25","expiry_date":"2031-12-25","carbon_removals_under_baseline":5.5,"soil_emissions_under_baseline":5.5,"permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":5.5,"carbon_storage_temporary_net_carbon_removal_benefit":5.5,"certification_status":"Certified","certification_scheme_rules_and_procedures":"https://scheme.example.org/rules-and-procedures-v2.1.pdf","certification_annual_reports":"https://scheme.example.org/annual-report-2026.pdf","activity_id":"a_05OFWI037022"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Certificate_of_compliance_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update certificate_of_compliance_on_chain","description":"<p>Update certificate_of_compliance_on_chain.</p>\n<p>For data from the block chain about about an activity. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certificate_of_compliance_id: Links to the <code>parcel</code> dynamic entity. The on-chain NFT is keyed by this id.</li>\n<li>certification_body_id: ID of the certification body</li>\n<li>token_id: CarbonProjectNFT token id minted for this parcel.</li>\n<li>minted_at: On-chain block timestamp (mintedAt) from projectData, unix seconds.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>contract_address: CarbonProjectNFT contract address the token was read from.</li>\n<li>chain_id: EVM chain id (OGCR chain = 2025).</li>\n<li>tx_hash: Mint transaction hash (from the CarbonProjectMinted</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>country_id: Country of issuance</li>\n<li>issue_date: Issuance data</li>\n<li>expiry_date: Expiry date</li>\n<li>carbon_removals_under_baseline: Carbon removals that would have occurred under the baseline, without the activity (CO2e tonnes)</li>\n<li>soil_emissions_under_baseline: Soil emissions that would have occurred under the baseline (CO2e tonnes)</li>\n<li>permanent_net_carbon_removal_benefit: Permanent net carbon removal benefit certified for the activity (CO2e tonnes)</li>\n<li>carbon_farming_temporary_net_carbon_removal_benefit: Temporary net carbon removal benefit from carbon farming certified for the activity (CO2e tonnes)</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: Net soil emission reduction benefit from carbon farming certified for the activity (CO2e tonnes)</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: Temporary net carbon removal benefit from carbon storage in products certified for the activity (CO2e tonnes)</li>\n<li>certification_status: Status of the certificate as stored on-chain. Either \"Certified\" or \"Expired\"</li>\n<li>certification_scheme_rules_and_procedures: Reference to the rules and procedures of the certification scheme under which the certificate was issued</li>\n<li>certification_annual_reports: Reference to the annual reports of the certification scheme</li>\n<li>activity_id: ID of the activity being certified.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certificate_of_compliance_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updatecertificate_of_compliance_on_chain_ogcr","parameters":[{"name":"certificateofcomplianceonchainid","in":"path","description":"The CERTIFICATEOFCOMPLIANCEONCHAINID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"certification_annual_reports":{"type":"string"},"minted_at":{"type":"integer"},"token_uri":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"carbon_removals_under_baseline":{"type":"number"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"certification_scheme_rules_and_procedures":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"number"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"block_number":{"type":"integer"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"token_id":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"contract_address":{"type":"string"},"certification_status":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"country_id":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"}}},"example":{"certificate_of_compliance_id":"string","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b2","audit_report_id":"string","token_id":"parcel_AB12CD34EF","minted_at":1779280448,"owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","token_uri":"data:application/json;base64,eyJuYW1lIjoiQ2FyYm9uIn0=","contract_address":"0xeec918d74c746167564401103096D45BbD494B74","chain_id":2025,"tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","block_number":12345,"country_id":"DE","issue_date":"2026-12-25","expiry_date":"2031-12-25","carbon_removals_under_baseline":5.5,"soil_emissions_under_baseline":5.5,"permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":5.5,"carbon_storage_temporary_net_carbon_removal_benefit":5.5,"certification_status":"Certified","certification_scheme_rules_and_procedures":"https://scheme.example.org/rules-and-procedures-v2.1.pdf","certification_annual_reports":"https://scheme.example.org/annual-report-2026.pdf","activity_id":"a_05OFWI037022"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certificate_of_compliance_on_chain":{"type":"object","properties":{"certification_annual_reports":{"type":"string"},"minted_at":{"type":"integer"},"token_uri":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"carbon_removals_under_baseline":{"type":"number"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"certification_scheme_rules_and_procedures":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"number"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"block_number":{"type":"integer"},"certificate_of_compliance_on_chain_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"token_id":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"contract_address":{"type":"string"},"certification_status":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"country_id":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certificate_of_compliance_on_chain":{"certificate_of_compliance_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certificate_of_compliance_id":"string","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b2","audit_report_id":"string","token_id":"parcel_AB12CD34EF","minted_at":1779280448,"owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","token_uri":"data:application/json;base64,eyJuYW1lIjoiQ2FyYm9uIn0=","contract_address":"0xeec918d74c746167564401103096D45BbD494B74","chain_id":2025,"tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","block_number":12345,"country_id":"DE","issue_date":"2026-12-25","expiry_date":"2031-12-25","carbon_removals_under_baseline":5.5,"soil_emissions_under_baseline":5.5,"permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":5.5,"carbon_storage_temporary_net_carbon_removal_benefit":5.5,"certification_status":"Certified","certification_scheme_rules_and_procedures":"https://scheme.example.org/rules-and-procedures-v2.1.pdf","certification_annual_reports":"https://scheme.example.org/annual-report-2026.pdf","activity_id":"a_05OFWI037022"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Certificate_of_compliance_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete certificate_of_compliance_on_chain by id","description":"<p>Delete certificate_of_compliance_on_chain by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certificate_of_compliance_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletecertificate_of_compliance_on_chain_ogcr","parameters":[{"name":"certificateofcomplianceonchainid","in":"path","description":"The CERTIFICATEOFCOMPLIANCEONCHAINID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certificate_of_compliance_on_chain":{"type":"object","properties":{"certification_annual_reports":{"type":"string"},"minted_at":{"type":"integer"},"token_uri":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"carbon_removals_under_baseline":{"type":"number"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"certification_scheme_rules_and_procedures":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"number"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"block_number":{"type":"integer"},"certificate_of_compliance_on_chain_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"token_id":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"contract_address":{"type":"string"},"certification_status":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"country_id":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certificate_of_compliance_on_chain":{"certificate_of_compliance_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certificate_of_compliance_id":"string","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b2","audit_report_id":"string","token_id":"parcel_AB12CD34EF","minted_at":1779280448,"owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","token_uri":"data:application/json;base64,eyJuYW1lIjoiQ2FyYm9uIn0=","contract_address":"0xeec918d74c746167564401103096D45BbD494B74","chain_id":2025,"tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","block_number":12345,"country_id":"DE","issue_date":"2026-12-25","expiry_date":"2031-12-25","carbon_removals_under_baseline":5.5,"soil_emissions_under_baseline":5.5,"permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":5.5,"carbon_storage_temporary_net_carbon_removal_benefit":5.5,"certification_status":"Certified","certification_scheme_rules_and_procedures":"https://scheme.example.org/rules-and-procedures-v2.1.pdf","certification_annual_reports":"https://scheme.example.org/annual-report-2026.pdf","activity_id":"a_05OFWI037022"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Certificate_of_compliance_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update certificate_of_compliance_on_chain","description":"<p>Partially update certificate_of_compliance_on_chain: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>For data from the block chain about about an activity. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certificate_of_compliance_id: Links to the <code>parcel</code> dynamic entity. The on-chain NFT is keyed by this id.</li>\n<li>certification_body_id: ID of the certification body</li>\n<li>token_id: CarbonProjectNFT token id minted for this parcel.</li>\n<li>minted_at: On-chain block timestamp (mintedAt) from projectData, unix seconds.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>contract_address: CarbonProjectNFT contract address the token was read from.</li>\n<li>chain_id: EVM chain id (OGCR chain = 2025).</li>\n<li>tx_hash: Mint transaction hash (from the CarbonProjectMinted</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>country_id: Country of issuance</li>\n<li>issue_date: Issuance data</li>\n<li>expiry_date: Expiry date</li>\n<li>carbon_removals_under_baseline: Carbon removals that would have occurred under the baseline, without the activity (CO2e tonnes)</li>\n<li>soil_emissions_under_baseline: Soil emissions that would have occurred under the baseline (CO2e tonnes)</li>\n<li>permanent_net_carbon_removal_benefit: Permanent net carbon removal benefit certified for the activity (CO2e tonnes)</li>\n<li>carbon_farming_temporary_net_carbon_removal_benefit: Temporary net carbon removal benefit from carbon farming certified for the activity (CO2e tonnes)</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: Net soil emission reduction benefit from carbon farming certified for the activity (CO2e tonnes)</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: Temporary net carbon removal benefit from carbon storage in products certified for the activity (CO2e tonnes)</li>\n<li>certification_status: Status of the certificate as stored on-chain. Either \"Certified\" or \"Expired\"</li>\n<li>certification_scheme_rules_and_procedures: Reference to the rules and procedures of the certification scheme under which the certificate was issued</li>\n<li>certification_annual_reports: Reference to the annual reports of the certification scheme</li>\n<li>activity_id: ID of the activity being certified.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certificate_of_compliance_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchcertificate_of_compliance_on_chain_ogcr","parameters":[{"name":"certificateofcomplianceonchainid","in":"path","description":"The CERTIFICATEOFCOMPLIANCEONCHAINID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"certification_annual_reports":{"type":"string"},"minted_at":{"type":"integer"},"token_uri":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"carbon_removals_under_baseline":{"type":"number"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"certification_scheme_rules_and_procedures":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"number"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"block_number":{"type":"integer"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"token_id":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"contract_address":{"type":"string"},"certification_status":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"country_id":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"}}},"example":{"certificate_of_compliance_id":"string","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b2","audit_report_id":"string","token_id":"parcel_AB12CD34EF","minted_at":1779280448,"owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","token_uri":"data:application/json;base64,eyJuYW1lIjoiQ2FyYm9uIn0=","contract_address":"0xeec918d74c746167564401103096D45BbD494B74","chain_id":2025,"tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","block_number":12345,"country_id":"DE","issue_date":"2026-12-25","expiry_date":"2031-12-25","carbon_removals_under_baseline":5.5,"soil_emissions_under_baseline":5.5,"permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":5.5,"carbon_storage_temporary_net_carbon_removal_benefit":5.5,"certification_status":"Certified","certification_scheme_rules_and_procedures":"https://scheme.example.org/rules-and-procedures-v2.1.pdf","certification_annual_reports":"https://scheme.example.org/annual-report-2026.pdf","activity_id":"a_05OFWI037022"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certificate_of_compliance_on_chain":{"type":"object","properties":{"certification_annual_reports":{"type":"string"},"minted_at":{"type":"integer"},"token_uri":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"carbon_removals_under_baseline":{"type":"number"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"certification_scheme_rules_and_procedures":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"number"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"block_number":{"type":"integer"},"certificate_of_compliance_on_chain_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"token_id":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"contract_address":{"type":"string"},"certification_status":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"country_id":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certificate_of_compliance_on_chain":{"certificate_of_compliance_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certificate_of_compliance_id":"string","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b2","audit_report_id":"string","token_id":"parcel_AB12CD34EF","minted_at":1779280448,"owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","token_uri":"data:application/json;base64,eyJuYW1lIjoiQ2FyYm9uIn0=","contract_address":"0xeec918d74c746167564401103096D45BbD494B74","chain_id":2025,"tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","block_number":12345,"country_id":"DE","issue_date":"2026-12-25","expiry_date":"2031-12-25","carbon_removals_under_baseline":5.5,"soil_emissions_under_baseline":5.5,"permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":5.5,"carbon_storage_temporary_net_carbon_removal_benefit":5.5,"certification_status":"Certified","certification_scheme_rules_and_procedures":"https://scheme.example.org/rules-and-procedures-v2.1.pdf","certification_annual_reports":"https://scheme.example.org/annual-report-2026.pdf","activity_id":"a_05OFWI037022"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/retirement-certificate-on-chain/{retirementcertificateonchainid}":{"get":{"tags":["_Retirement_certificate_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get retirement_certificate_on_chain by id","description":"<p>Get retirement_certificate_on_chain by id.</p>\n<p>Parsed entity retirement_certificate_on_chain. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_certificate_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleretirement_certificate_on_chain_ogcr","parameters":[{"name":"retirementcertificateonchainid","in":"path","description":"The RETIREMENTCERTIFICATEONCHAINID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_certificate_on_chain":{"type":"object","properties":{"end_use":{"type":"string"},"token_uri":{"type":"string"},"retirement_event_id":{"type":"string"},"owner_address":{"type":"string"},"retirement_certificate_id":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"certification_body_id":{"type":"string"},"serial_number":{"type":"string"},"block_number":{"type":"integer"},"contract_address":{"type":"string"},"unit_type":{"type":"string"},"minted_at":{"type":"integer"},"certification_scheme_id":{"type":"string"},"retirement_certificate_on_chain_id":{"type":"string"},"tx_hash":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"},"chain_id":{"type":"integer"},"beneficiary_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"retirement_certificate_on_chain":{"retirement_certificate_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_certificate_id":"string","serial_number":"string","retirement_event_id":"string","issue_date":"2020-01-01","beneficiary_name":"string","end_use":"string","amount":1.0,"unit_type":"string","activity_id":"string","operator_id":"string","certification_scheme_id":"string","certification_body_id":"string","minted_at":1,"owner_address":"string","token_uri":"string","contract_address":"string","chain_id":1,"tx_hash":"string","block_number":1},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Retirement_certificate_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update retirement_certificate_on_chain","description":"<p>Update retirement_certificate_on_chain.</p>\n<p>Parsed entity retirement_certificate_on_chain. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_certificate_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateretirement_certificate_on_chain_ogcr","parameters":[{"name":"retirementcertificateonchainid","in":"path","description":"The RETIREMENTCERTIFICATEONCHAINID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"end_use":{"type":"string"},"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"retirement_event_id":{"type":"string"},"owner_address":{"type":"string"},"retirement_certificate_id":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"certification_body_id":{"type":"string"},"serial_number":{"type":"string"},"block_number":{"type":"integer"},"contract_address":{"type":"string"},"unit_type":{"type":"string"},"minted_at":{"type":"integer"},"certification_scheme_id":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"},"chain_id":{"type":"integer"},"beneficiary_name":{"type":"string"}}},"example":{"retirement_certificate_id":"string","serial_number":"string","retirement_event_id":"string","issue_date":"2020-01-01","beneficiary_name":"string","end_use":"string","amount":1.0,"unit_type":"string","activity_id":"string","operator_id":"string","certification_scheme_id":"string","certification_body_id":"string","minted_at":1,"owner_address":"string","token_uri":"string","contract_address":"string","chain_id":1,"tx_hash":"string","block_number":1}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_certificate_on_chain":{"type":"object","properties":{"end_use":{"type":"string"},"token_uri":{"type":"string"},"retirement_event_id":{"type":"string"},"owner_address":{"type":"string"},"retirement_certificate_id":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"certification_body_id":{"type":"string"},"serial_number":{"type":"string"},"block_number":{"type":"integer"},"contract_address":{"type":"string"},"unit_type":{"type":"string"},"minted_at":{"type":"integer"},"certification_scheme_id":{"type":"string"},"retirement_certificate_on_chain_id":{"type":"string"},"tx_hash":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"},"chain_id":{"type":"integer"},"beneficiary_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"retirement_certificate_on_chain":{"retirement_certificate_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_certificate_id":"string","serial_number":"string","retirement_event_id":"string","issue_date":"2020-01-01","beneficiary_name":"string","end_use":"string","amount":1.0,"unit_type":"string","activity_id":"string","operator_id":"string","certification_scheme_id":"string","certification_body_id":"string","minted_at":1,"owner_address":"string","token_uri":"string","contract_address":"string","chain_id":1,"tx_hash":"string","block_number":1},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Retirement_certificate_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete retirement_certificate_on_chain by id","description":"<p>Delete retirement_certificate_on_chain by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_certificate_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteretirement_certificate_on_chain_ogcr","parameters":[{"name":"retirementcertificateonchainid","in":"path","description":"The RETIREMENTCERTIFICATEONCHAINID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_certificate_on_chain":{"type":"object","properties":{"end_use":{"type":"string"},"token_uri":{"type":"string"},"retirement_event_id":{"type":"string"},"owner_address":{"type":"string"},"retirement_certificate_id":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"certification_body_id":{"type":"string"},"serial_number":{"type":"string"},"block_number":{"type":"integer"},"contract_address":{"type":"string"},"unit_type":{"type":"string"},"minted_at":{"type":"integer"},"certification_scheme_id":{"type":"string"},"retirement_certificate_on_chain_id":{"type":"string"},"tx_hash":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"},"chain_id":{"type":"integer"},"beneficiary_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"retirement_certificate_on_chain":{"retirement_certificate_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_certificate_id":"string","serial_number":"string","retirement_event_id":"string","issue_date":"2020-01-01","beneficiary_name":"string","end_use":"string","amount":1.0,"unit_type":"string","activity_id":"string","operator_id":"string","certification_scheme_id":"string","certification_body_id":"string","minted_at":1,"owner_address":"string","token_uri":"string","contract_address":"string","chain_id":1,"tx_hash":"string","block_number":1},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Retirement_certificate_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update retirement_certificate_on_chain","description":"<p>Partially update retirement_certificate_on_chain: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Parsed entity retirement_certificate_on_chain. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_certificate_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchretirement_certificate_on_chain_ogcr","parameters":[{"name":"retirementcertificateonchainid","in":"path","description":"The RETIREMENTCERTIFICATEONCHAINID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"end_use":{"type":"string"},"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"retirement_event_id":{"type":"string"},"owner_address":{"type":"string"},"retirement_certificate_id":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"certification_body_id":{"type":"string"},"serial_number":{"type":"string"},"block_number":{"type":"integer"},"contract_address":{"type":"string"},"unit_type":{"type":"string"},"minted_at":{"type":"integer"},"certification_scheme_id":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"},"chain_id":{"type":"integer"},"beneficiary_name":{"type":"string"}}},"example":{"retirement_certificate_id":"string","serial_number":"string","retirement_event_id":"string","issue_date":"2020-01-01","beneficiary_name":"string","end_use":"string","amount":1.0,"unit_type":"string","activity_id":"string","operator_id":"string","certification_scheme_id":"string","certification_body_id":"string","minted_at":1,"owner_address":"string","token_uri":"string","contract_address":"string","chain_id":1,"tx_hash":"string","block_number":1}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_certificate_on_chain":{"type":"object","properties":{"end_use":{"type":"string"},"token_uri":{"type":"string"},"retirement_event_id":{"type":"string"},"owner_address":{"type":"string"},"retirement_certificate_id":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"certification_body_id":{"type":"string"},"serial_number":{"type":"string"},"block_number":{"type":"integer"},"contract_address":{"type":"string"},"unit_type":{"type":"string"},"minted_at":{"type":"integer"},"certification_scheme_id":{"type":"string"},"retirement_certificate_on_chain_id":{"type":"string"},"tx_hash":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"},"chain_id":{"type":"integer"},"beneficiary_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"retirement_certificate_on_chain":{"retirement_certificate_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_certificate_id":"string","serial_number":"string","retirement_event_id":"string","issue_date":"2020-01-01","beneficiary_name":"string","end_use":"string","amount":1.0,"unit_type":"string","activity_id":"string","operator_id":"string","certification_scheme_id":"string","certification_body_id":"string","minted_at":1,"owner_address":"string","token_uri":"string","contract_address":"string","chain_id":1,"tx_hash":"string","block_number":1},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/technologies-practices-processes":{"get":{"tags":["_Technologies_practices_processes(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get technologies_practices_processes List","description":"<p>Get technologies_practices_processes List.</p>\n<p>This is the lookup table for technologies, practices and processes. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"technologies_practices_processes\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>technologies_practices_processes_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_gettechnologies_practices_processesList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"technologies_practices_processes_list":{"type":"array","items":{"type":"object","properties":{"technologies_practices_processes":{"type":"object","properties":{"technologies_practices_processes_id":{"type":"string"},"practice_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"technologies_practices_processes_list":[{"technologies_practices_processes":{"technologies_practices_processes_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","technologies_practices_processes_id":"string","practice_name":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Technologies_practices_processes(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new technologies_practices_processes","description":"<p>Create new technologies_practices_processes.</p>\n<p>This is the lookup table for technologies, practices and processes. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"technologies_practices_processes\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createtechnologies_practices_processes_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"technologies_practices_processes_id":{"type":"string"},"practice_name":{"type":"string"}}},"example":{"technologies_practices_processes_id":"string","practice_name":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"technologies_practices_processes":{"type":"object","properties":{"technologies_practices_processes_id":{"type":"string"},"practice_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"technologies_practices_processes":{"technologies_practices_processes_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","technologies_practices_processes_id":"string","practice_name":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/country/{countryid}":{"get":{"tags":["_Country(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get country by id","description":"<p>Get country by id.</p>\n<p>Parsed entity country. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>country_id: ISO 3166-1 alpha-2 country code for where the activity occurs.</li>\n<li>country_name: Name of the country</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"country\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglecountry_ogcr","parameters":[{"name":"countryid","in":"path","description":"The COUNTRYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"country":{"type":"object","properties":{"country_id":{"type":"string"},"country_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"country":{"country_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","country_id":"DE","country_name":"Germany"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Country(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update country","description":"<p>Update country.</p>\n<p>Parsed entity country. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>country_id: ISO 3166-1 alpha-2 country code for where the activity occurs.</li>\n<li>country_name: Name of the country</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"country\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updatecountry_ogcr","parameters":[{"name":"countryid","in":"path","description":"The COUNTRYID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"country_id":{"type":"string"},"country_name":{"type":"string"}}},"example":{"country_id":"DE","country_name":"Germany"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"country":{"type":"object","properties":{"country_id":{"type":"string"},"country_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"country":{"country_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","country_id":"DE","country_name":"Germany"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Country(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete country by id","description":"<p>Delete country by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"country\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletecountry_ogcr","parameters":[{"name":"countryid","in":"path","description":"The COUNTRYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"country":{"type":"object","properties":{"country_id":{"type":"string"},"country_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"country":{"country_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","country_id":"DE","country_name":"Germany"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Country(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update country","description":"<p>Partially update country: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Parsed entity country. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>country_id: ISO 3166-1 alpha-2 country code for where the activity occurs.</li>\n<li>country_name: Name of the country</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"country\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchcountry_ogcr","parameters":[{"name":"countryid","in":"path","description":"The COUNTRYID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"country_id":{"type":"string"},"country_name":{"type":"string"}}},"example":{"country_id":"DE","country_name":"Germany"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"country":{"type":"object","properties":{"country_id":{"type":"string"},"country_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"country":{"country_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","country_id":"DE","country_name":"Germany"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/supervisory-non-conformity/{supervisorynonconformityid}":{"get":{"tags":["_Supervisory_non_conformity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get supervisory_non_conformity by id","description":"<p>Get supervisory_non_conformity by id.</p>\n<p>\u2018non-conformity\u2019 means a failure by an operator or a certification body to comply with the rules and procedures, established by the certification scheme, of which they are members or under which they operate. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>category: critical, major and minor</li>\n<li>remediation_timeline: Timeline for remediation of non-conformities</li>\n<li>sanction: Sanction imposed for the non-conformity, e.g. warning, suspension or withdrawal of certification</li>\n<li>certification_body_id: The certification body this non  conformity refers to</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"supervisory_non_conformity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglesupervisory_non_conformity_ogcr","parameters":[{"name":"supervisorynonconformityid","in":"path","description":"The SUPERVISORYNONCONFORMITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"supervisory_non_conformity":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"sanction":{"type":"string"},"audit_report_id":{"type":"string"},"supervisory_finding_id":{"type":"string"},"remediation_timeline":{"type":"string"},"supervisory_non_conformity_id":{"type":"string"},"certification_body_id":{"type":"string"},"category":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"supervisory_non_conformity":{"supervisory_non_conformity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supervisory_non_conformity_id":"string","supervisory_finding_id":"string","audit_report_id":"string","category":"string","remediation_timeline":"string","sanction":"warning","certification_scheme_id":"string","certification_body_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Supervisory_non_conformity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update supervisory_non_conformity","description":"<p>Update supervisory_non_conformity.</p>\n<p>\u2018non-conformity\u2019 means a failure by an operator or a certification body to comply with the rules and procedures, established by the certification scheme, of which they are members or under which they operate. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>category: critical, major and minor</li>\n<li>remediation_timeline: Timeline for remediation of non-conformities</li>\n<li>sanction: Sanction imposed for the non-conformity, e.g. warning, suspension or withdrawal of certification</li>\n<li>certification_body_id: The certification body this non  conformity refers to</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"supervisory_non_conformity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updatesupervisory_non_conformity_ogcr","parameters":[{"name":"supervisorynonconformityid","in":"path","description":"The SUPERVISORYNONCONFORMITYID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"sanction":{"type":"string"},"audit_report_id":{"type":"string"},"supervisory_finding_id":{"type":"string"},"remediation_timeline":{"type":"string"},"supervisory_non_conformity_id":{"type":"string"},"certification_body_id":{"type":"string"},"category":{"type":"string"}}},"example":{"supervisory_non_conformity_id":"string","supervisory_finding_id":"string","audit_report_id":"string","category":"string","remediation_timeline":"string","sanction":"warning","certification_scheme_id":"string","certification_body_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"supervisory_non_conformity":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"sanction":{"type":"string"},"audit_report_id":{"type":"string"},"supervisory_finding_id":{"type":"string"},"remediation_timeline":{"type":"string"},"supervisory_non_conformity_id":{"type":"string"},"certification_body_id":{"type":"string"},"category":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"supervisory_non_conformity":{"supervisory_non_conformity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supervisory_non_conformity_id":"string","supervisory_finding_id":"string","audit_report_id":"string","category":"string","remediation_timeline":"string","sanction":"warning","certification_scheme_id":"string","certification_body_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Supervisory_non_conformity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete supervisory_non_conformity by id","description":"<p>Delete supervisory_non_conformity by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"supervisory_non_conformity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletesupervisory_non_conformity_ogcr","parameters":[{"name":"supervisorynonconformityid","in":"path","description":"The SUPERVISORYNONCONFORMITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"supervisory_non_conformity":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"sanction":{"type":"string"},"audit_report_id":{"type":"string"},"supervisory_finding_id":{"type":"string"},"remediation_timeline":{"type":"string"},"supervisory_non_conformity_id":{"type":"string"},"certification_body_id":{"type":"string"},"category":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"supervisory_non_conformity":{"supervisory_non_conformity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supervisory_non_conformity_id":"string","supervisory_finding_id":"string","audit_report_id":"string","category":"string","remediation_timeline":"string","sanction":"warning","certification_scheme_id":"string","certification_body_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Supervisory_non_conformity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update supervisory_non_conformity","description":"<p>Partially update supervisory_non_conformity: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>\u2018non-conformity\u2019 means a failure by an operator or a certification body to comply with the rules and procedures, established by the certification scheme, of which they are members or under which they operate. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>category: critical, major and minor</li>\n<li>remediation_timeline: Timeline for remediation of non-conformities</li>\n<li>sanction: Sanction imposed for the non-conformity, e.g. warning, suspension or withdrawal of certification</li>\n<li>certification_body_id: The certification body this non  conformity refers to</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"supervisory_non_conformity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchsupervisory_non_conformity_ogcr","parameters":[{"name":"supervisorynonconformityid","in":"path","description":"The SUPERVISORYNONCONFORMITYID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"sanction":{"type":"string"},"audit_report_id":{"type":"string"},"supervisory_finding_id":{"type":"string"},"remediation_timeline":{"type":"string"},"supervisory_non_conformity_id":{"type":"string"},"certification_body_id":{"type":"string"},"category":{"type":"string"}}},"example":{"supervisory_non_conformity_id":"string","supervisory_finding_id":"string","audit_report_id":"string","category":"string","remediation_timeline":"string","sanction":"warning","certification_scheme_id":"string","certification_body_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"supervisory_non_conformity":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"sanction":{"type":"string"},"audit_report_id":{"type":"string"},"supervisory_finding_id":{"type":"string"},"remediation_timeline":{"type":"string"},"supervisory_non_conformity_id":{"type":"string"},"certification_body_id":{"type":"string"},"category":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"supervisory_non_conformity":{"supervisory_non_conformity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supervisory_non_conformity_id":"string","supervisory_finding_id":"string","audit_report_id":"string","category":"string","remediation_timeline":"string","sanction":"warning","certification_scheme_id":"string","certification_body_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/monitoring-plan":{"get":{"tags":["_Monitoring_plan(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get monitoring_plan List","description":"<p>Get monitoring_plan List.</p>\n<p>Parsed entity monitoring_plan. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>monitoring_plan_id: Unique identifier for monitoring plan entity</li>\n<li>date_submitted: Date/time the monitoring plan was submitted. Created by system.</li>\n<li>monitored_data_parameters: List of parameters to be collected/computed during monitoring (should be structured, each with name, unit, and scope).</li>\n<li>monitoring_frequency: How often each parameter is monitored (months)</li>\n<li>emission_sources_and_sinks: Emission sources and sinks</li>\n<li>data_source: Where the monitored data comes from (field sampling, remote sensing, farm management system, invoices, IoT).</li>\n<li>measurement_methods_procedures_accuracy_calibration: Measurement methods and procedures (accuracy and calibration)</li>\n<li>quality_assessment_or_quality_control_procedures: Quality assessment or quality control procedures</li>\n<li>responsibility_for_collection_and_archiving: Responsibility for collection and archiving</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"monitoring_plan\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>monitoring_plan_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>activity_id</code> → <code>activity</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getmonitoring_planList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"monitoring_plan_list":{"type":"array","items":{"type":"object","properties":{"monitoring_plan":{"type":"object","properties":{"emission_sources_and_sinks":{"type":"string"},"monitoring_frequency":{"type":"integer"},"monitored_data_parameters":{"type":"string"},"date_submitted":{"type":"string"},"responsibility_for_collection_and_archiving":{"type":"string"},"activity_id":{"type":"string"},"quality_assessment_or_quality_control_procedures":{"type":"string"},"monitoring_plan_id":{"type":"string"},"measurement_methods_procedures_accuracy_calibration":{"type":"string"},"data_source":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"monitoring_plan_list":[{"monitoring_plan":{"monitoring_plan_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","monitoring_plan_id":"mp_01HZYW8C9R7P4D2A6K1TQ3","date_submitted":"2026-11-20","activity_id":"string","monitored_data_parameters":"[{\"name\": \"soc_percent\", \"unit\": \"%\", \"scope\": \"soil_0_30cm\"}, {\"name\": \"bulk_density\", \"unit\": \"g/cm3\", \"scope\": \"soil_0_30cm\"}, {\"name\": \"yield\", \"unit\": \"t/ha\", \"scope\": \"crop_wheat\"}]","monitoring_frequency":12,"emission_sources_and_sinks":"Sources: fertiliser use, machinery fuel. Sinks: soil organic carbon in the 0-30 cm layer","data_source":"Field soil sampling, remote sensing (NDVI), farm management system records","measurement_methods_procedures_accuracy_calibration":"Soil cores analysed by dry combustion (accuracy ±0.1% SOC), lab equipment calibrated annually","quality_assessment_or_quality_control_procedures":"Duplicate samples for 10% of plots; lab results checked against certified reference material","responsibility_for_collection_and_archiving":"Farm manager collects the data; operator archives it for 10 years"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Monitoring_plan(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new monitoring_plan","description":"<p>Create new monitoring_plan.</p>\n<p>Parsed entity monitoring_plan. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>monitoring_plan_id: Unique identifier for monitoring plan entity</li>\n<li>date_submitted: Date/time the monitoring plan was submitted. Created by system.</li>\n<li>monitored_data_parameters: List of parameters to be collected/computed during monitoring (should be structured, each with name, unit, and scope).</li>\n<li>monitoring_frequency: How often each parameter is monitored (months)</li>\n<li>emission_sources_and_sinks: Emission sources and sinks</li>\n<li>data_source: Where the monitored data comes from (field sampling, remote sensing, farm management system, invoices, IoT).</li>\n<li>measurement_methods_procedures_accuracy_calibration: Measurement methods and procedures (accuracy and calibration)</li>\n<li>quality_assessment_or_quality_control_procedures: Quality assessment or quality control procedures</li>\n<li>responsibility_for_collection_and_archiving: Responsibility for collection and archiving</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"monitoring_plan\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createmonitoring_plan_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"emission_sources_and_sinks":{"type":"string"},"monitoring_frequency":{"type":"integer"},"monitored_data_parameters":{"type":"string"},"date_submitted":{"type":"string"},"responsibility_for_collection_and_archiving":{"type":"string"},"activity_id":{"type":"string"},"quality_assessment_or_quality_control_procedures":{"type":"string"},"monitoring_plan_id":{"type":"string"},"measurement_methods_procedures_accuracy_calibration":{"type":"string"},"data_source":{"type":"string"}}},"example":{"monitoring_plan_id":"mp_01HZYW8C9R7P4D2A6K1TQ3","date_submitted":"2026-11-20","activity_id":"string","monitored_data_parameters":"[{\"name\": \"soc_percent\", \"unit\": \"%\", \"scope\": \"soil_0_30cm\"}, {\"name\": \"bulk_density\", \"unit\": \"g/cm3\", \"scope\": \"soil_0_30cm\"}, {\"name\": \"yield\", \"unit\": \"t/ha\", \"scope\": \"crop_wheat\"}]","monitoring_frequency":12,"emission_sources_and_sinks":"Sources: fertiliser use, machinery fuel. Sinks: soil organic carbon in the 0-30 cm layer","data_source":"Field soil sampling, remote sensing (NDVI), farm management system records","measurement_methods_procedures_accuracy_calibration":"Soil cores analysed by dry combustion (accuracy ±0.1% SOC), lab equipment calibrated annually","quality_assessment_or_quality_control_procedures":"Duplicate samples for 10% of plots; lab results checked against certified reference material","responsibility_for_collection_and_archiving":"Farm manager collects the data; operator archives it for 10 years"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"monitoring_plan":{"type":"object","properties":{"emission_sources_and_sinks":{"type":"string"},"monitoring_frequency":{"type":"integer"},"monitored_data_parameters":{"type":"string"},"date_submitted":{"type":"string"},"responsibility_for_collection_and_archiving":{"type":"string"},"activity_id":{"type":"string"},"quality_assessment_or_quality_control_procedures":{"type":"string"},"monitoring_plan_id":{"type":"string"},"measurement_methods_procedures_accuracy_calibration":{"type":"string"},"data_source":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"monitoring_plan":{"monitoring_plan_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","monitoring_plan_id":"mp_01HZYW8C9R7P4D2A6K1TQ3","date_submitted":"2026-11-20","activity_id":"string","monitored_data_parameters":"[{\"name\": \"soc_percent\", \"unit\": \"%\", \"scope\": \"soil_0_30cm\"}, {\"name\": \"bulk_density\", \"unit\": \"g/cm3\", \"scope\": \"soil_0_30cm\"}, {\"name\": \"yield\", \"unit\": \"t/ha\", \"scope\": \"crop_wheat\"}]","monitoring_frequency":12,"emission_sources_and_sinks":"Sources: fertiliser use, machinery fuel. Sinks: soil organic carbon in the 0-30 cm layer","data_source":"Field soil sampling, remote sensing (NDVI), farm management system records","measurement_methods_procedures_accuracy_calibration":"Soil cores analysed by dry combustion (accuracy ±0.1% SOC), lab equipment calibrated annually","quality_assessment_or_quality_control_procedures":"Duplicate samples for 10% of plots; lab results checked against certified reference material","responsibility_for_collection_and_archiving":"Farm manager collects the data; operator archives it for 10 years"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/co-benefits":{"get":{"tags":["_Co_benefits(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get co_benefits List","description":"<p>Get co_benefits List.</p>\n<p>Parsed entity co_benefits. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"co_benefits\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p><em>(no fields on this entity are declared <code>indexed</code>, so only the legacy bare-parameter filter below is available.)</em></p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getco_benefitsList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"co_benefits_list":{"type":"array","items":{"type":"object","properties":{"co_benefits":{"type":"object","properties":{"co_benefits_id":{"type":"string"},"co_benefit_id":{"type":"string"},"co_benefit_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"co_benefits_list":[{"co_benefits":{"co_benefits_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","co_benefit_id":"string","co_benefit_name":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Co_benefits(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new co_benefits","description":"<p>Create new co_benefits.</p>\n<p>Parsed entity co_benefits. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"co_benefits\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createco_benefits_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"co_benefit_id":{"type":"string"},"co_benefit_name":{"type":"string"}}},"example":{"co_benefit_id":"string","co_benefit_name":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"co_benefits":{"type":"object","properties":{"co_benefits_id":{"type":"string"},"co_benefit_id":{"type":"string"},"co_benefit_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"co_benefits":{"co_benefits_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","co_benefit_id":"string","co_benefit_name":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/activity":{"get":{"tags":["_Activity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get activity List","description":"<p>Get activity List.</p>\n<p>\u2018activity\u2019 means one or more practices or processes carried out by an operator, or a group of operators, resulting in a permanent/temporary carbon removal through carbon farming or carbon storage in products, or soil emission reductions. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_id: Internal identifier for the activity</li>\n<li>name: Human-readable activity name shown in UI and exports.</li>\n<li>summary: 1\u20132 sentence public summary, used in Activity listing.</li>\n<li>description: Longer narrative description (scope, intent, participants, context).</li>\n<li>website: Public URL with activity/operator details</li>\n<li>hero_image: Primary image URL for hero image</li>\n<li>image: Primary image URL or asset reference for UI cards.</li>\n<li>operator_id: Internal identifier for the operator entity</li>\n<li>activity_type: Activity category, based on technologies, practices and processes. (CARBON_FARMING, PERMANENT_REMOVAL, CARBON_STORAGE_IN_PRODUCTS)</li>\n<li>unit_types: Unit category that will be produced during this activity. (Permanent Removal,<br />\nCarbon Farming Sequestration, Soil Emission Reduction, Carbon Storage in Product)</li>\n<li>city: Primary city/municipality associated with the activity</li>\n<li>country_id: ISO 3166-1 alpha-2 country code for where the activity occurs.</li>\n<li>multipolygon_coordinates: GeoJSON MultiPolygon boundary of the activity area.</li>\n<li>start_date: Start date of the activity implementation period (when practices/process begin).</li>\n<li>end_date: End date of the activity implementation period.</li>\n<li>term_commitment: Commitment/contract duration for maintaining practices.</li>\n<li>cobenefits: Declared co-benefits</li>\n<li>methodologies: Methodology IDs/names and versions used to quantify outcomes</li>\n<li>monitoring_period_years: Planned monitoring duration in years</li>\n<li>monitoring_period_start_date: Start date of the monitoring window used for MRV/accounting</li>\n<li>monitoring_period_end_date: End date of the monitoring window</li>\n<li>certification_scheme_id: ID of the certification scheme chosen by the operator.</li>\n<li>internal_note: An internal note that will not be displayed to the public</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>certification_scheme_id</code>, <code>country_id</code>, <code>operator_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>certification_scheme_id</code> → <code>certification_scheme</code>, <code>country_id</code> → <code>country</code>, <code>operator_id</code> → <code>operator</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getactivityList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_list":{"type":"array","items":{"type":"object","properties":{"activity":{"type":"object","properties":{"name":{"type":"string"},"start_date":{"type":"string"},"certification_scheme_id":{"type":"string"},"methodologies":{"type":"string"},"image":{"type":"string"},"description":{"type":"string"},"cobenefits":{"type":"string"},"internal_note":{"type":"string"},"multipolygon_coordinates":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"array","maxItems":2,"minItems":2,"items":{"type":"number"}}}}}}},"activity_type":{"type":"string"},"hero_image":{"type":"string"},"monitoring_period_end_date":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"summary":{"type":"string"},"website":{"type":"string"},"city":{"type":"string"},"term_commitment":{"type":"integer"},"end_date":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"unit_types":{"type":"string"},"monitoring_period_years":{"type":"integer"},"country_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"activity_list":[{"activity":{"activity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"a_05OFWI037022","name":"Brandenburg Regenerative Wheat","summary":"Wheat rotation adopting cover crops and reduced tillage across enrolled parcels.","description":"This activity aggregates multiple parcels under a single operator to monitor practice changes and estimate carbon stock change over the monitoring period.","website":"https://example.org/activities/brandenburg-wheat","hero_image":"https://cdn.example.org/activity-images/activity_123.png","image":"https://cdn.example.org/activity-images/activity_123.png","operator_id":"op_01JS0347FKH","activity_type":"CARBON_FARMING","unit_types":"Soil Emission Reduction","city":"Seelow","country_id":"DE","multipolygon_coordinates":{"type":"MultiPolygon","coordinates":[[[[14.3801,52.5201],[14.3901,52.5201],[14.3901,52.5301],[14.3801,52.5301],[14.3801,52.5201]]]]},"start_date":"2027-01-01","end_date":"2031-12-31","term_commitment":5,"cobenefits":"[\"biodiversity\", \"water_quality\", \"soil_health\"]","methodologies":"[{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}]","monitoring_period_years":5,"monitoring_period_start_date":"2027-01-01","monitoring_period_end_date":"2031-12-31","certification_scheme_id":"CRCF Scheme","internal_note":"I'm flagging this for review"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Activity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new activity","description":"<p>Create new activity.</p>\n<p>\u2018activity\u2019 means one or more practices or processes carried out by an operator, or a group of operators, resulting in a permanent/temporary carbon removal through carbon farming or carbon storage in products, or soil emission reductions. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_id: Internal identifier for the activity</li>\n<li>name: Human-readable activity name shown in UI and exports.</li>\n<li>summary: 1\u20132 sentence public summary, used in Activity listing.</li>\n<li>description: Longer narrative description (scope, intent, participants, context).</li>\n<li>website: Public URL with activity/operator details</li>\n<li>hero_image: Primary image URL for hero image</li>\n<li>image: Primary image URL or asset reference for UI cards.</li>\n<li>operator_id: Internal identifier for the operator entity</li>\n<li>activity_type: Activity category, based on technologies, practices and processes. (CARBON_FARMING, PERMANENT_REMOVAL, CARBON_STORAGE_IN_PRODUCTS)</li>\n<li>unit_types: Unit category that will be produced during this activity. (Permanent Removal,<br />\nCarbon Farming Sequestration, Soil Emission Reduction, Carbon Storage in Product)</li>\n<li>city: Primary city/municipality associated with the activity</li>\n<li>country_id: ISO 3166-1 alpha-2 country code for where the activity occurs.</li>\n<li>multipolygon_coordinates: GeoJSON MultiPolygon boundary of the activity area.</li>\n<li>start_date: Start date of the activity implementation period (when practices/process begin).</li>\n<li>end_date: End date of the activity implementation period.</li>\n<li>term_commitment: Commitment/contract duration for maintaining practices.</li>\n<li>cobenefits: Declared co-benefits</li>\n<li>methodologies: Methodology IDs/names and versions used to quantify outcomes</li>\n<li>monitoring_period_years: Planned monitoring duration in years</li>\n<li>monitoring_period_start_date: Start date of the monitoring window used for MRV/accounting</li>\n<li>monitoring_period_end_date: End date of the monitoring window</li>\n<li>certification_scheme_id: ID of the certification scheme chosen by the operator.</li>\n<li>internal_note: An internal note that will not be displayed to the public</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createactivity_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"start_date":{"type":"string"},"certification_scheme_id":{"type":"string"},"methodologies":{"type":"string"},"image":{"type":"string"},"description":{"type":"string"},"cobenefits":{"type":"string"},"internal_note":{"type":"string"},"multipolygon_coordinates":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"array","maxItems":2,"minItems":2,"items":{"type":"number"}}}}}}},"activity_type":{"type":"string"},"hero_image":{"type":"string"},"monitoring_period_end_date":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"summary":{"type":"string"},"website":{"type":"string"},"city":{"type":"string"},"term_commitment":{"type":"integer"},"end_date":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"unit_types":{"type":"string"},"monitoring_period_years":{"type":"integer"},"country_id":{"type":"string"}}},"example":{"activity_id":"a_05OFWI037022","name":"Brandenburg Regenerative Wheat","summary":"Wheat rotation adopting cover crops and reduced tillage across enrolled parcels.","description":"This activity aggregates multiple parcels under a single operator to monitor practice changes and estimate carbon stock change over the monitoring period.","website":"https://example.org/activities/brandenburg-wheat","hero_image":"https://cdn.example.org/activity-images/activity_123.png","image":"https://cdn.example.org/activity-images/activity_123.png","operator_id":"op_01JS0347FKH","activity_type":"CARBON_FARMING","unit_types":"Soil Emission Reduction","city":"Seelow","country_id":"DE","multipolygon_coordinates":{"type":"MultiPolygon","coordinates":[[[[14.3801,52.5201],[14.3901,52.5201],[14.3901,52.5301],[14.3801,52.5301],[14.3801,52.5201]]]]},"start_date":"2027-01-01","end_date":"2031-12-31","term_commitment":5,"cobenefits":"[\"biodiversity\", \"water_quality\", \"soil_health\"]","methodologies":"[{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}]","monitoring_period_years":5,"monitoring_period_start_date":"2027-01-01","monitoring_period_end_date":"2031-12-31","certification_scheme_id":"CRCF Scheme","internal_note":"I'm flagging this for review"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity":{"type":"object","properties":{"name":{"type":"string"},"start_date":{"type":"string"},"certification_scheme_id":{"type":"string"},"methodologies":{"type":"string"},"image":{"type":"string"},"description":{"type":"string"},"cobenefits":{"type":"string"},"internal_note":{"type":"string"},"multipolygon_coordinates":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"array","maxItems":2,"minItems":2,"items":{"type":"number"}}}}}}},"activity_type":{"type":"string"},"hero_image":{"type":"string"},"monitoring_period_end_date":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"summary":{"type":"string"},"website":{"type":"string"},"city":{"type":"string"},"term_commitment":{"type":"integer"},"end_date":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"unit_types":{"type":"string"},"monitoring_period_years":{"type":"integer"},"country_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity":{"activity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"a_05OFWI037022","name":"Brandenburg Regenerative Wheat","summary":"Wheat rotation adopting cover crops and reduced tillage across enrolled parcels.","description":"This activity aggregates multiple parcels under a single operator to monitor practice changes and estimate carbon stock change over the monitoring period.","website":"https://example.org/activities/brandenburg-wheat","hero_image":"https://cdn.example.org/activity-images/activity_123.png","image":"https://cdn.example.org/activity-images/activity_123.png","operator_id":"op_01JS0347FKH","activity_type":"CARBON_FARMING","unit_types":"Soil Emission Reduction","city":"Seelow","country_id":"DE","multipolygon_coordinates":{"type":"MultiPolygon","coordinates":[[[[14.3801,52.5201],[14.3901,52.5201],[14.3901,52.5301],[14.3801,52.5301],[14.3801,52.5201]]]]},"start_date":"2027-01-01","end_date":"2031-12-31","term_commitment":5,"cobenefits":"[\"biodiversity\", \"water_quality\", \"soil_health\"]","methodologies":"[{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}]","monitoring_period_years":5,"monitoring_period_start_date":"2027-01-01","monitoring_period_end_date":"2031-12-31","certification_scheme_id":"CRCF Scheme","internal_note":"I'm flagging this for review"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/user-authority-relationship":{"get":{"tags":["_User_authority_relationship(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get user_authority_relationship List","description":"<p>Get user_authority_relationship List.</p>\n<p>Describes the relationship between a User (the logged in User via OAuth2/OIDC or a Consent) and the Certification Body. This intersecting entity allows a many to many relationship between Users and Certification Bodies. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>user_id: (Authenticated) User</li>\n<li>authority_id: the authority (uu)id</li>\n<li>relationship_to_authority: relationship describes the user's relationship to the authority: the user is the subject, the authority is the  object</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"user_authority_relationship\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p><em>(no fields on this entity are declared <code>indexed</code>, so only the legacy bare-parameter filter below is available.)</em></p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getuser_authority_relationshipList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"user_authority_relationship_list":{"type":"array","items":{"type":"object","properties":{"user_authority_relationship":{"type":"object","properties":{"user_authority_relationship_id":{"type":"string"},"user_id":{"type":"string"},"authority_id":{"type":"string"},"relationship_to_authority":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"user_authority_relationship_list":[{"user_authority_relationship":{"user_authority_relationship_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","authority_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_authority":"Managing Director, Employee, Accountant"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_User_authority_relationship(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new user_authority_relationship","description":"<p>Create new user_authority_relationship.</p>\n<p>Describes the relationship between a User (the logged in User via OAuth2/OIDC or a Consent) and the Certification Body. This intersecting entity allows a many to many relationship between Users and Certification Bodies. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>user_id: (Authenticated) User</li>\n<li>authority_id: the authority (uu)id</li>\n<li>relationship_to_authority: relationship describes the user's relationship to the authority: the user is the subject, the authority is the  object</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"user_authority_relationship\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createuser_authority_relationship_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string"},"authority_id":{"type":"string"},"relationship_to_authority":{"type":"string"}}},"example":{"user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","authority_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_authority":"Managing Director, Employee, Accountant"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"user_authority_relationship":{"type":"object","properties":{"user_authority_relationship_id":{"type":"string"},"user_id":{"type":"string"},"authority_id":{"type":"string"},"relationship_to_authority":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"user_authority_relationship":{"user_authority_relationship_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","authority_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_authority":"Managing Director, Employee, Accountant"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/retirement-event":{"get":{"tags":["_Retirement_event(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public retirement_event List","description":"<p>Get Public retirement_event List.</p>\n<p>Parsed entity retirement_event. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>retirement_event_id: Internal identifier for the retirement event</li>\n<li>carbon_credit_batch_id: Batch the retired credits are drawn from</li>\n<li>unit_type: Unit category being retired, must match the batch</li>\n<li>amount: Quantity of CO2e tonnes to retire</li>\n<li>owner_address: Wallet/TBA the credits are retired from</li>\n<li>beneficiary_name: The \"entity that uses the certified units\" (Annex III(h))</li>\n<li>end_use: Declared end-use of the unit (Recital 42)</li>\n<li>retirement_reason: Free-text claim statement</li>\n<li>status_code: in_progress, failed</li>\n<li>status_message: further explanation of status code</li>\n<li>retirement_date: Date retirement was requested</li>\n<li>certificate_of_compliance_id: Traces the unit back to its certificate</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_event\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>carbon_credit_batch_id</code>, <code>certificate_of_compliance_id</code>, <code>retirement_event_id</code>, <code>status_code</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPublicretirement_eventList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_event_list":{"type":"array","items":{"type":"object","properties":{"retirement_event":{"type":"object","properties":{"end_use":{"type":"string"},"unit_type":{"type":"string"},"retirement_date":{"type":"string"},"owner_address":{"type":"string"},"status_message":{"type":"string"},"carbon_credit_batch_id":{"type":"string"},"beneficiary_name":{"type":"string"},"status_code":{"type":"string"},"retirement_reason":{"type":"string"},"retirement_event_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"amount":{"type":"number"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"retirement_event_list":[{"retirement_event":{"retirement_event_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_event_id":"ret_01JS0347FKH","carbon_credit_batch_id":"batch_03OGNWO397234DQ","unit_type":"string","amount":1.0,"owner_address":"string","beneficiary_name":"string","end_use":"string","retirement_reason":"string","status_code":"string","status_message":"string","retirement_date":"2020-01-01","certificate_of_compliance_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/public/certification-scheme/{certificationschemeid}":{"get":{"tags":["_Certification_scheme(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public certification_scheme by id","description":"<p>Get Public certification_scheme by id.</p>\n<p>\u2018certification scheme\u2019 means an organisation that certifies the compliance of activities and operators with the quality criteria and certification rules set out in this Regulation;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certification_scheme_id: Unique identifier for certification scheme entity.</li>\n<li>legal_name: Public name of the certification scheme.</li>\n<li>logo: URL or asset reference to a logo image for UI/PDF rendering.</li>\n<li>commission_decision_reference: \"the Commission decision recognising that scheme\"</li>\n<li>certification_methodology: Methodology(ies) the scheme applies (identifier + version).</li>\n<li>scheme_version_number: Scheme rulebook version used for this certification</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_scheme\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePubliccertification_scheme_ogcr","parameters":[{"name":"certificationschemeid","in":"path","description":"The CERTIFICATIONSCHEMEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_scheme":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"email":{"type":"string"},"logo":{"type":"string"},"scheme_version_number":{"type":"string"},"legal_name":{"type":"string"},"commission_decision_reference":{"type":"string"},"certification_methodology":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"certification_scheme":{"certification_scheme_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certification_scheme_id":"cs_01HZZ1K0X5F6Q7R8S9T0","legal_name":"CRCF Scheme","logo":"https://cdn.example.org/logos/dnv.png","email":"string","commission_decision_reference":"Commission Decision C(2026)1234","certification_methodology":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","scheme_version_number":"v1.3"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/certification-on-chain":{"get":{"tags":["_Certification_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get certification_on_chain List","description":"<p>Get certification_on_chain List.</p>\n<p>Cache of CertificationNFT data minted on the OGCR chain (chain id 20253). One record per certificate_of_compliance_id (a re-certification is a new certificate and a new record), populated by OGCR-chain-cache reading the chain.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_hash: activity_hash stored on-chain: keccak256 of the raw activity entity body.</li>\n<li>activity_id: activity_id of the certified activity as stored on-chain.</li>\n<li>activity_name: Activity name as stored on-chain.</li>\n<li>activity_nft_id: ActivityNFT token id this certification references (stored on-chain).</li>\n<li>activity_uri: activity_uri stored on-chain: link back to the OBP activity entity.</li>\n<li>audit_report_hash: audit_report_hash stored on-chain: keccak256 of the raw audit_report entity body.</li>\n<li>audit_report_uri: audit_report_uri stored on-chain: link back to the OBP audit_report entity.</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: carbon_farming_net_soil_emission_reduction_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>carbon_farming_temporary_net_carbon_removal_benefit: carbon_farming_temporary_net_carbon_removal_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>carbon_removals_under_baseline: carbon_removals_under_baseline as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: carbon_storage_temporary_net_carbon_removal_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>certificate_of_compliance_hash: certificate_of_compliance_hash stored on-chain: keccak256 of the raw certificate_of_compliance entity body.</li>\n<li>certificate_of_compliance_id: Links to the <code>certificate_of_compliance</code> dynamic entity. The on-chain CertificationNFT is keyed by this id.</li>\n<li>certificate_of_compliance_uri: certificate_of_compliance_uri stored on-chain: link back to the OBP certificate_of_compliance entity.</li>\n<li>certification_body_hash: certification_body_hash stored on-chain: keccak256 of the raw certification_body entity body.</li>\n<li>certification_body_name: Certification body name as stored on-chain.</li>\n<li>certification_body_uri: certification_body_uri stored on-chain: link back to the OBP certification_body entity.</li>\n<li>certification_scheme_hash: certification_scheme_hash stored on-chain: keccak256 of the raw certification_scheme entity body.</li>\n<li>certification_scheme_name: Certification scheme name as stored on-chain.</li>\n<li>certification_scheme_uri: certification_scheme_uri stored on-chain: link back to the OBP certification_scheme entity.</li>\n<li>certification_status: Certification status as stored on-chain.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: CertificationNFT contract address the token was read from.</li>\n<li>country_id: Country id as stored on-chain.</li>\n<li>expiry_date: Certification expiry date as stored on-chain.</li>\n<li>issue_date: Certification issue date as stored on-chain.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>permanent_net_carbon_removal_benefit: permanent_net_carbon_removal_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>soil_emissions_under_baseline: soil_emissions_under_baseline as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>token_id: CertificationNFT token id minted for this certificate.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>tx_hash: Mint transaction hash (from the CertificationMinted event).</li>\n<li>unit_types: Unit types of the certificate as stored on-chain.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p><em>(no fields on this entity are declared <code>indexed</code>, so only the legacy bare-parameter filter below is available.)</em></p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getcertification_on_chainList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_on_chain_list":{"type":"array","items":{"type":"object","properties":{"certification_on_chain":{"type":"object","properties":{"certification_on_chain_id":{"type":"string"},"activity_uri":{"type":"string"},"carbon_removals_under_baseline":{"type":"string"},"audit_report_hash":{"type":"string"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"string"},"certification_scheme_uri":{"type":"string"},"block_number":{"type":"integer"},"certification_body_name":{"type":"string"},"certification_body_uri":{"type":"string"},"token_uri":{"type":"string"},"certificate_of_compliance_hash":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"string"},"activity_nft_id":{"type":"integer"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"certificate_of_compliance_uri":{"type":"string"},"audit_report_uri":{"type":"string"},"certification_scheme_hash":{"type":"string"},"token_id":{"type":"integer"},"activity_name":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"string"},"unit_types":{"type":"string"},"activity_hash":{"type":"string"},"contract_address":{"type":"string"},"certification_status":{"type":"string"},"certification_scheme_name":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"string"},"permanent_net_carbon_removal_benefit":{"type":"string"},"country_id":{"type":"string"},"certification_body_hash":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"certification_on_chain_list":[{"certification_on_chain":{"certification_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_name":"Reforestation 2024","activity_nft_id":1,"activity_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/activity/activity_AB12CD34EF","audit_report_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","audit_report_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/audit_report/audit_report_01","block_number":12345,"carbon_farming_net_soil_emission_reduction_benefit":"10.5","carbon_farming_temporary_net_carbon_removal_benefit":"10.5","carbon_removals_under_baseline":"10.5","carbon_storage_temporary_net_carbon_removal_benefit":"10.5","certificate_of_compliance_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certificate_of_compliance_id":"coc_AB12CD34EF","certificate_of_compliance_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certificate_of_compliance/coc_AB12CD34EF","certification_body_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_body_name":"Example Certification Body","certification_body_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certification_body/body_VERRA","certification_scheme_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_scheme_name":"Example Certification Scheme","certification_scheme_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certification_scheme/scheme_SALUS","certification_status":"certified","chain_id":20253,"contract_address":"0x2e335F247E91caa168c64b63104C4475b2af3942","country_id":"DK","expiry_date":"2029-06-01","issue_date":"2024-06-01","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","permanent_net_carbon_removal_benefit":"10.5","soil_emissions_under_baseline":"10.5","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQ2VydCJ9","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_types":"Permanent Removal"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Certification_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new certification_on_chain","description":"<p>Create new certification_on_chain.</p>\n<p>Cache of CertificationNFT data minted on the OGCR chain (chain id 20253). One record per certificate_of_compliance_id (a re-certification is a new certificate and a new record), populated by OGCR-chain-cache reading the chain.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_hash: activity_hash stored on-chain: keccak256 of the raw activity entity body.</li>\n<li>activity_id: activity_id of the certified activity as stored on-chain.</li>\n<li>activity_name: Activity name as stored on-chain.</li>\n<li>activity_nft_id: ActivityNFT token id this certification references (stored on-chain).</li>\n<li>activity_uri: activity_uri stored on-chain: link back to the OBP activity entity.</li>\n<li>audit_report_hash: audit_report_hash stored on-chain: keccak256 of the raw audit_report entity body.</li>\n<li>audit_report_uri: audit_report_uri stored on-chain: link back to the OBP audit_report entity.</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: carbon_farming_net_soil_emission_reduction_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>carbon_farming_temporary_net_carbon_removal_benefit: carbon_farming_temporary_net_carbon_removal_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>carbon_removals_under_baseline: carbon_removals_under_baseline as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: carbon_storage_temporary_net_carbon_removal_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>certificate_of_compliance_hash: certificate_of_compliance_hash stored on-chain: keccak256 of the raw certificate_of_compliance entity body.</li>\n<li>certificate_of_compliance_id: Links to the <code>certificate_of_compliance</code> dynamic entity. The on-chain CertificationNFT is keyed by this id.</li>\n<li>certificate_of_compliance_uri: certificate_of_compliance_uri stored on-chain: link back to the OBP certificate_of_compliance entity.</li>\n<li>certification_body_hash: certification_body_hash stored on-chain: keccak256 of the raw certification_body entity body.</li>\n<li>certification_body_name: Certification body name as stored on-chain.</li>\n<li>certification_body_uri: certification_body_uri stored on-chain: link back to the OBP certification_body entity.</li>\n<li>certification_scheme_hash: certification_scheme_hash stored on-chain: keccak256 of the raw certification_scheme entity body.</li>\n<li>certification_scheme_name: Certification scheme name as stored on-chain.</li>\n<li>certification_scheme_uri: certification_scheme_uri stored on-chain: link back to the OBP certification_scheme entity.</li>\n<li>certification_status: Certification status as stored on-chain.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: CertificationNFT contract address the token was read from.</li>\n<li>country_id: Country id as stored on-chain.</li>\n<li>expiry_date: Certification expiry date as stored on-chain.</li>\n<li>issue_date: Certification issue date as stored on-chain.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>permanent_net_carbon_removal_benefit: permanent_net_carbon_removal_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>soil_emissions_under_baseline: soil_emissions_under_baseline as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>token_id: CertificationNFT token id minted for this certificate.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>tx_hash: Mint transaction hash (from the CertificationMinted event).</li>\n<li>unit_types: Unit types of the certificate as stored on-chain.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createcertification_on_chain_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"activity_uri":{"type":"string"},"carbon_removals_under_baseline":{"type":"string"},"audit_report_hash":{"type":"string"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"string"},"certification_scheme_uri":{"type":"string"},"block_number":{"type":"integer"},"certification_body_name":{"type":"string"},"certification_body_uri":{"type":"string"},"token_uri":{"type":"string"},"certificate_of_compliance_hash":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"string"},"activity_nft_id":{"type":"integer"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"certificate_of_compliance_uri":{"type":"string"},"audit_report_uri":{"type":"string"},"certification_scheme_hash":{"type":"string"},"token_id":{"type":"integer"},"activity_name":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"string"},"unit_types":{"type":"string"},"activity_hash":{"type":"string"},"contract_address":{"type":"string"},"certification_status":{"type":"string"},"certification_scheme_name":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"string"},"permanent_net_carbon_removal_benefit":{"type":"string"},"country_id":{"type":"string"},"certification_body_hash":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"}}},"example":{"activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_name":"Reforestation 2024","activity_nft_id":1,"activity_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/activity/activity_AB12CD34EF","audit_report_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","audit_report_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/audit_report/audit_report_01","block_number":12345,"carbon_farming_net_soil_emission_reduction_benefit":"10.5","carbon_farming_temporary_net_carbon_removal_benefit":"10.5","carbon_removals_under_baseline":"10.5","carbon_storage_temporary_net_carbon_removal_benefit":"10.5","certificate_of_compliance_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certificate_of_compliance_id":"coc_AB12CD34EF","certificate_of_compliance_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certificate_of_compliance/coc_AB12CD34EF","certification_body_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_body_name":"Example Certification Body","certification_body_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certification_body/body_VERRA","certification_scheme_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_scheme_name":"Example Certification Scheme","certification_scheme_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certification_scheme/scheme_SALUS","certification_status":"certified","chain_id":20253,"contract_address":"0x2e335F247E91caa168c64b63104C4475b2af3942","country_id":"DK","expiry_date":"2029-06-01","issue_date":"2024-06-01","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","permanent_net_carbon_removal_benefit":"10.5","soil_emissions_under_baseline":"10.5","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQ2VydCJ9","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_types":"Permanent Removal"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_on_chain":{"type":"object","properties":{"certification_on_chain_id":{"type":"string"},"activity_uri":{"type":"string"},"carbon_removals_under_baseline":{"type":"string"},"audit_report_hash":{"type":"string"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"string"},"certification_scheme_uri":{"type":"string"},"block_number":{"type":"integer"},"certification_body_name":{"type":"string"},"certification_body_uri":{"type":"string"},"token_uri":{"type":"string"},"certificate_of_compliance_hash":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"string"},"activity_nft_id":{"type":"integer"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"certificate_of_compliance_uri":{"type":"string"},"audit_report_uri":{"type":"string"},"certification_scheme_hash":{"type":"string"},"token_id":{"type":"integer"},"activity_name":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"string"},"unit_types":{"type":"string"},"activity_hash":{"type":"string"},"contract_address":{"type":"string"},"certification_status":{"type":"string"},"certification_scheme_name":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"string"},"permanent_net_carbon_removal_benefit":{"type":"string"},"country_id":{"type":"string"},"certification_body_hash":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certification_on_chain":{"certification_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_name":"Reforestation 2024","activity_nft_id":1,"activity_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/activity/activity_AB12CD34EF","audit_report_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","audit_report_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/audit_report/audit_report_01","block_number":12345,"carbon_farming_net_soil_emission_reduction_benefit":"10.5","carbon_farming_temporary_net_carbon_removal_benefit":"10.5","carbon_removals_under_baseline":"10.5","carbon_storage_temporary_net_carbon_removal_benefit":"10.5","certificate_of_compliance_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certificate_of_compliance_id":"coc_AB12CD34EF","certificate_of_compliance_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certificate_of_compliance/coc_AB12CD34EF","certification_body_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_body_name":"Example Certification Body","certification_body_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certification_body/body_VERRA","certification_scheme_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_scheme_name":"Example Certification Scheme","certification_scheme_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certification_scheme/scheme_SALUS","certification_status":"certified","chain_id":20253,"contract_address":"0x2e335F247E91caa168c64b63104C4475b2af3942","country_id":"DK","expiry_date":"2029-06-01","issue_date":"2024-06-01","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","permanent_net_carbon_removal_benefit":"10.5","soil_emissions_under_baseline":"10.5","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQ2VydCJ9","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_types":"Permanent Removal"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/carbon-credit-balance-on-chain":{"get":{"tags":["_Carbon_credit_balance_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public carbon_credit_balance_on_chain List","description":"<p>Get Public carbon_credit_balance_on_chain List.</p>\n<p>Cache of CarbonCredit (ERC-20) balances on the OGCR chain (chain id 20253). One record per holding address, covering both operator wallets and the ERC-6551 token-bound accounts of credit batches. Populated by OGCR-chain-cache, which derives the holder set from Transfer events and then reads each balance at the current head. Balances are current-state, not historical: each record is only true as of block_number.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>balance: CarbonCredit balance in smallest units, as read at block_number. Decimal string because a uint256 does not fit an integer field. Divide by 10^decimals for tonnes CO2e.</li>\n<li>batch_token_id: When holder_type is token_bound_account, the CarbonCreditBatchNFT token id this account belongs to. 0 otherwise. Join to <code>carbon_credit_batch_on_chain</code>.token_id.</li>\n<li>block_number: Block height the balance was read at.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: CarbonCredit ERC-20 contract address the balance was read from.</li>\n<li>decimals: Decimals of the CarbonCredit ERC-20, for rendering balance.</li>\n<li>holder_type: Whether this address is a plain wallet or the ERC-6551 token-bound account of a credit batch. One of: wallet, token_bound_account. A token_bound_account balance is credits still held inside their batch; a wallet balance is credits withdrawn from a batch and now pooled.</li>\n<li>owner_address: Address holding the balance, lowercase-insensitive checksum form. The business key for this record. Match against operator.ogcr_wallet_address or land_manager.ogcr_wallet_address to find a party's holdings.</li>\n<li>symbol: Symbol of the CarbonCredit ERC-20.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"carbon_credit_balance_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p><em>(no fields on this entity are declared <code>indexed</code>, so only the legacy bare-parameter filter below is available.)</em></p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPubliccarbon_credit_balance_on_chainList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"carbon_credit_balance_on_chain_list":{"type":"array","items":{"type":"object","properties":{"carbon_credit_balance_on_chain":{"type":"object","properties":{"balance":{"type":"string"},"owner_address":{"type":"string"},"symbol":{"type":"string"},"carbon_credit_balance_on_chain_id":{"type":"string"},"holder_type":{"type":"string"},"batch_token_id":{"type":"integer"},"block_number":{"type":"integer"},"chain_id":{"type":"integer"},"contract_address":{"type":"string"},"decimals":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"carbon_credit_balance_on_chain_list":[{"carbon_credit_balance_on_chain":{"carbon_credit_balance_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","balance":"1000000000000000000","batch_token_id":1,"block_number":12400,"chain_id":20253,"contract_address":"0x1B4bC0dE8b6A1A2b3C4d5E6f7A8b9C0d1E2f3A4b","decimals":18,"holder_type":"token_bound_account","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","symbol":"CC"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/user-authority-relationship/{userauthorityrelationshipid}":{"get":{"tags":["_User_authority_relationship(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get user_authority_relationship by id","description":"<p>Get user_authority_relationship by id.</p>\n<p>Describes the relationship between a User (the logged in User via OAuth2/OIDC or a Consent) and the Certification Body. This intersecting entity allows a many to many relationship between Users and Certification Bodies. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>user_id: (Authenticated) User</li>\n<li>authority_id: the authority (uu)id</li>\n<li>relationship_to_authority: relationship describes the user's relationship to the authority: the user is the subject, the authority is the  object</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"user_authority_relationship\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleuser_authority_relationship_ogcr","parameters":[{"name":"userauthorityrelationshipid","in":"path","description":"The USERAUTHORITYRELATIONSHIPID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"user_authority_relationship":{"type":"object","properties":{"user_authority_relationship_id":{"type":"string"},"user_id":{"type":"string"},"authority_id":{"type":"string"},"relationship_to_authority":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"user_authority_relationship":{"user_authority_relationship_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","authority_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_authority":"Managing Director, Employee, Accountant"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_User_authority_relationship(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update user_authority_relationship","description":"<p>Update user_authority_relationship.</p>\n<p>Describes the relationship between a User (the logged in User via OAuth2/OIDC or a Consent) and the Certification Body. This intersecting entity allows a many to many relationship between Users and Certification Bodies. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>user_id: (Authenticated) User</li>\n<li>authority_id: the authority (uu)id</li>\n<li>relationship_to_authority: relationship describes the user's relationship to the authority: the user is the subject, the authority is the  object</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"user_authority_relationship\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateuser_authority_relationship_ogcr","parameters":[{"name":"userauthorityrelationshipid","in":"path","description":"The USERAUTHORITYRELATIONSHIPID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string"},"authority_id":{"type":"string"},"relationship_to_authority":{"type":"string"}}},"example":{"user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","authority_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_authority":"Managing Director, Employee, Accountant"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"user_authority_relationship":{"type":"object","properties":{"user_authority_relationship_id":{"type":"string"},"user_id":{"type":"string"},"authority_id":{"type":"string"},"relationship_to_authority":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"user_authority_relationship":{"user_authority_relationship_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","authority_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_authority":"Managing Director, Employee, Accountant"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_User_authority_relationship(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete user_authority_relationship by id","description":"<p>Delete user_authority_relationship by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"user_authority_relationship\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteuser_authority_relationship_ogcr","parameters":[{"name":"userauthorityrelationshipid","in":"path","description":"The USERAUTHORITYRELATIONSHIPID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"user_authority_relationship":{"type":"object","properties":{"user_authority_relationship_id":{"type":"string"},"user_id":{"type":"string"},"authority_id":{"type":"string"},"relationship_to_authority":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"user_authority_relationship":{"user_authority_relationship_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","authority_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_authority":"Managing Director, Employee, Accountant"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_User_authority_relationship(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update user_authority_relationship","description":"<p>Partially update user_authority_relationship: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Describes the relationship between a User (the logged in User via OAuth2/OIDC or a Consent) and the Certification Body. This intersecting entity allows a many to many relationship between Users and Certification Bodies. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>user_id: (Authenticated) User</li>\n<li>authority_id: the authority (uu)id</li>\n<li>relationship_to_authority: relationship describes the user's relationship to the authority: the user is the subject, the authority is the  object</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"user_authority_relationship\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchuser_authority_relationship_ogcr","parameters":[{"name":"userauthorityrelationshipid","in":"path","description":"The USERAUTHORITYRELATIONSHIPID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string"},"authority_id":{"type":"string"},"relationship_to_authority":{"type":"string"}}},"example":{"user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","authority_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_authority":"Managing Director, Employee, Accountant"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"user_authority_relationship":{"type":"object","properties":{"user_authority_relationship_id":{"type":"string"},"user_id":{"type":"string"},"authority_id":{"type":"string"},"relationship_to_authority":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"user_authority_relationship":{"user_authority_relationship_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","authority_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_authority":"Managing Director, Employee, Accountant"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/test-1/TEST_1_ID":{"get":{"tags":["_Test_1(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get test_1 by id","description":"<p>Get test_1 by id.</p>\n<p>Parsed entity test_1. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"test_1\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingletest_1_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"test_1":{"type":"object","properties":{"test_1_id":{"type":"string"},"field_1":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"test_1":{"test_1_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","field_1":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Test_1(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update test_1","description":"<p>Update test_1.</p>\n<p>Parsed entity test_1. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"test_1\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updatetest_1_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"field_1":{"type":"string"}}},"example":{"field_1":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"test_1":{"type":"object","properties":{"test_1_id":{"type":"string"},"field_1":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"test_1":{"test_1_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","field_1":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Test_1(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete test_1 by id","description":"<p>Delete test_1 by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"test_1\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletetest_1_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"test_1":{"type":"object","properties":{"test_1_id":{"type":"string"},"field_1":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"test_1":{"test_1_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","field_1":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Test_1(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update test_1","description":"<p>Partially update test_1: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Parsed entity test_1. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"test_1\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchtest_1_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"field_1":{"type":"string"}}},"example":{"field_1":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"test_1":{"type":"object","properties":{"test_1_id":{"type":"string"},"field_1":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"test_1":{"test_1_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","field_1":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/certification-body":{"get":{"tags":["_Certification_body(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get certification_body List","description":"<p>Get certification_body List.</p>\n<p>\u2018certification body\u2019 means an accredited or recognised independent conformity assessment body that has concluded an agreement with a certification scheme to carry out certification audits and issue certificates of compliance;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certification_body_id: Unique identifier for the certification body</li>\n<li>legal_name: Legal or trading name of the certification body</li>\n<li>address_line_1: Certification body primary street address (street name, building number, P.O. Box if applicable)</li>\n<li>address_line_2: Certification body secondary, optional details like apartment, suite, unit, floor, or building name</li>\n<li>address_city: City</li>\n<li>address_postcode: Certification body postcode</li>\n<li>country_id: ISO 3166-1 alpha-2 country code for certification body address.</li>\n<li>logo: URL or asset reference to a logo image for UI/PDF rendering.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_body\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>certification_body_id</code>, <code>country_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>country_id</code> → <code>country</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getcertification_bodyList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_body_list":{"type":"array","items":{"type":"object","properties":{"certification_body":{"type":"object","properties":{"address_city":{"type":"string"},"website":{"type":"string"},"email":{"type":"string"},"accreditation_route":{"type":"string"},"logo":{"type":"string"},"status":{"type":"string"},"address_line_2":{"type":"string"},"address_postcode":{"type":"string"},"country_id":{"type":"string"},"address_line_1":{"type":"string"},"certification_body_id":{"type":"string"},"legal_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"certification_body_list":[{"certification_body":{"certification_body_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certification_body_id":"cb_01HZZ1M2A3B4C5D6E7F8","legal_name":"DNV Business Assurance Germany GmbH","accreditation_route":"string","address_line_1":"Brooktorkai 18","address_line_2":"5th Floor","address_city":"Hamburg","address_postcode":"20457","country_id":"DE","status":"string","email":"string","website":"string","logo":"https://cdn.example.org/logos/dnv.png"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Certification_body(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new certification_body","description":"<p>Create new certification_body.</p>\n<p>\u2018certification body\u2019 means an accredited or recognised independent conformity assessment body that has concluded an agreement with a certification scheme to carry out certification audits and issue certificates of compliance;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certification_body_id: Unique identifier for the certification body</li>\n<li>legal_name: Legal or trading name of the certification body</li>\n<li>address_line_1: Certification body primary street address (street name, building number, P.O. Box if applicable)</li>\n<li>address_line_2: Certification body secondary, optional details like apartment, suite, unit, floor, or building name</li>\n<li>address_city: City</li>\n<li>address_postcode: Certification body postcode</li>\n<li>country_id: ISO 3166-1 alpha-2 country code for certification body address.</li>\n<li>logo: URL or asset reference to a logo image for UI/PDF rendering.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_body\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createcertification_body_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"address_city":{"type":"string"},"website":{"type":"string"},"email":{"type":"string"},"accreditation_route":{"type":"string"},"logo":{"type":"string"},"status":{"type":"string"},"address_line_2":{"type":"string"},"address_postcode":{"type":"string"},"country_id":{"type":"string"},"address_line_1":{"type":"string"},"certification_body_id":{"type":"string"},"legal_name":{"type":"string"}}},"example":{"certification_body_id":"cb_01HZZ1M2A3B4C5D6E7F8","legal_name":"DNV Business Assurance Germany GmbH","accreditation_route":"string","address_line_1":"Brooktorkai 18","address_line_2":"5th Floor","address_city":"Hamburg","address_postcode":"20457","country_id":"DE","status":"string","email":"string","website":"string","logo":"https://cdn.example.org/logos/dnv.png"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_body":{"type":"object","properties":{"address_city":{"type":"string"},"website":{"type":"string"},"email":{"type":"string"},"accreditation_route":{"type":"string"},"logo":{"type":"string"},"status":{"type":"string"},"address_line_2":{"type":"string"},"address_postcode":{"type":"string"},"country_id":{"type":"string"},"address_line_1":{"type":"string"},"certification_body_id":{"type":"string"},"legal_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certification_body":{"certification_body_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certification_body_id":"cb_01HZZ1M2A3B4C5D6E7F8","legal_name":"DNV Business Assurance Germany GmbH","accreditation_route":"string","address_line_1":"Brooktorkai 18","address_line_2":"5th Floor","address_city":"Hamburg","address_postcode":"20457","country_id":"DE","status":"string","email":"string","website":"string","logo":"https://cdn.example.org/logos/dnv.png"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/parcel-owner-verification":{"get":{"tags":["_Parcel_owner_verification(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get parcel_owner_verification List","description":"<p>Get parcel_owner_verification List.</p>\n<p>Parcel owner verification' records the outcome of verifying legal ownership of a parcel against an authoritative source (e.g. national cadastre). Parcel status for NFT-minting purposes lives on this record (status_code), not on the parcel entity itself \u2014 minting is gated on a verified POV record. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>parcel_id: (uu)id of the parcel that gets verified</li>\n<li>status_code: in_progress, verified, failed</li>\n<li>status_message: further explanation of status code</li>\n<li>parcel_owner_legal_name: Legal owner of the parcel</li>\n<li>authority: name of authority that verified the ownership</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_owner_verification\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>parcel_id</code>, <code>parcel_owner_verification_id</code>, <code>status_code</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>parcel_id</code> → <code>parcel</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getparcel_owner_verificationList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_owner_verification_list":{"type":"array","items":{"type":"object","properties":{"parcel_owner_verification":{"type":"object","properties":{"status_code":{"type":"string"},"parcel_owner_verification_id":{"type":"string"},"parcel_id":{"type":"string"},"authority":{"type":"string"},"parcel_owner_legal_name":{"type":"string"},"status_message":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"parcel_owner_verification_list":[{"parcel_owner_verification":{"parcel_owner_verification_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_owner_verification_id":"string","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","status_code":"verified","status_message":"could not find owner","parcel_owner_legal_name":"string","authority":"Mycountry cadastre"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Parcel_owner_verification(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new parcel_owner_verification","description":"<p>Create new parcel_owner_verification.</p>\n<p>Parcel owner verification' records the outcome of verifying legal ownership of a parcel against an authoritative source (e.g. national cadastre). Parcel status for NFT-minting purposes lives on this record (status_code), not on the parcel entity itself \u2014 minting is gated on a verified POV record. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>parcel_id: (uu)id of the parcel that gets verified</li>\n<li>status_code: in_progress, verified, failed</li>\n<li>status_message: further explanation of status code</li>\n<li>parcel_owner_legal_name: Legal owner of the parcel</li>\n<li>authority: name of authority that verified the ownership</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_owner_verification\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createparcel_owner_verification_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"status_code":{"type":"string"},"parcel_owner_verification_id":{"type":"string"},"parcel_id":{"type":"string"},"authority":{"type":"string"},"parcel_owner_legal_name":{"type":"string"},"status_message":{"type":"string"}}},"example":{"parcel_owner_verification_id":"string","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","status_code":"verified","status_message":"could not find owner","parcel_owner_legal_name":"string","authority":"Mycountry cadastre"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_owner_verification":{"type":"object","properties":{"status_code":{"type":"string"},"parcel_owner_verification_id":{"type":"string"},"parcel_id":{"type":"string"},"authority":{"type":"string"},"parcel_owner_legal_name":{"type":"string"},"status_message":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_owner_verification":{"parcel_owner_verification_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_owner_verification_id":"string","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","status_code":"verified","status_message":"could not find owner","parcel_owner_legal_name":"string","authority":"Mycountry cadastre"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/activity-verification-supporting-document/{activityverificationsupportingdocumentid}":{"get":{"tags":["_Activity_verification_supporting_document(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get activity_verification_supporting_document by id","description":"<p>Get activity_verification_supporting_document by id.</p>\n<p>Parsed entity activity_verification_supporting_document. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_verification_supporting_document\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleactivity_verification_supporting_document_ogcr","parameters":[{"name":"activityverificationsupportingdocumentid","in":"path","description":"The ACTIVITYVERIFICATIONSUPPORTINGDOCUMENTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_verification_supporting_document":{"type":"object","properties":{"activity_verification_supporting_document_id":{"type":"string"},"supporting_document_id":{"type":"string"},"activity_id":{"type":"string"},"activity_verification_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_verification_supporting_document":{"activity_verification_supporting_document_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supporting_document_id":"string","activity_id":"string","activity_verification_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Activity_verification_supporting_document(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update activity_verification_supporting_document","description":"<p>Update activity_verification_supporting_document.</p>\n<p>Parsed entity activity_verification_supporting_document. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_verification_supporting_document\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateactivity_verification_supporting_document_ogcr","parameters":[{"name":"activityverificationsupportingdocumentid","in":"path","description":"The ACTIVITYVERIFICATIONSUPPORTINGDOCUMENTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"activity_id":{"type":"string"},"activity_verification_id":{"type":"string"}}},"example":{"supporting_document_id":"string","activity_id":"string","activity_verification_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_verification_supporting_document":{"type":"object","properties":{"activity_verification_supporting_document_id":{"type":"string"},"supporting_document_id":{"type":"string"},"activity_id":{"type":"string"},"activity_verification_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_verification_supporting_document":{"activity_verification_supporting_document_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supporting_document_id":"string","activity_id":"string","activity_verification_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Activity_verification_supporting_document(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete activity_verification_supporting_document by id","description":"<p>Delete activity_verification_supporting_document by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_verification_supporting_document\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteactivity_verification_supporting_document_ogcr","parameters":[{"name":"activityverificationsupportingdocumentid","in":"path","description":"The ACTIVITYVERIFICATIONSUPPORTINGDOCUMENTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_verification_supporting_document":{"type":"object","properties":{"activity_verification_supporting_document_id":{"type":"string"},"supporting_document_id":{"type":"string"},"activity_id":{"type":"string"},"activity_verification_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_verification_supporting_document":{"activity_verification_supporting_document_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supporting_document_id":"string","activity_id":"string","activity_verification_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Activity_verification_supporting_document(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update activity_verification_supporting_document","description":"<p>Partially update activity_verification_supporting_document: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Parsed entity activity_verification_supporting_document. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_verification_supporting_document\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchactivity_verification_supporting_document_ogcr","parameters":[{"name":"activityverificationsupportingdocumentid","in":"path","description":"The ACTIVITYVERIFICATIONSUPPORTINGDOCUMENTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"activity_id":{"type":"string"},"activity_verification_id":{"type":"string"}}},"example":{"supporting_document_id":"string","activity_id":"string","activity_verification_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_verification_supporting_document":{"type":"object","properties":{"activity_verification_supporting_document_id":{"type":"string"},"supporting_document_id":{"type":"string"},"activity_id":{"type":"string"},"activity_verification_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_verification_supporting_document":{"activity_verification_supporting_document_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supporting_document_id":"string","activity_id":"string","activity_verification_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/sustainable-development-goal":{"get":{"tags":["_Sustainable_development_goal(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public sustainable_development_goal List","description":"<p>Get Public sustainable_development_goal List.</p>\n<p>This is the lookup table for sustainable development goals. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"sustainable_development_goal\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>sustainable_development_goal_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPublicsustainable_development_goalList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"sustainable_development_goal_list":{"type":"array","items":{"type":"object","properties":{"sustainable_development_goal":{"type":"object","properties":{"sustainable_development_goal_id":{"type":"string"},"sustainable_development_goal_name":{"type":"string"},"sustainable_development_goal_link":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"sustainable_development_goal_list":[{"sustainable_development_goal":{"sustainable_development_goal_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","sustainable_development_goal_id":"string","sustainable_development_goal_name":"string","sustainable_development_goal_link":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/liability-choice":{"get":{"tags":["_Liability_choice(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get liability_choice List","description":"<p>Get liability_choice List.</p>\n<p>Records which liability mechanism applies to an activity for addressing reversals during its monitoring period. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>liability_choice_id: Internal identifier for the liability choice</li>\n<li>liability_mechanism_type: buffer_pool, insurance or individual_liability</li>\n<li>operator_id: Natural or legal person liable to address reversals (Annex II(s))</li>\n<li>insurance_policy_reference: Policy number. Only if insurance is chosen.</li>\n<li>effective_date: Date from which the mechanism applies</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"liability_choice\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>liability_choice_id</code>, <code>operator_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>activity_id</code> → <code>activity</code>, <code>operator_id</code> → <code>operator</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getliability_choiceList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"liability_choice_list":{"type":"array","items":{"type":"object","properties":{"liability_choice":{"type":"object","properties":{"liability_choice_id":{"type":"string"},"liability_mechanism_type":{"type":"string"},"effective_date":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"insurance_policy_reference":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"liability_choice_list":[{"liability_choice":{"liability_choice_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","liability_choice_id":"string","activity_id":"string","liability_mechanism_type":"string","operator_id":"string","insurance_policy_reference":"string","effective_date":"2020-01-01"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Liability_choice(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new liability_choice","description":"<p>Create new liability_choice.</p>\n<p>Records which liability mechanism applies to an activity for addressing reversals during its monitoring period. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>liability_choice_id: Internal identifier for the liability choice</li>\n<li>liability_mechanism_type: buffer_pool, insurance or individual_liability</li>\n<li>operator_id: Natural or legal person liable to address reversals (Annex II(s))</li>\n<li>insurance_policy_reference: Policy number. Only if insurance is chosen.</li>\n<li>effective_date: Date from which the mechanism applies</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"liability_choice\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createliability_choice_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"liability_choice_id":{"type":"string"},"liability_mechanism_type":{"type":"string"},"effective_date":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"insurance_policy_reference":{"type":"string"}}},"example":{"liability_choice_id":"string","activity_id":"string","liability_mechanism_type":"string","operator_id":"string","insurance_policy_reference":"string","effective_date":"2020-01-01"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"liability_choice":{"type":"object","properties":{"liability_choice_id":{"type":"string"},"liability_mechanism_type":{"type":"string"},"effective_date":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"insurance_policy_reference":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"liability_choice":{"liability_choice_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","liability_choice_id":"string","activity_id":"string","liability_mechanism_type":"string","operator_id":"string","insurance_policy_reference":"string","effective_date":"2020-01-01"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/registry/activity-certificates-query":{"get":{"tags":["OGCR-Registry"],"summary":"Get the certificates of compliance of OGCR registry activities","description":"<p>User Authentication is Optional. The User need not be logged in.</p>\n<p><strong>JSON response body fields:</strong></p>\n","operationId":"OBPv4.0.0-getRegistryActivityCertificatesQuery_-1007258276","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certificates":{"type":"array","items":{"type":"object","properties":{}}},"count":{"type":"integer"}}},"example":{"certificates":[{}],"count":1}}}},"500":{"description":"Internal Server Error"}}}},"/co-benefits/{cobenefitsid}":{"get":{"tags":["_Co_benefits(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get co_benefits by id","description":"<p>Get co_benefits by id.</p>\n<p>Parsed entity co_benefits. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"co_benefits\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleco_benefits_ogcr","parameters":[{"name":"cobenefitsid","in":"path","description":"The COBENEFITSID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"co_benefits":{"type":"object","properties":{"co_benefits_id":{"type":"string"},"co_benefit_id":{"type":"string"},"co_benefit_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"co_benefits":{"co_benefits_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","co_benefit_id":"string","co_benefit_name":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Co_benefits(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update co_benefits","description":"<p>Update co_benefits.</p>\n<p>Parsed entity co_benefits. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"co_benefits\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateco_benefits_ogcr","parameters":[{"name":"cobenefitsid","in":"path","description":"The COBENEFITSID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"co_benefit_id":{"type":"string"},"co_benefit_name":{"type":"string"}}},"example":{"co_benefit_id":"string","co_benefit_name":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"co_benefits":{"type":"object","properties":{"co_benefits_id":{"type":"string"},"co_benefit_id":{"type":"string"},"co_benefit_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"co_benefits":{"co_benefits_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","co_benefit_id":"string","co_benefit_name":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Co_benefits(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete co_benefits by id","description":"<p>Delete co_benefits by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"co_benefits\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteco_benefits_ogcr","parameters":[{"name":"cobenefitsid","in":"path","description":"The COBENEFITSID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"co_benefits":{"type":"object","properties":{"co_benefits_id":{"type":"string"},"co_benefit_id":{"type":"string"},"co_benefit_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"co_benefits":{"co_benefits_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","co_benefit_id":"string","co_benefit_name":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Co_benefits(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update co_benefits","description":"<p>Partially update co_benefits: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Parsed entity co_benefits. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"co_benefits\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchco_benefits_ogcr","parameters":[{"name":"cobenefitsid","in":"path","description":"The COBENEFITSID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"co_benefit_id":{"type":"string"},"co_benefit_name":{"type":"string"}}},"example":{"co_benefit_id":"string","co_benefit_name":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"co_benefits":{"type":"object","properties":{"co_benefits_id":{"type":"string"},"co_benefit_id":{"type":"string"},"co_benefit_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"co_benefits":{"co_benefits_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","co_benefit_id":"string","co_benefit_name":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/activity-verification-supporting-document":{"get":{"tags":["_Activity_verification_supporting_document(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get activity_verification_supporting_document List","description":"<p>Get activity_verification_supporting_document List.</p>\n<p>Parsed entity activity_verification_supporting_document. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_verification_supporting_document\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>activity_verification_id</code>, <code>supporting_document_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>activity_id</code> → <code>activity</code>, <code>activity_verification_id</code> → <code>activity_verification</code>, <code>supporting_document_id</code> → <code>supporting_document</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getactivity_verification_supporting_documentList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_verification_supporting_document_list":{"type":"array","items":{"type":"object","properties":{"activity_verification_supporting_document":{"type":"object","properties":{"activity_verification_supporting_document_id":{"type":"string"},"supporting_document_id":{"type":"string"},"activity_id":{"type":"string"},"activity_verification_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"activity_verification_supporting_document_list":[{"activity_verification_supporting_document":{"activity_verification_supporting_document_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supporting_document_id":"string","activity_id":"string","activity_verification_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Activity_verification_supporting_document(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new activity_verification_supporting_document","description":"<p>Create new activity_verification_supporting_document.</p>\n<p>Parsed entity activity_verification_supporting_document. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_verification_supporting_document\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createactivity_verification_supporting_document_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"activity_id":{"type":"string"},"activity_verification_id":{"type":"string"}}},"example":{"supporting_document_id":"string","activity_id":"string","activity_verification_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_verification_supporting_document":{"type":"object","properties":{"activity_verification_supporting_document_id":{"type":"string"},"supporting_document_id":{"type":"string"},"activity_id":{"type":"string"},"activity_verification_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_verification_supporting_document":{"activity_verification_supporting_document_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supporting_document_id":"string","activity_id":"string","activity_verification_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/parcel-owner/{parcelownerid}":{"get":{"tags":["_Parcel_owner(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get parcel_owner by id","description":"<p>Get parcel_owner by id.</p>\n<p>Parsed entity parcel_owner. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>parcel_owner_id: Internal identifier</li>\n<li>parcel_id: Parcel the claim is about</li>\n<li>legal_name: Owner as declared by the operator</li>\n<li>owner_type: natural_person, legal_person or public_entity</li>\n<li>country_id: Country of the owner's address</li>\n<li>supporting_document_id: Deed or cadastre extract upoaded by operator</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_owner\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleparcel_owner_ogcr","parameters":[{"name":"parcelownerid","in":"path","description":"The PARCELOWNERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_owner":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"owner_type":{"type":"string"},"parcel_owner_id":{"type":"string"},"country_id":{"type":"string"},"parcel_id":{"type":"string"},"legal_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_owner":{"parcel_owner_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_owner_id":"string","parcel_id":"string","legal_name":"string","owner_type":"string","country_id":"string","supporting_document_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Parcel_owner(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update parcel_owner","description":"<p>Update parcel_owner.</p>\n<p>Parsed entity parcel_owner. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>parcel_owner_id: Internal identifier</li>\n<li>parcel_id: Parcel the claim is about</li>\n<li>legal_name: Owner as declared by the operator</li>\n<li>owner_type: natural_person, legal_person or public_entity</li>\n<li>country_id: Country of the owner's address</li>\n<li>supporting_document_id: Deed or cadastre extract upoaded by operator</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_owner\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateparcel_owner_ogcr","parameters":[{"name":"parcelownerid","in":"path","description":"The PARCELOWNERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"owner_type":{"type":"string"},"parcel_owner_id":{"type":"string"},"country_id":{"type":"string"},"parcel_id":{"type":"string"},"legal_name":{"type":"string"}}},"example":{"parcel_owner_id":"string","parcel_id":"string","legal_name":"string","owner_type":"string","country_id":"string","supporting_document_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_owner":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"owner_type":{"type":"string"},"parcel_owner_id":{"type":"string"},"country_id":{"type":"string"},"parcel_id":{"type":"string"},"legal_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_owner":{"parcel_owner_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_owner_id":"string","parcel_id":"string","legal_name":"string","owner_type":"string","country_id":"string","supporting_document_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Parcel_owner(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete parcel_owner by id","description":"<p>Delete parcel_owner by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_owner\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteparcel_owner_ogcr","parameters":[{"name":"parcelownerid","in":"path","description":"The PARCELOWNERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_owner":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"owner_type":{"type":"string"},"parcel_owner_id":{"type":"string"},"country_id":{"type":"string"},"parcel_id":{"type":"string"},"legal_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_owner":{"parcel_owner_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_owner_id":"string","parcel_id":"string","legal_name":"string","owner_type":"string","country_id":"string","supporting_document_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Parcel_owner(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update parcel_owner","description":"<p>Partially update parcel_owner: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Parsed entity parcel_owner. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>parcel_owner_id: Internal identifier</li>\n<li>parcel_id: Parcel the claim is about</li>\n<li>legal_name: Owner as declared by the operator</li>\n<li>owner_type: natural_person, legal_person or public_entity</li>\n<li>country_id: Country of the owner's address</li>\n<li>supporting_document_id: Deed or cadastre extract upoaded by operator</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_owner\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchparcel_owner_ogcr","parameters":[{"name":"parcelownerid","in":"path","description":"The PARCELOWNERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"owner_type":{"type":"string"},"parcel_owner_id":{"type":"string"},"country_id":{"type":"string"},"parcel_id":{"type":"string"},"legal_name":{"type":"string"}}},"example":{"parcel_owner_id":"string","parcel_id":"string","legal_name":"string","owner_type":"string","country_id":"string","supporting_document_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_owner":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"owner_type":{"type":"string"},"parcel_owner_id":{"type":"string"},"country_id":{"type":"string"},"parcel_id":{"type":"string"},"legal_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_owner":{"parcel_owner_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_owner_id":"string","parcel_id":"string","legal_name":"string","owner_type":"string","country_id":"string","supporting_document_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/chain-sync-status":{"get":{"tags":["_Chain_sync_status(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public chain_sync_status List","description":"<p>Get Public chain_sync_status List.</p>\n<p>Liveness record for OGCR-chain-cache: one record per chain, rewritten at the end of every mirror run. The other *_on_chain entities say what is on the chain; this says when anything last looked. Without it a quiet chain is indistinguishable from a dead mirror, because the newest mint could be old for either reason. Consumers should treat a record older than a few multiples of interval_seconds as stale.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_count: Activity tokens mirrored in this run.</li>\n<li>certification_count: Certification tokens mirrored in this run.</li>\n<li>chain_id: EVM chain id that was read.</li>\n<li>credit_balance_count: Carbon credit holder balances mirrored in this run.</li>\n<li>credit_batch_count: Carbon credit batch tokens mirrored in this run.</li>\n<li>error_count: Records that failed to upsert during the run.</li>\n<li>head_block: Chain head at the end of the run. Rising across runs is the clearest sign the chain itself is alive, as opposed to only the mirror.</li>\n<li>interval_seconds: Expected seconds between runs, from SYNC_INTERVAL_SECONDS. 0 when the cacher was run by hand. Lets a consumer decide what counts as stale without hardcoding the schedule.</li>\n<li>mirrored_types: Which mirrors ran, comma separated. Distinguishes a count of zero meaning \"none found\" from a mirror that was skipped because its contract is not configured.</li>\n<li>parcel_count: Parcel tokens mirrored in this run.</li>\n<li>run_status: \"ok\" when every configured mirror completed with no errors, \"partial\" when the chain was reachable but some records failed to write. A run that cannot reach the chain at all writes nothing, so the previous record simply ages.</li>\n<li>sync_key: Business key: \"chain-&lt;chain_id&gt;\". One record per chain, overwritten each run. A string key so it can be matched with a server-side query filter.</li>\n<li>synced_at: UTC RFC-3339 timestamp of when the run finished. This is the field a heartbeat is actually built on.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"chain_sync_status\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p><em>(no fields on this entity are declared <code>indexed</code>, so only the legacy bare-parameter filter below is available.)</em></p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPublicchain_sync_statusList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"chain_sync_status_list":{"type":"array","items":{"type":"object","properties":{"chain_sync_status":{"type":"object","properties":{"activity_count":{"type":"integer"},"mirrored_types":{"type":"string"},"error_count":{"type":"integer"},"credit_balance_count":{"type":"integer"},"chain_sync_status_id":{"type":"string"},"sync_key":{"type":"string"},"credit_batch_count":{"type":"integer"},"synced_at":{"type":"string"},"certification_count":{"type":"integer"},"chain_id":{"type":"integer"},"parcel_count":{"type":"integer"},"interval_seconds":{"type":"integer"},"head_block":{"type":"integer"},"run_status":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"chain_sync_status_list":[{"chain_sync_status":{"chain_sync_status_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_count":2,"certification_count":2,"chain_id":20253,"credit_balance_count":5,"credit_batch_count":2,"error_count":0,"head_block":12400,"interval_seconds":30,"mirrored_types":"parcel,activity,certification,credit","parcel_count":2,"run_status":"ok","sync_key":"chain-20253","synced_at":"2026-09-08T20:14:03Z"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/retirement-certificate-on-chain":{"get":{"tags":["_Retirement_certificate_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get retirement_certificate_on_chain List","description":"<p>Get retirement_certificate_on_chain List.</p>\n<p>Parsed entity retirement_certificate_on_chain. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_certificate_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>certification_body_id</code>, <code>certification_scheme_id</code>, <code>chain_id</code>, <code>operator_id</code>, <code>retirement_certificate_id</code>, <code>retirement_event_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>activity_id</code> → <code>activity</code>, <code>certification_body_id</code> → <code>certification_body</code>, <code>certification_scheme_id</code> → <code>certification_scheme</code>, <code>operator_id</code> → <code>operator</code>, <code>retirement_certificate_id</code> → <code>retirement_certificate</code>, <code>retirement_event_id</code> → <code>retirement_event</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getretirement_certificate_on_chainList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_certificate_on_chain_list":{"type":"array","items":{"type":"object","properties":{"retirement_certificate_on_chain":{"type":"object","properties":{"end_use":{"type":"string"},"token_uri":{"type":"string"},"retirement_event_id":{"type":"string"},"owner_address":{"type":"string"},"retirement_certificate_id":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"certification_body_id":{"type":"string"},"serial_number":{"type":"string"},"block_number":{"type":"integer"},"contract_address":{"type":"string"},"unit_type":{"type":"string"},"minted_at":{"type":"integer"},"certification_scheme_id":{"type":"string"},"retirement_certificate_on_chain_id":{"type":"string"},"tx_hash":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"},"chain_id":{"type":"integer"},"beneficiary_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"retirement_certificate_on_chain_list":[{"retirement_certificate_on_chain":{"retirement_certificate_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_certificate_id":"string","serial_number":"string","retirement_event_id":"string","issue_date":"2020-01-01","beneficiary_name":"string","end_use":"string","amount":1.0,"unit_type":"string","activity_id":"string","operator_id":"string","certification_scheme_id":"string","certification_body_id":"string","minted_at":1,"owner_address":"string","token_uri":"string","contract_address":"string","chain_id":1,"tx_hash":"string","block_number":1},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Retirement_certificate_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new retirement_certificate_on_chain","description":"<p>Create new retirement_certificate_on_chain.</p>\n<p>Parsed entity retirement_certificate_on_chain. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_certificate_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createretirement_certificate_on_chain_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"end_use":{"type":"string"},"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"retirement_event_id":{"type":"string"},"owner_address":{"type":"string"},"retirement_certificate_id":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"certification_body_id":{"type":"string"},"serial_number":{"type":"string"},"block_number":{"type":"integer"},"contract_address":{"type":"string"},"unit_type":{"type":"string"},"minted_at":{"type":"integer"},"certification_scheme_id":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"},"chain_id":{"type":"integer"},"beneficiary_name":{"type":"string"}}},"example":{"retirement_certificate_id":"string","serial_number":"string","retirement_event_id":"string","issue_date":"2020-01-01","beneficiary_name":"string","end_use":"string","amount":1.0,"unit_type":"string","activity_id":"string","operator_id":"string","certification_scheme_id":"string","certification_body_id":"string","minted_at":1,"owner_address":"string","token_uri":"string","contract_address":"string","chain_id":1,"tx_hash":"string","block_number":1}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_certificate_on_chain":{"type":"object","properties":{"end_use":{"type":"string"},"token_uri":{"type":"string"},"retirement_event_id":{"type":"string"},"owner_address":{"type":"string"},"retirement_certificate_id":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"certification_body_id":{"type":"string"},"serial_number":{"type":"string"},"block_number":{"type":"integer"},"contract_address":{"type":"string"},"unit_type":{"type":"string"},"minted_at":{"type":"integer"},"certification_scheme_id":{"type":"string"},"retirement_certificate_on_chain_id":{"type":"string"},"tx_hash":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"},"chain_id":{"type":"integer"},"beneficiary_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"retirement_certificate_on_chain":{"retirement_certificate_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_certificate_id":"string","serial_number":"string","retirement_event_id":"string","issue_date":"2020-01-01","beneficiary_name":"string","end_use":"string","amount":1.0,"unit_type":"string","activity_id":"string","operator_id":"string","certification_scheme_id":"string","certification_body_id":"string","minted_at":1,"owner_address":"string","token_uri":"string","contract_address":"string","chain_id":1,"tx_hash":"string","block_number":1},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/activity-technologies-practices-processes":{"get":{"tags":["_Activity_technologies_practices_processes(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public activity_technologies_practices_processes List","description":"<p>Get Public activity_technologies_practices_processes List.</p>\n<p>This is the intersecting entity showing what technologies and practices are being carried out on a certain activity. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_technologies_practices_processes\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>technologies_practices_processes_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPublicactivity_technologies_practices_processesList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_technologies_practices_processes_list":{"type":"array","items":{"type":"object","properties":{"activity_technologies_practices_processes":{"type":"object","properties":{"activity_technologies_practices_processes_id":{"type":"string"},"activity_id":{"type":"string"},"technologies_practices_processes_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"activity_technologies_practices_processes_list":[{"activity_technologies_practices_processes":{"activity_technologies_practices_processes_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","technologies_practices_processes_id":"NO_TILL"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/public/country/{countryid}":{"get":{"tags":["_Country(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public country by id","description":"<p>Get Public country by id.</p>\n<p>Parsed entity country. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>country_id: ISO 3166-1 alpha-2 country code for where the activity occurs.</li>\n<li>country_name: Name of the country</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"country\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePubliccountry_ogcr","parameters":[{"name":"countryid","in":"path","description":"The COUNTRYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"country":{"type":"object","properties":{"country_id":{"type":"string"},"country_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"country":{"country_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","country_id":"DE","country_name":"Germany"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/supporting-document":{"get":{"tags":["_Supporting_document(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get supporting_document List","description":"<p>Get supporting_document List.</p>\n<p>Parsed entity supporting_document. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>supporting_document_id: ISO 3166-1 alpha-2 country code for where the activity occurs.</li>\n<li>title: Title of the document</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"supporting_document\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>supporting_document_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getsupporting_documentList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"supporting_document_list":{"type":"array","items":{"type":"object","properties":{"supporting_document":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"title":{"type":"string"},"sha256_of_document":{"type":"string"},"url":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"supporting_document_list":[{"supporting_document":{"supporting_document_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supporting_document_id":"DE","title":"Germany","sha256_of_document":"string","url":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Supporting_document(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new supporting_document","description":"<p>Create new supporting_document.</p>\n<p>Parsed entity supporting_document. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>supporting_document_id: ISO 3166-1 alpha-2 country code for where the activity occurs.</li>\n<li>title: Title of the document</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"supporting_document\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createsupporting_document_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"title":{"type":"string"},"sha256_of_document":{"type":"string"},"url":{"type":"string"}}},"example":{"supporting_document_id":"DE","title":"Germany","sha256_of_document":"string","url":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"supporting_document":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"title":{"type":"string"},"sha256_of_document":{"type":"string"},"url":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"supporting_document":{"supporting_document_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supporting_document_id":"DE","title":"Germany","sha256_of_document":"string","url":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/sustainable-development-goals":{"get":{"tags":["_Sustainable_development_goals(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get sustainable_development_goals List","description":"<p>Get sustainable_development_goals List.</p>\n<p>Entity for listing sustainable development goals being addressed by an activity. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"sustainable_development_goals\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>sustainable_development_goal_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>activity_id</code> → <code>activity</code>, <code>sustainable_development_goal_id</code> → <code>sustainable_development_goal</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getsustainable_development_goalsList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"sustainable_development_goals_list":{"type":"array","items":{"type":"object","properties":{"sustainable_development_goals":{"type":"object","properties":{"sustainable_development_goals_id":{"type":"string"},"activity_id":{"type":"string"},"sustainable_development_goal_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"sustainable_development_goals_list":[{"sustainable_development_goals":{"sustainable_development_goals_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","sustainable_development_goal_id":"CLIMATE_ACTION"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Sustainable_development_goals(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new sustainable_development_goals","description":"<p>Create new sustainable_development_goals.</p>\n<p>Entity for listing sustainable development goals being addressed by an activity. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"sustainable_development_goals\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createsustainable_development_goals_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"activity_id":{"type":"string"},"sustainable_development_goal_id":{"type":"string"}}},"example":{"activity_id":"string","sustainable_development_goal_id":"CLIMATE_ACTION"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"sustainable_development_goals":{"type":"object","properties":{"sustainable_development_goals_id":{"type":"string"},"activity_id":{"type":"string"},"sustainable_development_goal_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"sustainable_development_goals":{"sustainable_development_goals_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","sustainable_development_goal_id":"CLIMATE_ACTION"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/certification-body/{certificationbodyid}":{"get":{"tags":["_Certification_body(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public certification_body by id","description":"<p>Get Public certification_body by id.</p>\n<p>\u2018certification body\u2019 means an accredited or recognised independent conformity assessment body that has concluded an agreement with a certification scheme to carry out certification audits and issue certificates of compliance;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certification_body_id: Unique identifier for the certification body</li>\n<li>legal_name: Legal or trading name of the certification body</li>\n<li>address_line_1: Certification body primary street address (street name, building number, P.O. Box if applicable)</li>\n<li>address_line_2: Certification body secondary, optional details like apartment, suite, unit, floor, or building name</li>\n<li>address_city: City</li>\n<li>address_postcode: Certification body postcode</li>\n<li>country_id: ISO 3166-1 alpha-2 country code for certification body address.</li>\n<li>logo: URL or asset reference to a logo image for UI/PDF rendering.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_body\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePubliccertification_body_ogcr","parameters":[{"name":"certificationbodyid","in":"path","description":"The CERTIFICATIONBODYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_body":{"type":"object","properties":{"address_city":{"type":"string"},"website":{"type":"string"},"email":{"type":"string"},"accreditation_route":{"type":"string"},"logo":{"type":"string"},"status":{"type":"string"},"address_line_2":{"type":"string"},"address_postcode":{"type":"string"},"country_id":{"type":"string"},"address_line_1":{"type":"string"},"certification_body_id":{"type":"string"},"legal_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"certification_body":{"certification_body_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certification_body_id":"cb_01HZZ1M2A3B4C5D6E7F8","legal_name":"DNV Business Assurance Germany GmbH","accreditation_route":"string","address_line_1":"Brooktorkai 18","address_line_2":"5th Floor","address_city":"Hamburg","address_postcode":"20457","country_id":"DE","status":"string","email":"string","website":"string","logo":"https://cdn.example.org/logos/dnv.png"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/retirement-event-on-chain":{"get":{"tags":["_Retirement_event_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get retirement_event_on_chain List","description":"<p>Get retirement_event_on_chain List.</p>\n<p>Parsed entity retirement_event_on_chain. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>minted_at: On-chain block timestamp (mintedAt) from projectData, unix seconds.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_event_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>chain_id</code>, <code>retirement_event_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>retirement_event_id</code> → <code>retirement_event</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getretirement_event_on_chainList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_event_on_chain_list":{"type":"array","items":{"type":"object","properties":{"retirement_event_on_chain":{"type":"object","properties":{"end_use":{"type":"string"},"retirement_date":{"type":"string"},"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"amount":{"type":"number"},"token_id":{"type":"string"},"retirement_event_on_chain_id":{"type":"string"},"contract_address":{"type":"string"},"unit_type":{"type":"string"},"minted_at":{"type":"integer"},"retirement_reason":{"type":"string"},"retirement_event_id":{"type":"string"},"block_number":{"type":"number"},"carbon_credit_batch_id":{"type":"string"},"chain_id":{"type":"integer"},"beneficiary_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"retirement_event_on_chain_list":[{"retirement_event_on_chain":{"retirement_event_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_event_id":"string","token_id":"string","unit_type":"string","carbon_credit_batch_id":"string","amount":1.0,"owner_address":"string","beneficiary_name":"string","end_use":"string","retirement_reason":"string","retirement_date":"2020-01-01","minted_at":1,"token_uri":"string","contract_address":"string","chain_id":1,"tx_hash":"string","block_number":1.0},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Retirement_event_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new retirement_event_on_chain","description":"<p>Create new retirement_event_on_chain.</p>\n<p>Parsed entity retirement_event_on_chain. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>minted_at: On-chain block timestamp (mintedAt) from projectData, unix seconds.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_event_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createretirement_event_on_chain_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"end_use":{"type":"string"},"retirement_date":{"type":"string"},"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"amount":{"type":"number"},"token_id":{"type":"string"},"contract_address":{"type":"string"},"unit_type":{"type":"string"},"minted_at":{"type":"integer"},"retirement_reason":{"type":"string"},"retirement_event_id":{"type":"string"},"block_number":{"type":"number"},"carbon_credit_batch_id":{"type":"string"},"chain_id":{"type":"integer"},"beneficiary_name":{"type":"string"}}},"example":{"retirement_event_id":"string","token_id":"string","unit_type":"string","carbon_credit_batch_id":"string","amount":1.0,"owner_address":"string","beneficiary_name":"string","end_use":"string","retirement_reason":"string","retirement_date":"2020-01-01","minted_at":1,"token_uri":"string","contract_address":"string","chain_id":1,"tx_hash":"string","block_number":1.0}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_event_on_chain":{"type":"object","properties":{"end_use":{"type":"string"},"retirement_date":{"type":"string"},"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"amount":{"type":"number"},"token_id":{"type":"string"},"retirement_event_on_chain_id":{"type":"string"},"contract_address":{"type":"string"},"unit_type":{"type":"string"},"minted_at":{"type":"integer"},"retirement_reason":{"type":"string"},"retirement_event_id":{"type":"string"},"block_number":{"type":"number"},"carbon_credit_batch_id":{"type":"string"},"chain_id":{"type":"integer"},"beneficiary_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"retirement_event_on_chain":{"retirement_event_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_event_id":"string","token_id":"string","unit_type":"string","carbon_credit_batch_id":"string","amount":1.0,"owner_address":"string","beneficiary_name":"string","end_use":"string","retirement_reason":"string","retirement_date":"2020-01-01","minted_at":1,"token_uri":"string","contract_address":"string","chain_id":1,"tx_hash":"string","block_number":1.0},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/parcel-owner-verification-supporting-document":{"get":{"tags":["_Parcel_owner_verification_supporting_document(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get parcel_owner_verification_supporting_document List","description":"<p>Get parcel_owner_verification_supporting_document List.</p>\n<p>Parsed entity parcel_owner_verification_supporting_document. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_owner_verification_supporting_document\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>parcel_owner_verification_id</code>, <code>supporting_document_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>parcel_owner_verification_id</code> → <code>parcel_owner_verification</code>, <code>supporting_document_id</code> → <code>supporting_document</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getparcel_owner_verification_supporting_documentList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_owner_verification_supporting_document_list":{"type":"array","items":{"type":"object","properties":{"parcel_owner_verification_supporting_document":{"type":"object","properties":{"parcel_owner_verification_supporting_document_id":{"type":"string"},"supporting_document_id":{"type":"string"},"parcel_owner_verification_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"parcel_owner_verification_supporting_document_list":[{"parcel_owner_verification_supporting_document":{"parcel_owner_verification_supporting_document_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supporting_document_id":"string","parcel_owner_verification_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Parcel_owner_verification_supporting_document(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new parcel_owner_verification_supporting_document","description":"<p>Create new parcel_owner_verification_supporting_document.</p>\n<p>Parsed entity parcel_owner_verification_supporting_document. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_owner_verification_supporting_document\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createparcel_owner_verification_supporting_document_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"parcel_owner_verification_id":{"type":"string"}}},"example":{"supporting_document_id":"string","parcel_owner_verification_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_owner_verification_supporting_document":{"type":"object","properties":{"parcel_owner_verification_supporting_document_id":{"type":"string"},"supporting_document_id":{"type":"string"},"parcel_owner_verification_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_owner_verification_supporting_document":{"parcel_owner_verification_supporting_document_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supporting_document_id":"string","parcel_owner_verification_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/sustainable-development-goals":{"get":{"tags":["_Sustainable_development_goals(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public sustainable_development_goals List","description":"<p>Get Public sustainable_development_goals List.</p>\n<p>Entity for listing sustainable development goals being addressed by an activity. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"sustainable_development_goals\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>sustainable_development_goal_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPublicsustainable_development_goalsList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"sustainable_development_goals_list":{"type":"array","items":{"type":"object","properties":{"sustainable_development_goals":{"type":"object","properties":{"sustainable_development_goals_id":{"type":"string"},"activity_id":{"type":"string"},"sustainable_development_goal_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"sustainable_development_goals_list":[{"sustainable_development_goals":{"sustainable_development_goals_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","sustainable_development_goal_id":"CLIMATE_ACTION"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/public/activity-non-conformity/{activitynonconformityid}":{"get":{"tags":["_Activity_non_conformity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public activity_non_conformity by id","description":"<p>Get Public activity_non_conformity by id.</p>\n<p>\u2018non-conformity\u2019 means a failure by an operator or a certification body to comply with the rules and procedures, established by the certification scheme, of which they are members or under which they operate. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>category: critical, major and minor</li>\n<li>remediation_timeline: Timeline for remediation of non-conformities</li>\n<li>sanction: Sanction imposed for the non-conformity, e.g. warning, suspension or withdrawal of certification</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_non_conformity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePublicactivity_non_conformity_ogcr","parameters":[{"name":"activitynonconformityid","in":"path","description":"The ACTIVITYNONCONFORMITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_non_conformity":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"non_conformity_id":{"type":"string"},"sanction":{"type":"string"},"audit_report_id":{"type":"string"},"remediation_timeline":{"type":"string"},"activity_non_conformity_id":{"type":"string"},"certification_body_id":{"type":"string"},"category":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"activity_non_conformity":{"activity_non_conformity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","non_conformity_id":"string","audit_report_id":"string","category":"string","remediation_timeline":"string","sanction":"warning","certification_scheme_id":"string","certification_body_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/activity-on-chain/{activityonchainid}":{"get":{"tags":["_Activity_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get activity_on_chain by id","description":"<p>Get activity_on_chain by id.</p>\n<p>Cache of ActivityNFT data minted on the OGCR chain (chain id 20253). One record per activity_id, populated by OGCR-chain-cache reading the chain.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_hash: activity_hash stored on-chain: keccak256 of the raw activity entity body.</li>\n<li>activity_id: The <code>activity</code> this NFT was minted for (a reference, so OBP joins activity -&gt; activity_on_chain, e.g. in the registry query). OBP refuses a record whose activity is not in this space.</li>\n<li>activity_type: Activity type as stored on-chain.</li>\n<li>activity_url: activity_url stored on-chain: link back to the OBP activity entity.</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>certification_scheme_id: certification_scheme_id as stored on-chain.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>city: City as stored on-chain.</li>\n<li>contract_address: ActivityNFT contract address the token was read from.</li>\n<li>country_id: Country id as stored on-chain.</li>\n<li>end_date: Activity end date as stored on-chain.</li>\n<li>minted_at: Unix time (seconds) of the block the mint was included in.</li>\n<li>name: Activity name as stored on-chain.</li>\n<li>operator_id: operator_id stored on-chain (owning operator).</li>\n<li>operator_name: Operator legal name (operator.legal_name) as stored on-chain.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>parcel_ids: Parcels linked to the activity at mint time: the contract's parcel_ids[] joined with commas, as tokenURI renders it.</li>\n<li>start_date: Activity start date as stored on-chain.</li>\n<li>summary: Activity summary as stored on-chain.</li>\n<li>token_id: ActivityNFT token id minted for this activity.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>tx_hash: Mint transaction hash (from the ActivityMinted event).</li>\n<li>unit_types: Unit types of the activity as stored on-chain.</li>\n<li>website: Activity website as stored on-chain.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleactivity_on_chain_ogcr","parameters":[{"name":"activityonchainid","in":"path","description":"The ACTIVITYONCHAINID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_on_chain":{"type":"object","properties":{"name":{"type":"string"},"token_uri":{"type":"string"},"activity_on_chain_id":{"type":"string"},"tx_hash":{"type":"string"},"activity_type":{"type":"string"},"owner_address":{"type":"string"},"activity_url":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"integer"},"block_number":{"type":"integer"},"contract_address":{"type":"string"},"country_id":{"type":"string"},"summary":{"type":"string"},"chain_id":{"type":"integer"},"website":{"type":"string"},"city":{"type":"string"},"operator_name":{"type":"string"},"start_date":{"type":"string"},"minted_at":{"type":"integer"},"certification_scheme_id":{"type":"string"},"parcel_ids":{"type":"string"},"end_date":{"type":"string"},"unit_types":{"type":"string"},"activity_hash":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_on_chain":{"activity_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_type":"carbon_farming","activity_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/activity/activity_AB12CD34EF","block_number":12345,"certification_scheme_id":"scheme_SALUS","chain_id":20253,"city":"Viborg","contract_address":"0x5034F49b27353CeDc562b49eA91C7438Ea351d36","country_id":"DK","end_date":"2024-12-31","minted_at":1779280448,"name":"Reforestation 2024","operator_id":"operator_9XYZ","operator_name":"Example Operator GmbH","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","parcel_ids":"parcel_01,parcel_02","start_date":"2024-01-01","summary":"Rewetting of drained peat soils.","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQWN0aXZpdHkifQ==","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_types":"Permanent Removal","website":"https://example.org"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Activity_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update activity_on_chain","description":"<p>Update activity_on_chain.</p>\n<p>Cache of ActivityNFT data minted on the OGCR chain (chain id 20253). One record per activity_id, populated by OGCR-chain-cache reading the chain.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_hash: activity_hash stored on-chain: keccak256 of the raw activity entity body.</li>\n<li>activity_id: The <code>activity</code> this NFT was minted for (a reference, so OBP joins activity -&gt; activity_on_chain, e.g. in the registry query). OBP refuses a record whose activity is not in this space.</li>\n<li>activity_type: Activity type as stored on-chain.</li>\n<li>activity_url: activity_url stored on-chain: link back to the OBP activity entity.</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>certification_scheme_id: certification_scheme_id as stored on-chain.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>city: City as stored on-chain.</li>\n<li>contract_address: ActivityNFT contract address the token was read from.</li>\n<li>country_id: Country id as stored on-chain.</li>\n<li>end_date: Activity end date as stored on-chain.</li>\n<li>minted_at: Unix time (seconds) of the block the mint was included in.</li>\n<li>name: Activity name as stored on-chain.</li>\n<li>operator_id: operator_id stored on-chain (owning operator).</li>\n<li>operator_name: Operator legal name (operator.legal_name) as stored on-chain.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>parcel_ids: Parcels linked to the activity at mint time: the contract's parcel_ids[] joined with commas, as tokenURI renders it.</li>\n<li>start_date: Activity start date as stored on-chain.</li>\n<li>summary: Activity summary as stored on-chain.</li>\n<li>token_id: ActivityNFT token id minted for this activity.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>tx_hash: Mint transaction hash (from the ActivityMinted event).</li>\n<li>unit_types: Unit types of the activity as stored on-chain.</li>\n<li>website: Activity website as stored on-chain.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateactivity_on_chain_ogcr","parameters":[{"name":"activityonchainid","in":"path","description":"The ACTIVITYONCHAINID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"activity_type":{"type":"string"},"owner_address":{"type":"string"},"activity_url":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"integer"},"block_number":{"type":"integer"},"contract_address":{"type":"string"},"country_id":{"type":"string"},"summary":{"type":"string"},"chain_id":{"type":"integer"},"website":{"type":"string"},"city":{"type":"string"},"operator_name":{"type":"string"},"start_date":{"type":"string"},"minted_at":{"type":"integer"},"certification_scheme_id":{"type":"string"},"parcel_ids":{"type":"string"},"end_date":{"type":"string"},"unit_types":{"type":"string"},"activity_hash":{"type":"string"}}},"example":{"activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_type":"carbon_farming","activity_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/activity/activity_AB12CD34EF","block_number":12345,"certification_scheme_id":"scheme_SALUS","chain_id":20253,"city":"Viborg","contract_address":"0x5034F49b27353CeDc562b49eA91C7438Ea351d36","country_id":"DK","end_date":"2024-12-31","minted_at":1779280448,"name":"Reforestation 2024","operator_id":"operator_9XYZ","operator_name":"Example Operator GmbH","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","parcel_ids":"parcel_01,parcel_02","start_date":"2024-01-01","summary":"Rewetting of drained peat soils.","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQWN0aXZpdHkifQ==","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_types":"Permanent Removal","website":"https://example.org"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_on_chain":{"type":"object","properties":{"name":{"type":"string"},"token_uri":{"type":"string"},"activity_on_chain_id":{"type":"string"},"tx_hash":{"type":"string"},"activity_type":{"type":"string"},"owner_address":{"type":"string"},"activity_url":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"integer"},"block_number":{"type":"integer"},"contract_address":{"type":"string"},"country_id":{"type":"string"},"summary":{"type":"string"},"chain_id":{"type":"integer"},"website":{"type":"string"},"city":{"type":"string"},"operator_name":{"type":"string"},"start_date":{"type":"string"},"minted_at":{"type":"integer"},"certification_scheme_id":{"type":"string"},"parcel_ids":{"type":"string"},"end_date":{"type":"string"},"unit_types":{"type":"string"},"activity_hash":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_on_chain":{"activity_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_type":"carbon_farming","activity_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/activity/activity_AB12CD34EF","block_number":12345,"certification_scheme_id":"scheme_SALUS","chain_id":20253,"city":"Viborg","contract_address":"0x5034F49b27353CeDc562b49eA91C7438Ea351d36","country_id":"DK","end_date":"2024-12-31","minted_at":1779280448,"name":"Reforestation 2024","operator_id":"operator_9XYZ","operator_name":"Example Operator GmbH","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","parcel_ids":"parcel_01,parcel_02","start_date":"2024-01-01","summary":"Rewetting of drained peat soils.","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQWN0aXZpdHkifQ==","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_types":"Permanent Removal","website":"https://example.org"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Activity_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete activity_on_chain by id","description":"<p>Delete activity_on_chain by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteactivity_on_chain_ogcr","parameters":[{"name":"activityonchainid","in":"path","description":"The ACTIVITYONCHAINID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_on_chain":{"type":"object","properties":{"name":{"type":"string"},"token_uri":{"type":"string"},"activity_on_chain_id":{"type":"string"},"tx_hash":{"type":"string"},"activity_type":{"type":"string"},"owner_address":{"type":"string"},"activity_url":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"integer"},"block_number":{"type":"integer"},"contract_address":{"type":"string"},"country_id":{"type":"string"},"summary":{"type":"string"},"chain_id":{"type":"integer"},"website":{"type":"string"},"city":{"type":"string"},"operator_name":{"type":"string"},"start_date":{"type":"string"},"minted_at":{"type":"integer"},"certification_scheme_id":{"type":"string"},"parcel_ids":{"type":"string"},"end_date":{"type":"string"},"unit_types":{"type":"string"},"activity_hash":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_on_chain":{"activity_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_type":"carbon_farming","activity_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/activity/activity_AB12CD34EF","block_number":12345,"certification_scheme_id":"scheme_SALUS","chain_id":20253,"city":"Viborg","contract_address":"0x5034F49b27353CeDc562b49eA91C7438Ea351d36","country_id":"DK","end_date":"2024-12-31","minted_at":1779280448,"name":"Reforestation 2024","operator_id":"operator_9XYZ","operator_name":"Example Operator GmbH","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","parcel_ids":"parcel_01,parcel_02","start_date":"2024-01-01","summary":"Rewetting of drained peat soils.","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQWN0aXZpdHkifQ==","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_types":"Permanent Removal","website":"https://example.org"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Activity_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update activity_on_chain","description":"<p>Partially update activity_on_chain: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Cache of ActivityNFT data minted on the OGCR chain (chain id 20253). One record per activity_id, populated by OGCR-chain-cache reading the chain.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_hash: activity_hash stored on-chain: keccak256 of the raw activity entity body.</li>\n<li>activity_id: The <code>activity</code> this NFT was minted for (a reference, so OBP joins activity -&gt; activity_on_chain, e.g. in the registry query). OBP refuses a record whose activity is not in this space.</li>\n<li>activity_type: Activity type as stored on-chain.</li>\n<li>activity_url: activity_url stored on-chain: link back to the OBP activity entity.</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>certification_scheme_id: certification_scheme_id as stored on-chain.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>city: City as stored on-chain.</li>\n<li>contract_address: ActivityNFT contract address the token was read from.</li>\n<li>country_id: Country id as stored on-chain.</li>\n<li>end_date: Activity end date as stored on-chain.</li>\n<li>minted_at: Unix time (seconds) of the block the mint was included in.</li>\n<li>name: Activity name as stored on-chain.</li>\n<li>operator_id: operator_id stored on-chain (owning operator).</li>\n<li>operator_name: Operator legal name (operator.legal_name) as stored on-chain.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>parcel_ids: Parcels linked to the activity at mint time: the contract's parcel_ids[] joined with commas, as tokenURI renders it.</li>\n<li>start_date: Activity start date as stored on-chain.</li>\n<li>summary: Activity summary as stored on-chain.</li>\n<li>token_id: ActivityNFT token id minted for this activity.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>tx_hash: Mint transaction hash (from the ActivityMinted event).</li>\n<li>unit_types: Unit types of the activity as stored on-chain.</li>\n<li>website: Activity website as stored on-chain.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchactivity_on_chain_ogcr","parameters":[{"name":"activityonchainid","in":"path","description":"The ACTIVITYONCHAINID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"activity_type":{"type":"string"},"owner_address":{"type":"string"},"activity_url":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"integer"},"block_number":{"type":"integer"},"contract_address":{"type":"string"},"country_id":{"type":"string"},"summary":{"type":"string"},"chain_id":{"type":"integer"},"website":{"type":"string"},"city":{"type":"string"},"operator_name":{"type":"string"},"start_date":{"type":"string"},"minted_at":{"type":"integer"},"certification_scheme_id":{"type":"string"},"parcel_ids":{"type":"string"},"end_date":{"type":"string"},"unit_types":{"type":"string"},"activity_hash":{"type":"string"}}},"example":{"activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_type":"carbon_farming","activity_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/activity/activity_AB12CD34EF","block_number":12345,"certification_scheme_id":"scheme_SALUS","chain_id":20253,"city":"Viborg","contract_address":"0x5034F49b27353CeDc562b49eA91C7438Ea351d36","country_id":"DK","end_date":"2024-12-31","minted_at":1779280448,"name":"Reforestation 2024","operator_id":"operator_9XYZ","operator_name":"Example Operator GmbH","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","parcel_ids":"parcel_01,parcel_02","start_date":"2024-01-01","summary":"Rewetting of drained peat soils.","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQWN0aXZpdHkifQ==","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_types":"Permanent Removal","website":"https://example.org"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_on_chain":{"type":"object","properties":{"name":{"type":"string"},"token_uri":{"type":"string"},"activity_on_chain_id":{"type":"string"},"tx_hash":{"type":"string"},"activity_type":{"type":"string"},"owner_address":{"type":"string"},"activity_url":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"integer"},"block_number":{"type":"integer"},"contract_address":{"type":"string"},"country_id":{"type":"string"},"summary":{"type":"string"},"chain_id":{"type":"integer"},"website":{"type":"string"},"city":{"type":"string"},"operator_name":{"type":"string"},"start_date":{"type":"string"},"minted_at":{"type":"integer"},"certification_scheme_id":{"type":"string"},"parcel_ids":{"type":"string"},"end_date":{"type":"string"},"unit_types":{"type":"string"},"activity_hash":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_on_chain":{"activity_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_type":"carbon_farming","activity_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/activity/activity_AB12CD34EF","block_number":12345,"certification_scheme_id":"scheme_SALUS","chain_id":20253,"city":"Viborg","contract_address":"0x5034F49b27353CeDc562b49eA91C7438Ea351d36","country_id":"DK","end_date":"2024-12-31","minted_at":1779280448,"name":"Reforestation 2024","operator_id":"operator_9XYZ","operator_name":"Example Operator GmbH","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","parcel_ids":"parcel_01,parcel_02","start_date":"2024-01-01","summary":"Rewetting of drained peat soils.","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQWN0aXZpdHkifQ==","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_types":"Permanent Removal","website":"https://example.org"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/parcel-owner":{"get":{"tags":["_Parcel_owner(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get parcel_owner List","description":"<p>Get parcel_owner List.</p>\n<p>Parsed entity parcel_owner. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>parcel_owner_id: Internal identifier</li>\n<li>parcel_id: Parcel the claim is about</li>\n<li>legal_name: Owner as declared by the operator</li>\n<li>owner_type: natural_person, legal_person or public_entity</li>\n<li>country_id: Country of the owner's address</li>\n<li>supporting_document_id: Deed or cadastre extract upoaded by operator</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_owner\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>country_id</code>, <code>parcel_id</code>, <code>parcel_owner_id</code>, <code>supporting_document_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>country_id</code> → <code>country</code>, <code>parcel_id</code> → <code>parcel</code>, <code>supporting_document_id</code> → <code>supporting_document</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getparcel_ownerList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_owner_list":{"type":"array","items":{"type":"object","properties":{"parcel_owner":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"owner_type":{"type":"string"},"parcel_owner_id":{"type":"string"},"country_id":{"type":"string"},"parcel_id":{"type":"string"},"legal_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"parcel_owner_list":[{"parcel_owner":{"parcel_owner_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_owner_id":"string","parcel_id":"string","legal_name":"string","owner_type":"string","country_id":"string","supporting_document_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Parcel_owner(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new parcel_owner","description":"<p>Create new parcel_owner.</p>\n<p>Parsed entity parcel_owner. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>parcel_owner_id: Internal identifier</li>\n<li>parcel_id: Parcel the claim is about</li>\n<li>legal_name: Owner as declared by the operator</li>\n<li>owner_type: natural_person, legal_person or public_entity</li>\n<li>country_id: Country of the owner's address</li>\n<li>supporting_document_id: Deed or cadastre extract upoaded by operator</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_owner\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createparcel_owner_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"owner_type":{"type":"string"},"parcel_owner_id":{"type":"string"},"country_id":{"type":"string"},"parcel_id":{"type":"string"},"legal_name":{"type":"string"}}},"example":{"parcel_owner_id":"string","parcel_id":"string","legal_name":"string","owner_type":"string","country_id":"string","supporting_document_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_owner":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"owner_type":{"type":"string"},"parcel_owner_id":{"type":"string"},"country_id":{"type":"string"},"parcel_id":{"type":"string"},"legal_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_owner":{"parcel_owner_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_owner_id":"string","parcel_id":"string","legal_name":"string","owner_type":"string","country_id":"string","supporting_document_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/certification-body":{"get":{"tags":["_Certification_body(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public certification_body List","description":"<p>Get Public certification_body List.</p>\n<p>\u2018certification body\u2019 means an accredited or recognised independent conformity assessment body that has concluded an agreement with a certification scheme to carry out certification audits and issue certificates of compliance;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certification_body_id: Unique identifier for the certification body</li>\n<li>legal_name: Legal or trading name of the certification body</li>\n<li>address_line_1: Certification body primary street address (street name, building number, P.O. Box if applicable)</li>\n<li>address_line_2: Certification body secondary, optional details like apartment, suite, unit, floor, or building name</li>\n<li>address_city: City</li>\n<li>address_postcode: Certification body postcode</li>\n<li>country_id: ISO 3166-1 alpha-2 country code for certification body address.</li>\n<li>logo: URL or asset reference to a logo image for UI/PDF rendering.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_body\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>certification_body_id</code>, <code>country_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPubliccertification_bodyList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_body_list":{"type":"array","items":{"type":"object","properties":{"certification_body":{"type":"object","properties":{"address_city":{"type":"string"},"website":{"type":"string"},"email":{"type":"string"},"accreditation_route":{"type":"string"},"logo":{"type":"string"},"status":{"type":"string"},"address_line_2":{"type":"string"},"address_postcode":{"type":"string"},"country_id":{"type":"string"},"address_line_1":{"type":"string"},"certification_body_id":{"type":"string"},"legal_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"certification_body_list":[{"certification_body":{"certification_body_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certification_body_id":"cb_01HZZ1M2A3B4C5D6E7F8","legal_name":"DNV Business Assurance Germany GmbH","accreditation_route":"string","address_line_1":"Brooktorkai 18","address_line_2":"5th Floor","address_city":"Hamburg","address_postcode":"20457","country_id":"DE","status":"string","email":"string","website":"string","logo":"https://cdn.example.org/logos/dnv.png"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/ogcr-dynamicentities-log/{ogcrdynamicentitieslogid}":{"get":{"tags":["_Ogcr_dynamicentities_log(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get ogcr_dynamicentities_log by id","description":"<p>Get ogcr_dynamicentities_log by id.</p>\n<p>Audit log of OGCR dynamic-entity data creation: one record per created object or failed create, capturing how each of its reference fields resolved.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>event_type: One of entity_created, entity_failed.</li>\n<li>entity_name: Name of the dynamic entity the event concerns.</li>\n<li>entity_id: Id of the created object, when known.</li>\n<li>status: success or error.</li>\n<li>message: Human-readable detail or error text.</li>\n<li>references: List of every reference: field on this entity and how it resolved. Each item has <code>field</code>, <code>target</code>, <code>resolution</code> (resolved = a real created id was used; fallback = the spreadsheet example value was used) and the <code>value</code> posted.</li>\n<li>timestamp: UTC ISO-8601 time the event was recorded.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"ogcr_dynamicentities_log\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleogcr_dynamicentities_log_ogcr","parameters":[{"name":"ogcrdynamicentitieslogid","in":"path","description":"The OGCRDYNAMICENTITIESLOGID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"ogcr_dynamicentities_log":{"type":"object","properties":{"timestamp":{"type":"string"},"entity_id":{"type":"string"},"references":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"target":{"type":"string"},"resolution":{"type":"string"},"value":{"type":"string"}}}},"entity_name":{"type":"string"},"event_type":{"type":"string"},"status":{"type":"string"},"message":{"type":"string"},"ogcr_dynamicentities_log_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"ogcr_dynamicentities_log":{"ogcr_dynamicentities_log_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","event_type":"entity_created","entity_name":"operator","entity_id":"a8770fca-3d1d-47af-b6d0-7a6c3f124388","status":"success","message":"Created operator","references":[{"field":"operator_id","target":"operator","resolution":"resolved","value":"a8770fca-3d1d-47af-b6d0-7a6c3f124388"},{"field":"bank_account_id","target":"BankAccount","resolution":"fallback","value":"sample-account-id"}],"timestamp":"2026-06-24T12:00:00Z"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Ogcr_dynamicentities_log(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update ogcr_dynamicentities_log","description":"<p>Update ogcr_dynamicentities_log.</p>\n<p>Audit log of OGCR dynamic-entity data creation: one record per created object or failed create, capturing how each of its reference fields resolved.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>event_type: One of entity_created, entity_failed.</li>\n<li>entity_name: Name of the dynamic entity the event concerns.</li>\n<li>entity_id: Id of the created object, when known.</li>\n<li>status: success or error.</li>\n<li>message: Human-readable detail or error text.</li>\n<li>references: List of every reference: field on this entity and how it resolved. Each item has <code>field</code>, <code>target</code>, <code>resolution</code> (resolved = a real created id was used; fallback = the spreadsheet example value was used) and the <code>value</code> posted.</li>\n<li>timestamp: UTC ISO-8601 time the event was recorded.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"ogcr_dynamicentities_log\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateogcr_dynamicentities_log_ogcr","parameters":[{"name":"ogcrdynamicentitieslogid","in":"path","description":"The OGCRDYNAMICENTITIESLOGID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"string"},"entity_id":{"type":"string"},"message":{"type":"string"},"references":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"target":{"type":"string"},"resolution":{"type":"string"},"value":{"type":"string"}}}},"entity_name":{"type":"string"},"event_type":{"type":"string"},"status":{"type":"string"}}},"example":{"event_type":"entity_created","entity_name":"operator","entity_id":"a8770fca-3d1d-47af-b6d0-7a6c3f124388","status":"success","message":"Created operator","references":[{"field":"operator_id","target":"operator","resolution":"resolved","value":"a8770fca-3d1d-47af-b6d0-7a6c3f124388"},{"field":"bank_account_id","target":"BankAccount","resolution":"fallback","value":"sample-account-id"}],"timestamp":"2026-06-24T12:00:00Z"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"ogcr_dynamicentities_log":{"type":"object","properties":{"timestamp":{"type":"string"},"entity_id":{"type":"string"},"references":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"target":{"type":"string"},"resolution":{"type":"string"},"value":{"type":"string"}}}},"entity_name":{"type":"string"},"event_type":{"type":"string"},"status":{"type":"string"},"message":{"type":"string"},"ogcr_dynamicentities_log_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"ogcr_dynamicentities_log":{"ogcr_dynamicentities_log_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","event_type":"entity_created","entity_name":"operator","entity_id":"a8770fca-3d1d-47af-b6d0-7a6c3f124388","status":"success","message":"Created operator","references":[{"field":"operator_id","target":"operator","resolution":"resolved","value":"a8770fca-3d1d-47af-b6d0-7a6c3f124388"},{"field":"bank_account_id","target":"BankAccount","resolution":"fallback","value":"sample-account-id"}],"timestamp":"2026-06-24T12:00:00Z"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Ogcr_dynamicentities_log(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete ogcr_dynamicentities_log by id","description":"<p>Delete ogcr_dynamicentities_log by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"ogcr_dynamicentities_log\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteogcr_dynamicentities_log_ogcr","parameters":[{"name":"ogcrdynamicentitieslogid","in":"path","description":"The OGCRDYNAMICENTITIESLOGID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"ogcr_dynamicentities_log":{"type":"object","properties":{"timestamp":{"type":"string"},"entity_id":{"type":"string"},"references":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"target":{"type":"string"},"resolution":{"type":"string"},"value":{"type":"string"}}}},"entity_name":{"type":"string"},"event_type":{"type":"string"},"status":{"type":"string"},"message":{"type":"string"},"ogcr_dynamicentities_log_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"ogcr_dynamicentities_log":{"ogcr_dynamicentities_log_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","event_type":"entity_created","entity_name":"operator","entity_id":"a8770fca-3d1d-47af-b6d0-7a6c3f124388","status":"success","message":"Created operator","references":[{"field":"operator_id","target":"operator","resolution":"resolved","value":"a8770fca-3d1d-47af-b6d0-7a6c3f124388"},{"field":"bank_account_id","target":"BankAccount","resolution":"fallback","value":"sample-account-id"}],"timestamp":"2026-06-24T12:00:00Z"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Ogcr_dynamicentities_log(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update ogcr_dynamicentities_log","description":"<p>Partially update ogcr_dynamicentities_log: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Audit log of OGCR dynamic-entity data creation: one record per created object or failed create, capturing how each of its reference fields resolved.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>event_type: One of entity_created, entity_failed.</li>\n<li>entity_name: Name of the dynamic entity the event concerns.</li>\n<li>entity_id: Id of the created object, when known.</li>\n<li>status: success or error.</li>\n<li>message: Human-readable detail or error text.</li>\n<li>references: List of every reference: field on this entity and how it resolved. Each item has <code>field</code>, <code>target</code>, <code>resolution</code> (resolved = a real created id was used; fallback = the spreadsheet example value was used) and the <code>value</code> posted.</li>\n<li>timestamp: UTC ISO-8601 time the event was recorded.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"ogcr_dynamicentities_log\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchogcr_dynamicentities_log_ogcr","parameters":[{"name":"ogcrdynamicentitieslogid","in":"path","description":"The OGCRDYNAMICENTITIESLOGID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"string"},"entity_id":{"type":"string"},"message":{"type":"string"},"references":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"target":{"type":"string"},"resolution":{"type":"string"},"value":{"type":"string"}}}},"entity_name":{"type":"string"},"event_type":{"type":"string"},"status":{"type":"string"}}},"example":{"event_type":"entity_created","entity_name":"operator","entity_id":"a8770fca-3d1d-47af-b6d0-7a6c3f124388","status":"success","message":"Created operator","references":[{"field":"operator_id","target":"operator","resolution":"resolved","value":"a8770fca-3d1d-47af-b6d0-7a6c3f124388"},{"field":"bank_account_id","target":"BankAccount","resolution":"fallback","value":"sample-account-id"}],"timestamp":"2026-06-24T12:00:00Z"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"ogcr_dynamicentities_log":{"type":"object","properties":{"timestamp":{"type":"string"},"entity_id":{"type":"string"},"references":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"target":{"type":"string"},"resolution":{"type":"string"},"value":{"type":"string"}}}},"entity_name":{"type":"string"},"event_type":{"type":"string"},"status":{"type":"string"},"message":{"type":"string"},"ogcr_dynamicentities_log_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"ogcr_dynamicentities_log":{"ogcr_dynamicentities_log_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","event_type":"entity_created","entity_name":"operator","entity_id":"a8770fca-3d1d-47af-b6d0-7a6c3f124388","status":"success","message":"Created operator","references":[{"field":"operator_id","target":"operator","resolution":"resolved","value":"a8770fca-3d1d-47af-b6d0-7a6c3f124388"},{"field":"bank_account_id","target":"BankAccount","resolution":"fallback","value":"sample-account-id"}],"timestamp":"2026-06-24T12:00:00Z"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/sustainable-development-goal/{sustainabledevelopmentgoalid}":{"get":{"tags":["_Sustainable_development_goal(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public sustainable_development_goal by id","description":"<p>Get Public sustainable_development_goal by id.</p>\n<p>This is the lookup table for sustainable development goals. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"sustainable_development_goal\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePublicsustainable_development_goal_ogcr","parameters":[{"name":"sustainabledevelopmentgoalid","in":"path","description":"The SUSTAINABLEDEVELOPMENTGOALID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"sustainable_development_goal":{"type":"object","properties":{"sustainable_development_goal_id":{"type":"string"},"sustainable_development_goal_name":{"type":"string"},"sustainable_development_goal_link":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"sustainable_development_goal":{"sustainable_development_goal_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","sustainable_development_goal_id":"string","sustainable_development_goal_name":"string","sustainable_development_goal_link":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/public/operator/{operatorid}":{"get":{"tags":["_Operator(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public operator by id","description":"<p>Get Public operator by id.</p>\n<p>\u2018operator\u2019 means any natural or legal person or public entity that operates or controls an activity, or to whom or to which decisive economic power over the technical functioning of the activity has been delegated;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>operator_id: Internal identifier for the operator entity</li>\n<li>legal_name: Legal name of the Operator.</li>\n<li>email: Operator email address.</li>\n<li>phone: Operator contact phone in international format.</li>\n<li>address_line_1: Operator primary street address (street name, building number, P.O. Box if applicable)</li>\n<li>address_line_2: Operator secondary, optional details like apartment, suite, unit, floor, or building name</li>\n<li>postcode: Operator postcode</li>\n<li>country_id: ISO 3166-1 alpha-2 country code for operator address.</li>\n<li>ogcr_wallet_address: Wallet address to send NFTs and carbon credits to after evaluation period</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"operator\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePublicoperator_ogcr","parameters":[{"name":"operatorid","in":"path","description":"The OPERATORID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"operator":{"type":"object","properties":{"email":{"type":"string"},"postcode":{"type":"string"},"operator_id":{"type":"string"},"ogcr_wallet_address":{"type":"string"},"address_line_2":{"type":"string"},"legal_name":{"type":"string"},"country_id":{"type":"string"},"address_line_1":{"type":"string"},"phone":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"operator":{"operator_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","operator_id":"op_01JS0347FKH","legal_name":"Agreena","email":"contact@example.com","phone":"+49 123 456 789","address_line_1":"Green Street, 20","address_line_2":"Suite 400","postcode":"10115\" or \"W1K 3JP","country_id":"DE","ogcr_wallet_address":"0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/public/activity-technologies-practices-processes/{activitytechnologiespracticesprocessesid}":{"get":{"tags":["_Activity_technologies_practices_processes(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public activity_technologies_practices_processes by id","description":"<p>Get Public activity_technologies_practices_processes by id.</p>\n<p>This is the intersecting entity showing what technologies and practices are being carried out on a certain activity. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_technologies_practices_processes\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePublicactivity_technologies_practices_processes_ogcr","parameters":[{"name":"activitytechnologiespracticesprocessesid","in":"path","description":"The ACTIVITYTECHNOLOGIESPRACTICESPROCESSESID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_technologies_practices_processes":{"type":"object","properties":{"activity_technologies_practices_processes_id":{"type":"string"},"activity_id":{"type":"string"},"technologies_practices_processes_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"activity_technologies_practices_processes":{"activity_technologies_practices_processes_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","technologies_practices_processes_id":"NO_TILL"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/public/certification-on-chain":{"get":{"tags":["_Certification_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public certification_on_chain List","description":"<p>Get Public certification_on_chain List.</p>\n<p>Cache of CertificationNFT data minted on the OGCR chain (chain id 20253). One record per certificate_of_compliance_id (a re-certification is a new certificate and a new record), populated by OGCR-chain-cache reading the chain.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_hash: activity_hash stored on-chain: keccak256 of the raw activity entity body.</li>\n<li>activity_id: activity_id of the certified activity as stored on-chain.</li>\n<li>activity_name: Activity name as stored on-chain.</li>\n<li>activity_nft_id: ActivityNFT token id this certification references (stored on-chain).</li>\n<li>activity_uri: activity_uri stored on-chain: link back to the OBP activity entity.</li>\n<li>audit_report_hash: audit_report_hash stored on-chain: keccak256 of the raw audit_report entity body.</li>\n<li>audit_report_uri: audit_report_uri stored on-chain: link back to the OBP audit_report entity.</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: carbon_farming_net_soil_emission_reduction_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>carbon_farming_temporary_net_carbon_removal_benefit: carbon_farming_temporary_net_carbon_removal_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>carbon_removals_under_baseline: carbon_removals_under_baseline as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: carbon_storage_temporary_net_carbon_removal_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>certificate_of_compliance_hash: certificate_of_compliance_hash stored on-chain: keccak256 of the raw certificate_of_compliance entity body.</li>\n<li>certificate_of_compliance_id: Links to the <code>certificate_of_compliance</code> dynamic entity. The on-chain CertificationNFT is keyed by this id.</li>\n<li>certificate_of_compliance_uri: certificate_of_compliance_uri stored on-chain: link back to the OBP certificate_of_compliance entity.</li>\n<li>certification_body_hash: certification_body_hash stored on-chain: keccak256 of the raw certification_body entity body.</li>\n<li>certification_body_name: Certification body name as stored on-chain.</li>\n<li>certification_body_uri: certification_body_uri stored on-chain: link back to the OBP certification_body entity.</li>\n<li>certification_scheme_hash: certification_scheme_hash stored on-chain: keccak256 of the raw certification_scheme entity body.</li>\n<li>certification_scheme_name: Certification scheme name as stored on-chain.</li>\n<li>certification_scheme_uri: certification_scheme_uri stored on-chain: link back to the OBP certification_scheme entity.</li>\n<li>certification_status: Certification status as stored on-chain.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: CertificationNFT contract address the token was read from.</li>\n<li>country_id: Country id as stored on-chain.</li>\n<li>expiry_date: Certification expiry date as stored on-chain.</li>\n<li>issue_date: Certification issue date as stored on-chain.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>permanent_net_carbon_removal_benefit: permanent_net_carbon_removal_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>soil_emissions_under_baseline: soil_emissions_under_baseline as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>token_id: CertificationNFT token id minted for this certificate.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>tx_hash: Mint transaction hash (from the CertificationMinted event).</li>\n<li>unit_types: Unit types of the certificate as stored on-chain.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p><em>(no fields on this entity are declared <code>indexed</code>, so only the legacy bare-parameter filter below is available.)</em></p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPubliccertification_on_chainList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_on_chain_list":{"type":"array","items":{"type":"object","properties":{"certification_on_chain":{"type":"object","properties":{"certification_on_chain_id":{"type":"string"},"activity_uri":{"type":"string"},"carbon_removals_under_baseline":{"type":"string"},"audit_report_hash":{"type":"string"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"string"},"certification_scheme_uri":{"type":"string"},"block_number":{"type":"integer"},"certification_body_name":{"type":"string"},"certification_body_uri":{"type":"string"},"token_uri":{"type":"string"},"certificate_of_compliance_hash":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"string"},"activity_nft_id":{"type":"integer"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"certificate_of_compliance_uri":{"type":"string"},"audit_report_uri":{"type":"string"},"certification_scheme_hash":{"type":"string"},"token_id":{"type":"integer"},"activity_name":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"string"},"unit_types":{"type":"string"},"activity_hash":{"type":"string"},"contract_address":{"type":"string"},"certification_status":{"type":"string"},"certification_scheme_name":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"string"},"permanent_net_carbon_removal_benefit":{"type":"string"},"country_id":{"type":"string"},"certification_body_hash":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"certification_on_chain_list":[{"certification_on_chain":{"certification_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_name":"Reforestation 2024","activity_nft_id":1,"activity_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/activity/activity_AB12CD34EF","audit_report_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","audit_report_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/audit_report/audit_report_01","block_number":12345,"carbon_farming_net_soil_emission_reduction_benefit":"10.5","carbon_farming_temporary_net_carbon_removal_benefit":"10.5","carbon_removals_under_baseline":"10.5","carbon_storage_temporary_net_carbon_removal_benefit":"10.5","certificate_of_compliance_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certificate_of_compliance_id":"coc_AB12CD34EF","certificate_of_compliance_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certificate_of_compliance/coc_AB12CD34EF","certification_body_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_body_name":"Example Certification Body","certification_body_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certification_body/body_VERRA","certification_scheme_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_scheme_name":"Example Certification Scheme","certification_scheme_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certification_scheme/scheme_SALUS","certification_status":"certified","chain_id":20253,"contract_address":"0x2e335F247E91caa168c64b63104C4475b2af3942","country_id":"DK","expiry_date":"2029-06-01","issue_date":"2024-06-01","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","permanent_net_carbon_removal_benefit":"10.5","soil_emissions_under_baseline":"10.5","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQ2VydCJ9","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_types":"Permanent Removal"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/registry/activity-practices-query":{"get":{"tags":["OGCR-Registry"],"summary":"Get the practices of OGCR registry activities","description":"<p>User Authentication is Optional. The User need not be logged in.</p>\n<p><strong>JSON response body fields:</strong></p>\n","operationId":"OBPv4.0.0-getRegistryActivityPracticesQuery_618069902","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"practices":{"type":"array","items":{"type":"object","properties":{}}},"count":{"type":"integer"}}},"example":{"practices":[{}],"count":1}}}},"500":{"description":"Internal Server Error"}}}},"/user-operator-relationship":{"get":{"tags":["_User_operator_relationship(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get user_operator_relationship List","description":"<p>Get user_operator_relationship List.</p>\n<p>Describes the relationship between a User (the logged in User via OAuth2/OIDC or a Consent) and the Operator. This intersecting entity allows a many to many relationship between Users and Operators. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>user_id: (Authenticated) User</li>\n<li>operator_id: the operator (uu)id</li>\n<li>relationship_to_operator: relationship describes the user's relationship to the operator: the user is the subject, the operator is the  object</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"user_operator_relationship\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p><em>(no fields on this entity are declared <code>indexed</code>, so only the legacy bare-parameter filter below is available.)</em></p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getuser_operator_relationshipList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"user_operator_relationship_list":{"type":"array","items":{"type":"object","properties":{"user_operator_relationship":{"type":"object","properties":{"user_operator_relationship_id":{"type":"string"},"user_id":{"type":"string"},"operator_id":{"type":"string"},"relationship_to_operator":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"user_operator_relationship_list":[{"user_operator_relationship":{"user_operator_relationship_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","operator_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_operator":"Managing Director, Employee, Accountant"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_User_operator_relationship(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new user_operator_relationship","description":"<p>Create new user_operator_relationship.</p>\n<p>Describes the relationship between a User (the logged in User via OAuth2/OIDC or a Consent) and the Operator. This intersecting entity allows a many to many relationship between Users and Operators. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>user_id: (Authenticated) User</li>\n<li>operator_id: the operator (uu)id</li>\n<li>relationship_to_operator: relationship describes the user's relationship to the operator: the user is the subject, the operator is the  object</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"user_operator_relationship\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createuser_operator_relationship_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string"},"operator_id":{"type":"string"},"relationship_to_operator":{"type":"string"}}},"example":{"user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","operator_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_operator":"Managing Director, Employee, Accountant"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"user_operator_relationship":{"type":"object","properties":{"user_operator_relationship_id":{"type":"string"},"user_id":{"type":"string"},"operator_id":{"type":"string"},"relationship_to_operator":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"user_operator_relationship":{"user_operator_relationship_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","operator_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_operator":"Managing Director, Employee, Accountant"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/activity-on-chain":{"get":{"tags":["_Activity_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get activity_on_chain List","description":"<p>Get activity_on_chain List.</p>\n<p>Cache of ActivityNFT data minted on the OGCR chain (chain id 20253). One record per activity_id, populated by OGCR-chain-cache reading the chain.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_hash: activity_hash stored on-chain: keccak256 of the raw activity entity body.</li>\n<li>activity_id: The <code>activity</code> this NFT was minted for (a reference, so OBP joins activity -&gt; activity_on_chain, e.g. in the registry query). OBP refuses a record whose activity is not in this space.</li>\n<li>activity_type: Activity type as stored on-chain.</li>\n<li>activity_url: activity_url stored on-chain: link back to the OBP activity entity.</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>certification_scheme_id: certification_scheme_id as stored on-chain.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>city: City as stored on-chain.</li>\n<li>contract_address: ActivityNFT contract address the token was read from.</li>\n<li>country_id: Country id as stored on-chain.</li>\n<li>end_date: Activity end date as stored on-chain.</li>\n<li>minted_at: Unix time (seconds) of the block the mint was included in.</li>\n<li>name: Activity name as stored on-chain.</li>\n<li>operator_id: operator_id stored on-chain (owning operator).</li>\n<li>operator_name: Operator legal name (operator.legal_name) as stored on-chain.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>parcel_ids: Parcels linked to the activity at mint time: the contract's parcel_ids[] joined with commas, as tokenURI renders it.</li>\n<li>start_date: Activity start date as stored on-chain.</li>\n<li>summary: Activity summary as stored on-chain.</li>\n<li>token_id: ActivityNFT token id minted for this activity.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>tx_hash: Mint transaction hash (from the ActivityMinted event).</li>\n<li>unit_types: Unit types of the activity as stored on-chain.</li>\n<li>website: Activity website as stored on-chain.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>minted_at</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>activity_id</code> → <code>activity</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getactivity_on_chainList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_on_chain_list":{"type":"array","items":{"type":"object","properties":{"activity_on_chain":{"type":"object","properties":{"name":{"type":"string"},"token_uri":{"type":"string"},"activity_on_chain_id":{"type":"string"},"tx_hash":{"type":"string"},"activity_type":{"type":"string"},"owner_address":{"type":"string"},"activity_url":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"integer"},"block_number":{"type":"integer"},"contract_address":{"type":"string"},"country_id":{"type":"string"},"summary":{"type":"string"},"chain_id":{"type":"integer"},"website":{"type":"string"},"city":{"type":"string"},"operator_name":{"type":"string"},"start_date":{"type":"string"},"minted_at":{"type":"integer"},"certification_scheme_id":{"type":"string"},"parcel_ids":{"type":"string"},"end_date":{"type":"string"},"unit_types":{"type":"string"},"activity_hash":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"activity_on_chain_list":[{"activity_on_chain":{"activity_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_type":"carbon_farming","activity_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/activity/activity_AB12CD34EF","block_number":12345,"certification_scheme_id":"scheme_SALUS","chain_id":20253,"city":"Viborg","contract_address":"0x5034F49b27353CeDc562b49eA91C7438Ea351d36","country_id":"DK","end_date":"2024-12-31","minted_at":1779280448,"name":"Reforestation 2024","operator_id":"operator_9XYZ","operator_name":"Example Operator GmbH","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","parcel_ids":"parcel_01,parcel_02","start_date":"2024-01-01","summary":"Rewetting of drained peat soils.","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQWN0aXZpdHkifQ==","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_types":"Permanent Removal","website":"https://example.org"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Activity_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new activity_on_chain","description":"<p>Create new activity_on_chain.</p>\n<p>Cache of ActivityNFT data minted on the OGCR chain (chain id 20253). One record per activity_id, populated by OGCR-chain-cache reading the chain.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_hash: activity_hash stored on-chain: keccak256 of the raw activity entity body.</li>\n<li>activity_id: The <code>activity</code> this NFT was minted for (a reference, so OBP joins activity -&gt; activity_on_chain, e.g. in the registry query). OBP refuses a record whose activity is not in this space.</li>\n<li>activity_type: Activity type as stored on-chain.</li>\n<li>activity_url: activity_url stored on-chain: link back to the OBP activity entity.</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>certification_scheme_id: certification_scheme_id as stored on-chain.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>city: City as stored on-chain.</li>\n<li>contract_address: ActivityNFT contract address the token was read from.</li>\n<li>country_id: Country id as stored on-chain.</li>\n<li>end_date: Activity end date as stored on-chain.</li>\n<li>minted_at: Unix time (seconds) of the block the mint was included in.</li>\n<li>name: Activity name as stored on-chain.</li>\n<li>operator_id: operator_id stored on-chain (owning operator).</li>\n<li>operator_name: Operator legal name (operator.legal_name) as stored on-chain.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>parcel_ids: Parcels linked to the activity at mint time: the contract's parcel_ids[] joined with commas, as tokenURI renders it.</li>\n<li>start_date: Activity start date as stored on-chain.</li>\n<li>summary: Activity summary as stored on-chain.</li>\n<li>token_id: ActivityNFT token id minted for this activity.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>tx_hash: Mint transaction hash (from the ActivityMinted event).</li>\n<li>unit_types: Unit types of the activity as stored on-chain.</li>\n<li>website: Activity website as stored on-chain.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createactivity_on_chain_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"activity_type":{"type":"string"},"owner_address":{"type":"string"},"activity_url":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"integer"},"block_number":{"type":"integer"},"contract_address":{"type":"string"},"country_id":{"type":"string"},"summary":{"type":"string"},"chain_id":{"type":"integer"},"website":{"type":"string"},"city":{"type":"string"},"operator_name":{"type":"string"},"start_date":{"type":"string"},"minted_at":{"type":"integer"},"certification_scheme_id":{"type":"string"},"parcel_ids":{"type":"string"},"end_date":{"type":"string"},"unit_types":{"type":"string"},"activity_hash":{"type":"string"}}},"example":{"activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_type":"carbon_farming","activity_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/activity/activity_AB12CD34EF","block_number":12345,"certification_scheme_id":"scheme_SALUS","chain_id":20253,"city":"Viborg","contract_address":"0x5034F49b27353CeDc562b49eA91C7438Ea351d36","country_id":"DK","end_date":"2024-12-31","minted_at":1779280448,"name":"Reforestation 2024","operator_id":"operator_9XYZ","operator_name":"Example Operator GmbH","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","parcel_ids":"parcel_01,parcel_02","start_date":"2024-01-01","summary":"Rewetting of drained peat soils.","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQWN0aXZpdHkifQ==","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_types":"Permanent Removal","website":"https://example.org"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_on_chain":{"type":"object","properties":{"name":{"type":"string"},"token_uri":{"type":"string"},"activity_on_chain_id":{"type":"string"},"tx_hash":{"type":"string"},"activity_type":{"type":"string"},"owner_address":{"type":"string"},"activity_url":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"integer"},"block_number":{"type":"integer"},"contract_address":{"type":"string"},"country_id":{"type":"string"},"summary":{"type":"string"},"chain_id":{"type":"integer"},"website":{"type":"string"},"city":{"type":"string"},"operator_name":{"type":"string"},"start_date":{"type":"string"},"minted_at":{"type":"integer"},"certification_scheme_id":{"type":"string"},"parcel_ids":{"type":"string"},"end_date":{"type":"string"},"unit_types":{"type":"string"},"activity_hash":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_on_chain":{"activity_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_type":"carbon_farming","activity_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/activity/activity_AB12CD34EF","block_number":12345,"certification_scheme_id":"scheme_SALUS","chain_id":20253,"city":"Viborg","contract_address":"0x5034F49b27353CeDc562b49eA91C7438Ea351d36","country_id":"DK","end_date":"2024-12-31","minted_at":1779280448,"name":"Reforestation 2024","operator_id":"operator_9XYZ","operator_name":"Example Operator GmbH","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","parcel_ids":"parcel_01,parcel_02","start_date":"2024-01-01","summary":"Rewetting of drained peat soils.","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQWN0aXZpdHkifQ==","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_types":"Permanent Removal","website":"https://example.org"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/certification-on-chain/{certificationonchainid}":{"get":{"tags":["_Certification_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public certification_on_chain by id","description":"<p>Get Public certification_on_chain by id.</p>\n<p>Cache of CertificationNFT data minted on the OGCR chain (chain id 20253). One record per certificate_of_compliance_id (a re-certification is a new certificate and a new record), populated by OGCR-chain-cache reading the chain.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_hash: activity_hash stored on-chain: keccak256 of the raw activity entity body.</li>\n<li>activity_id: activity_id of the certified activity as stored on-chain.</li>\n<li>activity_name: Activity name as stored on-chain.</li>\n<li>activity_nft_id: ActivityNFT token id this certification references (stored on-chain).</li>\n<li>activity_uri: activity_uri stored on-chain: link back to the OBP activity entity.</li>\n<li>audit_report_hash: audit_report_hash stored on-chain: keccak256 of the raw audit_report entity body.</li>\n<li>audit_report_uri: audit_report_uri stored on-chain: link back to the OBP audit_report entity.</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: carbon_farming_net_soil_emission_reduction_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>carbon_farming_temporary_net_carbon_removal_benefit: carbon_farming_temporary_net_carbon_removal_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>carbon_removals_under_baseline: carbon_removals_under_baseline as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: carbon_storage_temporary_net_carbon_removal_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>certificate_of_compliance_hash: certificate_of_compliance_hash stored on-chain: keccak256 of the raw certificate_of_compliance entity body.</li>\n<li>certificate_of_compliance_id: Links to the <code>certificate_of_compliance</code> dynamic entity. The on-chain CertificationNFT is keyed by this id.</li>\n<li>certificate_of_compliance_uri: certificate_of_compliance_uri stored on-chain: link back to the OBP certificate_of_compliance entity.</li>\n<li>certification_body_hash: certification_body_hash stored on-chain: keccak256 of the raw certification_body entity body.</li>\n<li>certification_body_name: Certification body name as stored on-chain.</li>\n<li>certification_body_uri: certification_body_uri stored on-chain: link back to the OBP certification_body entity.</li>\n<li>certification_scheme_hash: certification_scheme_hash stored on-chain: keccak256 of the raw certification_scheme entity body.</li>\n<li>certification_scheme_name: Certification scheme name as stored on-chain.</li>\n<li>certification_scheme_uri: certification_scheme_uri stored on-chain: link back to the OBP certification_scheme entity.</li>\n<li>certification_status: Certification status as stored on-chain.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: CertificationNFT contract address the token was read from.</li>\n<li>country_id: Country id as stored on-chain.</li>\n<li>expiry_date: Certification expiry date as stored on-chain.</li>\n<li>issue_date: Certification issue date as stored on-chain.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>permanent_net_carbon_removal_benefit: permanent_net_carbon_removal_benefit as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>soil_emissions_under_baseline: soil_emissions_under_baseline as recorded on the certificate: a decimal string in tonnes CO2e. Empty when the certificate carries no value.</li>\n<li>token_id: CertificationNFT token id minted for this certificate.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>tx_hash: Mint transaction hash (from the CertificationMinted event).</li>\n<li>unit_types: Unit types of the certificate as stored on-chain.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePubliccertification_on_chain_ogcr","parameters":[{"name":"certificationonchainid","in":"path","description":"The CERTIFICATIONONCHAINID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_on_chain":{"type":"object","properties":{"certification_on_chain_id":{"type":"string"},"activity_uri":{"type":"string"},"carbon_removals_under_baseline":{"type":"string"},"audit_report_hash":{"type":"string"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"string"},"certification_scheme_uri":{"type":"string"},"block_number":{"type":"integer"},"certification_body_name":{"type":"string"},"certification_body_uri":{"type":"string"},"token_uri":{"type":"string"},"certificate_of_compliance_hash":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"string"},"activity_nft_id":{"type":"integer"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"certificate_of_compliance_uri":{"type":"string"},"audit_report_uri":{"type":"string"},"certification_scheme_hash":{"type":"string"},"token_id":{"type":"integer"},"activity_name":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"string"},"unit_types":{"type":"string"},"activity_hash":{"type":"string"},"contract_address":{"type":"string"},"certification_status":{"type":"string"},"certification_scheme_name":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"string"},"permanent_net_carbon_removal_benefit":{"type":"string"},"country_id":{"type":"string"},"certification_body_hash":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"certification_on_chain":{"certification_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_name":"Reforestation 2024","activity_nft_id":1,"activity_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/activity/activity_AB12CD34EF","audit_report_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","audit_report_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/audit_report/audit_report_01","block_number":12345,"carbon_farming_net_soil_emission_reduction_benefit":"10.5","carbon_farming_temporary_net_carbon_removal_benefit":"10.5","carbon_removals_under_baseline":"10.5","carbon_storage_temporary_net_carbon_removal_benefit":"10.5","certificate_of_compliance_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certificate_of_compliance_id":"coc_AB12CD34EF","certificate_of_compliance_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certificate_of_compliance/coc_AB12CD34EF","certification_body_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_body_name":"Example Certification Body","certification_body_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certification_body/body_VERRA","certification_scheme_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_scheme_name":"Example Certification Scheme","certification_scheme_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certification_scheme/scheme_SALUS","certification_status":"certified","chain_id":20253,"contract_address":"0x2e335F247E91caa168c64b63104C4475b2af3942","country_id":"DK","expiry_date":"2029-06-01","issue_date":"2024-06-01","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","permanent_net_carbon_removal_benefit":"10.5","soil_emissions_under_baseline":"10.5","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQ2VydCJ9","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_types":"Permanent Removal"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/user-certification-scheme-relationship/{usercertificationschemerelationshipid}":{"get":{"tags":["_User_certification_scheme_relationship(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get user_certification_scheme_relationship by id","description":"<p>Get user_certification_scheme_relationship by id.</p>\n<p>Describes the relationship between a User (the logged in User via OAuth2/OIDC or a Consent) and the Certification Scheme. This intersecting entity allows a many to many relationship between Users and Certification Scheme. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>user_id: (Authenticated) User</li>\n<li>certification_scheme_id: the certification scheme (uu)id</li>\n<li>relationship_to_certification_scheme: relationship describes the user's relationship to the certification scheme: the user is the subject, the certification body is the  object</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"user_certification_scheme_relationship\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleuser_certification_scheme_relationship_ogcr","parameters":[{"name":"usercertificationschemerelationshipid","in":"path","description":"The USERCERTIFICATIONSCHEMERELATIONSHIPID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"user_certification_scheme_relationship":{"type":"object","properties":{"user_certification_scheme_relationship_id":{"type":"string"},"user_id":{"type":"string"},"certification_scheme_id":{"type":"string"},"relationship_to_certification_scheme":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"user_certification_scheme_relationship":{"user_certification_scheme_relationship_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_scheme_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_certification_scheme":"Managing Director, Employee, Accountant"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_User_certification_scheme_relationship(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update user_certification_scheme_relationship","description":"<p>Update user_certification_scheme_relationship.</p>\n<p>Describes the relationship between a User (the logged in User via OAuth2/OIDC or a Consent) and the Certification Scheme. This intersecting entity allows a many to many relationship between Users and Certification Scheme. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>user_id: (Authenticated) User</li>\n<li>certification_scheme_id: the certification scheme (uu)id</li>\n<li>relationship_to_certification_scheme: relationship describes the user's relationship to the certification scheme: the user is the subject, the certification body is the  object</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"user_certification_scheme_relationship\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateuser_certification_scheme_relationship_ogcr","parameters":[{"name":"usercertificationschemerelationshipid","in":"path","description":"The USERCERTIFICATIONSCHEMERELATIONSHIPID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string"},"certification_scheme_id":{"type":"string"},"relationship_to_certification_scheme":{"type":"string"}}},"example":{"user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_scheme_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_certification_scheme":"Managing Director, Employee, Accountant"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"user_certification_scheme_relationship":{"type":"object","properties":{"user_certification_scheme_relationship_id":{"type":"string"},"user_id":{"type":"string"},"certification_scheme_id":{"type":"string"},"relationship_to_certification_scheme":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"user_certification_scheme_relationship":{"user_certification_scheme_relationship_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_scheme_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_certification_scheme":"Managing Director, Employee, Accountant"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_User_certification_scheme_relationship(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete user_certification_scheme_relationship by id","description":"<p>Delete user_certification_scheme_relationship by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"user_certification_scheme_relationship\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteuser_certification_scheme_relationship_ogcr","parameters":[{"name":"usercertificationschemerelationshipid","in":"path","description":"The USERCERTIFICATIONSCHEMERELATIONSHIPID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"user_certification_scheme_relationship":{"type":"object","properties":{"user_certification_scheme_relationship_id":{"type":"string"},"user_id":{"type":"string"},"certification_scheme_id":{"type":"string"},"relationship_to_certification_scheme":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"user_certification_scheme_relationship":{"user_certification_scheme_relationship_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_scheme_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_certification_scheme":"Managing Director, Employee, Accountant"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_User_certification_scheme_relationship(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update user_certification_scheme_relationship","description":"<p>Partially update user_certification_scheme_relationship: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Describes the relationship between a User (the logged in User via OAuth2/OIDC or a Consent) and the Certification Scheme. This intersecting entity allows a many to many relationship between Users and Certification Scheme. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>user_id: (Authenticated) User</li>\n<li>certification_scheme_id: the certification scheme (uu)id</li>\n<li>relationship_to_certification_scheme: relationship describes the user's relationship to the certification scheme: the user is the subject, the certification body is the  object</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"user_certification_scheme_relationship\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchuser_certification_scheme_relationship_ogcr","parameters":[{"name":"usercertificationschemerelationshipid","in":"path","description":"The USERCERTIFICATIONSCHEMERELATIONSHIPID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string"},"certification_scheme_id":{"type":"string"},"relationship_to_certification_scheme":{"type":"string"}}},"example":{"user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_scheme_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_certification_scheme":"Managing Director, Employee, Accountant"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"user_certification_scheme_relationship":{"type":"object","properties":{"user_certification_scheme_relationship_id":{"type":"string"},"user_id":{"type":"string"},"certification_scheme_id":{"type":"string"},"relationship_to_certification_scheme":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"user_certification_scheme_relationship":{"user_certification_scheme_relationship_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_scheme_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_certification_scheme":"Managing Director, Employee, Accountant"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/activity-plan/{activityplanid}":{"get":{"tags":["_Activity_plan(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get activity_plan by id","description":"<p>Get activity_plan by id.</p>\n<p>Parsed entity activity_plan. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_plan_id: Internal identifier for the activity plan entity. This is set by the operator platform.</li>\n<li>activity_id: Internal identifier for the activity entity</li>\n<li>date_submitted: Date the activity plan is submitted</li>\n<li>activity_eligibility: Eligibility for certification under Regulation (EU) 2024/3012</li>\n<li>legal_parcel_ownership: Legal ownership</li>\n<li>coordinate_reference_system: Coordinate Reference System (CRS) identifier that defines how to interpret the geometry coordinates (e.g., EPSG:4326 for WGS84).</li>\n<li>iacs_codes: Array of identifiers referencing the parcel in the Member State\u2019s IACS (Integrated Administration and Control System). Only if applicable.</li>\n<li>lpis_codes: Identifiers from the Land Parcel Identification System (LPIS) that reference official \u201creference parcels\u201d/land blocks.  Only if applicable.</li>\n<li>article_8_1_information: Information listed in Article 8(1) of Regulation (EU) 2024/3012</li>\n<li>methodology_quantification_baseline: Quantification, incl. calculation of activity baseline (if applicable)</li>\n<li>methodology_additionality_funding_sources: Additionality, incl. funding sources</li>\n<li>methodology_long_term_storage: Long-term storage</li>\n<li>methodology_sustainability: Sustainability</li>\n<li>expected_total_carbon_removals: Expected total carbon removals associated to the activity (in CO2e Tonnes)</li>\n<li>expected_total_soil_emissions: Expected total total soil emissions associated to the activity (in CO2e Tonnes)</li>\n<li>expected_total_ghg_emissions_associated: Expected total GHG emissions associated to the activity (in CO2e Tonnes)</li>\n<li>expected_net_benefit: Expected net carbon removal benefit or expected net soil emission reduction benefit (in CO2e Tonnes)</li>\n<li>group_advisory_services_description: For group of operators: how advisory services are provided</li>\n<li>group_internal_control_system_description: For group carbon farming: internal control system description</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_plan\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleactivity_plan_ogcr","parameters":[{"name":"activityplanid","in":"path","description":"The ACTIVITYPLANID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_plan":{"type":"object","properties":{"expected_total_carbon_removals":{"type":"integer"},"activity_plan_id":{"type":"string"},"iacs_codes":{"type":"string"},"expected_total_soil_emissions":{"type":"integer"},"methodology_long_term_storage":{"type":"string"},"article_8_1_information":{"type":"string"},"coordinate_reference_system":{"type":"string"},"methodology_sustainability":{"type":"string"},"expected_net_benefit":{"type":"integer"},"activity_id":{"type":"string"},"methodology_quantification_baseline":{"type":"string"},"group_advisory_services_description":{"type":"string"},"lpis_codes":{"type":"string"},"activity_eligibility":{"type":"string"},"methodology_additionality_funding_sources":{"type":"string"},"group_internal_control_system_description":{"type":"string"},"date_submitted":{"type":"string"},"legal_parcel_ownership":{"type":"string"},"expected_total_ghg_emissions_associated":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_plan":{"activity_plan_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_plan_id":"ap-1037502-192zf129r3","activity_id":"a_05OFWI037022","date_submitted":"2026-11-20","activity_eligibility":"Eligible: carbon farming activity on mineral agricultural soils, meets Articles 4 to 7 of Regulation (EU) 2024/3012","legal_parcel_ownership":"pov_01HZZ2M4N8Q1R5S7T9V3","coordinate_reference_system":"EPSG:4326","iacs_codes":"DE-BB-IACS-2026-0012345678","lpis_codes":"DE-BB-LPIS-REFPARCEL-0098765432","article_8_1_information":"Delegated act applied: certification methodology adopted under Article 8","methodology_quantification_baseline":"Standardised baseline for mineral soils; total removals calculated per methodology, uncertainties accounted for conservatively","methodology_additionality_funding_sources":"Standardised baseline used, so additionality is deemed met. Funding: own funds and a national agri-environment scheme","methodology_long_term_storage":"Carbon stored in soil organic matter over a 5-year monitoring period; reversal risk covered by a collective buffer","methodology_sustainability":"Do no significant harm assessment passed; co-benefits for biodiversity and soil health","expected_total_carbon_removals":6,"expected_total_soil_emissions":6,"expected_total_ghg_emissions_associated":6,"expected_net_benefit":6,"group_advisory_services_description":"Regional farm advisory service advises small-scale members, 2 visits per year","group_internal_control_system_description":"Group manager audits a 10% sample of members each year and keeps a central register of practices"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Activity_plan(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update activity_plan","description":"<p>Update activity_plan.</p>\n<p>Parsed entity activity_plan. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_plan_id: Internal identifier for the activity plan entity. This is set by the operator platform.</li>\n<li>activity_id: Internal identifier for the activity entity</li>\n<li>date_submitted: Date the activity plan is submitted</li>\n<li>activity_eligibility: Eligibility for certification under Regulation (EU) 2024/3012</li>\n<li>legal_parcel_ownership: Legal ownership</li>\n<li>coordinate_reference_system: Coordinate Reference System (CRS) identifier that defines how to interpret the geometry coordinates (e.g., EPSG:4326 for WGS84).</li>\n<li>iacs_codes: Array of identifiers referencing the parcel in the Member State\u2019s IACS (Integrated Administration and Control System). Only if applicable.</li>\n<li>lpis_codes: Identifiers from the Land Parcel Identification System (LPIS) that reference official \u201creference parcels\u201d/land blocks.  Only if applicable.</li>\n<li>article_8_1_information: Information listed in Article 8(1) of Regulation (EU) 2024/3012</li>\n<li>methodology_quantification_baseline: Quantification, incl. calculation of activity baseline (if applicable)</li>\n<li>methodology_additionality_funding_sources: Additionality, incl. funding sources</li>\n<li>methodology_long_term_storage: Long-term storage</li>\n<li>methodology_sustainability: Sustainability</li>\n<li>expected_total_carbon_removals: Expected total carbon removals associated to the activity (in CO2e Tonnes)</li>\n<li>expected_total_soil_emissions: Expected total total soil emissions associated to the activity (in CO2e Tonnes)</li>\n<li>expected_total_ghg_emissions_associated: Expected total GHG emissions associated to the activity (in CO2e Tonnes)</li>\n<li>expected_net_benefit: Expected net carbon removal benefit or expected net soil emission reduction benefit (in CO2e Tonnes)</li>\n<li>group_advisory_services_description: For group of operators: how advisory services are provided</li>\n<li>group_internal_control_system_description: For group carbon farming: internal control system description</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_plan\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateactivity_plan_ogcr","parameters":[{"name":"activityplanid","in":"path","description":"The ACTIVITYPLANID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"expected_total_carbon_removals":{"type":"integer"},"activity_plan_id":{"type":"string"},"iacs_codes":{"type":"string"},"expected_total_soil_emissions":{"type":"integer"},"methodology_long_term_storage":{"type":"string"},"article_8_1_information":{"type":"string"},"coordinate_reference_system":{"type":"string"},"methodology_sustainability":{"type":"string"},"expected_net_benefit":{"type":"integer"},"activity_id":{"type":"string"},"methodology_quantification_baseline":{"type":"string"},"group_advisory_services_description":{"type":"string"},"lpis_codes":{"type":"string"},"activity_eligibility":{"type":"string"},"methodology_additionality_funding_sources":{"type":"string"},"group_internal_control_system_description":{"type":"string"},"date_submitted":{"type":"string"},"legal_parcel_ownership":{"type":"string"},"expected_total_ghg_emissions_associated":{"type":"integer"}}},"example":{"activity_plan_id":"ap-1037502-192zf129r3","activity_id":"a_05OFWI037022","date_submitted":"2026-11-20","activity_eligibility":"Eligible: carbon farming activity on mineral agricultural soils, meets Articles 4 to 7 of Regulation (EU) 2024/3012","legal_parcel_ownership":"pov_01HZZ2M4N8Q1R5S7T9V3","coordinate_reference_system":"EPSG:4326","iacs_codes":"DE-BB-IACS-2026-0012345678","lpis_codes":"DE-BB-LPIS-REFPARCEL-0098765432","article_8_1_information":"Delegated act applied: certification methodology adopted under Article 8","methodology_quantification_baseline":"Standardised baseline for mineral soils; total removals calculated per methodology, uncertainties accounted for conservatively","methodology_additionality_funding_sources":"Standardised baseline used, so additionality is deemed met. Funding: own funds and a national agri-environment scheme","methodology_long_term_storage":"Carbon stored in soil organic matter over a 5-year monitoring period; reversal risk covered by a collective buffer","methodology_sustainability":"Do no significant harm assessment passed; co-benefits for biodiversity and soil health","expected_total_carbon_removals":6,"expected_total_soil_emissions":6,"expected_total_ghg_emissions_associated":6,"expected_net_benefit":6,"group_advisory_services_description":"Regional farm advisory service advises small-scale members, 2 visits per year","group_internal_control_system_description":"Group manager audits a 10% sample of members each year and keeps a central register of practices"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_plan":{"type":"object","properties":{"expected_total_carbon_removals":{"type":"integer"},"activity_plan_id":{"type":"string"},"iacs_codes":{"type":"string"},"expected_total_soil_emissions":{"type":"integer"},"methodology_long_term_storage":{"type":"string"},"article_8_1_information":{"type":"string"},"coordinate_reference_system":{"type":"string"},"methodology_sustainability":{"type":"string"},"expected_net_benefit":{"type":"integer"},"activity_id":{"type":"string"},"methodology_quantification_baseline":{"type":"string"},"group_advisory_services_description":{"type":"string"},"lpis_codes":{"type":"string"},"activity_eligibility":{"type":"string"},"methodology_additionality_funding_sources":{"type":"string"},"group_internal_control_system_description":{"type":"string"},"date_submitted":{"type":"string"},"legal_parcel_ownership":{"type":"string"},"expected_total_ghg_emissions_associated":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_plan":{"activity_plan_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_plan_id":"ap-1037502-192zf129r3","activity_id":"a_05OFWI037022","date_submitted":"2026-11-20","activity_eligibility":"Eligible: carbon farming activity on mineral agricultural soils, meets Articles 4 to 7 of Regulation (EU) 2024/3012","legal_parcel_ownership":"pov_01HZZ2M4N8Q1R5S7T9V3","coordinate_reference_system":"EPSG:4326","iacs_codes":"DE-BB-IACS-2026-0012345678","lpis_codes":"DE-BB-LPIS-REFPARCEL-0098765432","article_8_1_information":"Delegated act applied: certification methodology adopted under Article 8","methodology_quantification_baseline":"Standardised baseline for mineral soils; total removals calculated per methodology, uncertainties accounted for conservatively","methodology_additionality_funding_sources":"Standardised baseline used, so additionality is deemed met. Funding: own funds and a national agri-environment scheme","methodology_long_term_storage":"Carbon stored in soil organic matter over a 5-year monitoring period; reversal risk covered by a collective buffer","methodology_sustainability":"Do no significant harm assessment passed; co-benefits for biodiversity and soil health","expected_total_carbon_removals":6,"expected_total_soil_emissions":6,"expected_total_ghg_emissions_associated":6,"expected_net_benefit":6,"group_advisory_services_description":"Regional farm advisory service advises small-scale members, 2 visits per year","group_internal_control_system_description":"Group manager audits a 10% sample of members each year and keeps a central register of practices"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Activity_plan(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete activity_plan by id","description":"<p>Delete activity_plan by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_plan\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteactivity_plan_ogcr","parameters":[{"name":"activityplanid","in":"path","description":"The ACTIVITYPLANID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_plan":{"type":"object","properties":{"expected_total_carbon_removals":{"type":"integer"},"activity_plan_id":{"type":"string"},"iacs_codes":{"type":"string"},"expected_total_soil_emissions":{"type":"integer"},"methodology_long_term_storage":{"type":"string"},"article_8_1_information":{"type":"string"},"coordinate_reference_system":{"type":"string"},"methodology_sustainability":{"type":"string"},"expected_net_benefit":{"type":"integer"},"activity_id":{"type":"string"},"methodology_quantification_baseline":{"type":"string"},"group_advisory_services_description":{"type":"string"},"lpis_codes":{"type":"string"},"activity_eligibility":{"type":"string"},"methodology_additionality_funding_sources":{"type":"string"},"group_internal_control_system_description":{"type":"string"},"date_submitted":{"type":"string"},"legal_parcel_ownership":{"type":"string"},"expected_total_ghg_emissions_associated":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_plan":{"activity_plan_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_plan_id":"ap-1037502-192zf129r3","activity_id":"a_05OFWI037022","date_submitted":"2026-11-20","activity_eligibility":"Eligible: carbon farming activity on mineral agricultural soils, meets Articles 4 to 7 of Regulation (EU) 2024/3012","legal_parcel_ownership":"pov_01HZZ2M4N8Q1R5S7T9V3","coordinate_reference_system":"EPSG:4326","iacs_codes":"DE-BB-IACS-2026-0012345678","lpis_codes":"DE-BB-LPIS-REFPARCEL-0098765432","article_8_1_information":"Delegated act applied: certification methodology adopted under Article 8","methodology_quantification_baseline":"Standardised baseline for mineral soils; total removals calculated per methodology, uncertainties accounted for conservatively","methodology_additionality_funding_sources":"Standardised baseline used, so additionality is deemed met. Funding: own funds and a national agri-environment scheme","methodology_long_term_storage":"Carbon stored in soil organic matter over a 5-year monitoring period; reversal risk covered by a collective buffer","methodology_sustainability":"Do no significant harm assessment passed; co-benefits for biodiversity and soil health","expected_total_carbon_removals":6,"expected_total_soil_emissions":6,"expected_total_ghg_emissions_associated":6,"expected_net_benefit":6,"group_advisory_services_description":"Regional farm advisory service advises small-scale members, 2 visits per year","group_internal_control_system_description":"Group manager audits a 10% sample of members each year and keeps a central register of practices"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Activity_plan(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update activity_plan","description":"<p>Partially update activity_plan: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Parsed entity activity_plan. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_plan_id: Internal identifier for the activity plan entity. This is set by the operator platform.</li>\n<li>activity_id: Internal identifier for the activity entity</li>\n<li>date_submitted: Date the activity plan is submitted</li>\n<li>activity_eligibility: Eligibility for certification under Regulation (EU) 2024/3012</li>\n<li>legal_parcel_ownership: Legal ownership</li>\n<li>coordinate_reference_system: Coordinate Reference System (CRS) identifier that defines how to interpret the geometry coordinates (e.g., EPSG:4326 for WGS84).</li>\n<li>iacs_codes: Array of identifiers referencing the parcel in the Member State\u2019s IACS (Integrated Administration and Control System). Only if applicable.</li>\n<li>lpis_codes: Identifiers from the Land Parcel Identification System (LPIS) that reference official \u201creference parcels\u201d/land blocks.  Only if applicable.</li>\n<li>article_8_1_information: Information listed in Article 8(1) of Regulation (EU) 2024/3012</li>\n<li>methodology_quantification_baseline: Quantification, incl. calculation of activity baseline (if applicable)</li>\n<li>methodology_additionality_funding_sources: Additionality, incl. funding sources</li>\n<li>methodology_long_term_storage: Long-term storage</li>\n<li>methodology_sustainability: Sustainability</li>\n<li>expected_total_carbon_removals: Expected total carbon removals associated to the activity (in CO2e Tonnes)</li>\n<li>expected_total_soil_emissions: Expected total total soil emissions associated to the activity (in CO2e Tonnes)</li>\n<li>expected_total_ghg_emissions_associated: Expected total GHG emissions associated to the activity (in CO2e Tonnes)</li>\n<li>expected_net_benefit: Expected net carbon removal benefit or expected net soil emission reduction benefit (in CO2e Tonnes)</li>\n<li>group_advisory_services_description: For group of operators: how advisory services are provided</li>\n<li>group_internal_control_system_description: For group carbon farming: internal control system description</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_plan\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchactivity_plan_ogcr","parameters":[{"name":"activityplanid","in":"path","description":"The ACTIVITYPLANID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"expected_total_carbon_removals":{"type":"integer"},"activity_plan_id":{"type":"string"},"iacs_codes":{"type":"string"},"expected_total_soil_emissions":{"type":"integer"},"methodology_long_term_storage":{"type":"string"},"article_8_1_information":{"type":"string"},"coordinate_reference_system":{"type":"string"},"methodology_sustainability":{"type":"string"},"expected_net_benefit":{"type":"integer"},"activity_id":{"type":"string"},"methodology_quantification_baseline":{"type":"string"},"group_advisory_services_description":{"type":"string"},"lpis_codes":{"type":"string"},"activity_eligibility":{"type":"string"},"methodology_additionality_funding_sources":{"type":"string"},"group_internal_control_system_description":{"type":"string"},"date_submitted":{"type":"string"},"legal_parcel_ownership":{"type":"string"},"expected_total_ghg_emissions_associated":{"type":"integer"}}},"example":{"activity_plan_id":"ap-1037502-192zf129r3","activity_id":"a_05OFWI037022","date_submitted":"2026-11-20","activity_eligibility":"Eligible: carbon farming activity on mineral agricultural soils, meets Articles 4 to 7 of Regulation (EU) 2024/3012","legal_parcel_ownership":"pov_01HZZ2M4N8Q1R5S7T9V3","coordinate_reference_system":"EPSG:4326","iacs_codes":"DE-BB-IACS-2026-0012345678","lpis_codes":"DE-BB-LPIS-REFPARCEL-0098765432","article_8_1_information":"Delegated act applied: certification methodology adopted under Article 8","methodology_quantification_baseline":"Standardised baseline for mineral soils; total removals calculated per methodology, uncertainties accounted for conservatively","methodology_additionality_funding_sources":"Standardised baseline used, so additionality is deemed met. Funding: own funds and a national agri-environment scheme","methodology_long_term_storage":"Carbon stored in soil organic matter over a 5-year monitoring period; reversal risk covered by a collective buffer","methodology_sustainability":"Do no significant harm assessment passed; co-benefits for biodiversity and soil health","expected_total_carbon_removals":6,"expected_total_soil_emissions":6,"expected_total_ghg_emissions_associated":6,"expected_net_benefit":6,"group_advisory_services_description":"Regional farm advisory service advises small-scale members, 2 visits per year","group_internal_control_system_description":"Group manager audits a 10% sample of members each year and keeps a central register of practices"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_plan":{"type":"object","properties":{"expected_total_carbon_removals":{"type":"integer"},"activity_plan_id":{"type":"string"},"iacs_codes":{"type":"string"},"expected_total_soil_emissions":{"type":"integer"},"methodology_long_term_storage":{"type":"string"},"article_8_1_information":{"type":"string"},"coordinate_reference_system":{"type":"string"},"methodology_sustainability":{"type":"string"},"expected_net_benefit":{"type":"integer"},"activity_id":{"type":"string"},"methodology_quantification_baseline":{"type":"string"},"group_advisory_services_description":{"type":"string"},"lpis_codes":{"type":"string"},"activity_eligibility":{"type":"string"},"methodology_additionality_funding_sources":{"type":"string"},"group_internal_control_system_description":{"type":"string"},"date_submitted":{"type":"string"},"legal_parcel_ownership":{"type":"string"},"expected_total_ghg_emissions_associated":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_plan":{"activity_plan_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_plan_id":"ap-1037502-192zf129r3","activity_id":"a_05OFWI037022","date_submitted":"2026-11-20","activity_eligibility":"Eligible: carbon farming activity on mineral agricultural soils, meets Articles 4 to 7 of Regulation (EU) 2024/3012","legal_parcel_ownership":"pov_01HZZ2M4N8Q1R5S7T9V3","coordinate_reference_system":"EPSG:4326","iacs_codes":"DE-BB-IACS-2026-0012345678","lpis_codes":"DE-BB-LPIS-REFPARCEL-0098765432","article_8_1_information":"Delegated act applied: certification methodology adopted under Article 8","methodology_quantification_baseline":"Standardised baseline for mineral soils; total removals calculated per methodology, uncertainties accounted for conservatively","methodology_additionality_funding_sources":"Standardised baseline used, so additionality is deemed met. Funding: own funds and a national agri-environment scheme","methodology_long_term_storage":"Carbon stored in soil organic matter over a 5-year monitoring period; reversal risk covered by a collective buffer","methodology_sustainability":"Do no significant harm assessment passed; co-benefits for biodiversity and soil health","expected_total_carbon_removals":6,"expected_total_soil_emissions":6,"expected_total_ghg_emissions_associated":6,"expected_net_benefit":6,"group_advisory_services_description":"Regional farm advisory service advises small-scale members, 2 visits per year","group_internal_control_system_description":"Group manager audits a 10% sample of members each year and keeps a central register of practices"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/activity-verification/{activityverificationid}":{"get":{"tags":["_Activity_verification(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public activity_verification by id","description":"<p>Get Public activity_verification by id.</p>\n<p>This is the initial certification done by the certifier scheme and auditors. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>parcel_id: (uu)id of the parcel that gets verified</li>\n<li>activity_id: ID of the project this parcel belongs to</li>\n<li>status_code: in_progress, verified, failed</li>\n<li>status_message: further explanation of status code</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: expected amount of CO2e tonnes removed or reduced</li>\n<li>supporting_document_id: Supporting documents for activity verification</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_verification\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePublicactivity_verification_ogcr","parameters":[{"name":"activityverificationid","in":"path","description":"The ACTIVITYVERIFICATIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_verification":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"activity_verification_id":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"status_code":{"type":"string"},"activity_id":{"type":"string"},"status_message":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"parcel_id":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"activity_verification":{"activity_verification_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_verification_id":"string","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","activity_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","status_code":"verified","status_message":"could not find owner","permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":5.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"supporting_document_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/public/technologies-practices-processes/{technologiespracticesprocessesid}":{"get":{"tags":["_Technologies_practices_processes(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public technologies_practices_processes by id","description":"<p>Get Public technologies_practices_processes by id.</p>\n<p>This is the lookup table for technologies, practices and processes. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"technologies_practices_processes\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePublictechnologies_practices_processes_ogcr","parameters":[{"name":"technologiespracticesprocessesid","in":"path","description":"The TECHNOLOGIESPRACTICESPROCESSESID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"technologies_practices_processes":{"type":"object","properties":{"technologies_practices_processes_id":{"type":"string"},"practice_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"technologies_practices_processes":{"technologies_practices_processes_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","technologies_practices_processes_id":"string","practice_name":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/activity-technologies-practices-processes/{activitytechnologiespracticesprocessesid}":{"get":{"tags":["_Activity_technologies_practices_processes(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get activity_technologies_practices_processes by id","description":"<p>Get activity_technologies_practices_processes by id.</p>\n<p>This is the intersecting entity showing what technologies and practices are being carried out on a certain activity. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_technologies_practices_processes\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleactivity_technologies_practices_processes_ogcr","parameters":[{"name":"activitytechnologiespracticesprocessesid","in":"path","description":"The ACTIVITYTECHNOLOGIESPRACTICESPROCESSESID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_technologies_practices_processes":{"type":"object","properties":{"activity_technologies_practices_processes_id":{"type":"string"},"activity_id":{"type":"string"},"technologies_practices_processes_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_technologies_practices_processes":{"activity_technologies_practices_processes_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","technologies_practices_processes_id":"NO_TILL"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Activity_technologies_practices_processes(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update activity_technologies_practices_processes","description":"<p>Update activity_technologies_practices_processes.</p>\n<p>This is the intersecting entity showing what technologies and practices are being carried out on a certain activity. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_technologies_practices_processes\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateactivity_technologies_practices_processes_ogcr","parameters":[{"name":"activitytechnologiespracticesprocessesid","in":"path","description":"The ACTIVITYTECHNOLOGIESPRACTICESPROCESSESID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"activity_id":{"type":"string"},"technologies_practices_processes_id":{"type":"string"}}},"example":{"activity_id":"string","technologies_practices_processes_id":"NO_TILL"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_technologies_practices_processes":{"type":"object","properties":{"activity_technologies_practices_processes_id":{"type":"string"},"activity_id":{"type":"string"},"technologies_practices_processes_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_technologies_practices_processes":{"activity_technologies_practices_processes_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","technologies_practices_processes_id":"NO_TILL"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Activity_technologies_practices_processes(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete activity_technologies_practices_processes by id","description":"<p>Delete activity_technologies_practices_processes by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_technologies_practices_processes\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteactivity_technologies_practices_processes_ogcr","parameters":[{"name":"activitytechnologiespracticesprocessesid","in":"path","description":"The ACTIVITYTECHNOLOGIESPRACTICESPROCESSESID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_technologies_practices_processes":{"type":"object","properties":{"activity_technologies_practices_processes_id":{"type":"string"},"activity_id":{"type":"string"},"technologies_practices_processes_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_technologies_practices_processes":{"activity_technologies_practices_processes_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","technologies_practices_processes_id":"NO_TILL"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Activity_technologies_practices_processes(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update activity_technologies_practices_processes","description":"<p>Partially update activity_technologies_practices_processes: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>This is the intersecting entity showing what technologies and practices are being carried out on a certain activity. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_technologies_practices_processes\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchactivity_technologies_practices_processes_ogcr","parameters":[{"name":"activitytechnologiespracticesprocessesid","in":"path","description":"The ACTIVITYTECHNOLOGIESPRACTICESPROCESSESID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"activity_id":{"type":"string"},"technologies_practices_processes_id":{"type":"string"}}},"example":{"activity_id":"string","technologies_practices_processes_id":"NO_TILL"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_technologies_practices_processes":{"type":"object","properties":{"activity_technologies_practices_processes_id":{"type":"string"},"activity_id":{"type":"string"},"technologies_practices_processes_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_technologies_practices_processes":{"activity_technologies_practices_processes_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","technologies_practices_processes_id":"NO_TILL"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/registry/activity-sdgs-query":{"get":{"tags":["OGCR-Registry"],"summary":"Get the Sustainable Development Goals of OGCR registry activities","description":"<p>User Authentication is Optional. The User need not be logged in.</p>\n<p><strong>JSON response body fields:</strong></p>\n","operationId":"OBPv4.0.0-getRegistryActivitySdgsQuery_-1142796579","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"sdgs":{"type":"array","items":{"type":"object","properties":{}}},"count":{"type":"integer"}}},"example":{"sdgs":[{}],"count":1}}}},"500":{"description":"Internal Server Error"}}}},"/co-benefit/{cobenefitid}":{"get":{"tags":["_Co_benefit(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get co_benefit by id","description":"<p>Get co_benefit by id.</p>\n<p>Parsed entity co_benefit. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"co_benefit\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleco_benefit_ogcr","parameters":[{"name":"cobenefitid","in":"path","description":"The COBENEFITID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"co_benefit":{"type":"object","properties":{"co_benefit_id":{"type":"string"},"co_benefit_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"co_benefit":{"co_benefit_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","co_benefit_id":"string","co_benefit_name":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Co_benefit(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update co_benefit","description":"<p>Update co_benefit.</p>\n<p>Parsed entity co_benefit. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"co_benefit\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateco_benefit_ogcr","parameters":[{"name":"cobenefitid","in":"path","description":"The COBENEFITID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"co_benefit_id":{"type":"string"},"co_benefit_name":{"type":"string"}}},"example":{"co_benefit_id":"string","co_benefit_name":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"co_benefit":{"type":"object","properties":{"co_benefit_id":{"type":"string"},"co_benefit_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"co_benefit":{"co_benefit_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","co_benefit_id":"string","co_benefit_name":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Co_benefit(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete co_benefit by id","description":"<p>Delete co_benefit by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"co_benefit\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteco_benefit_ogcr","parameters":[{"name":"cobenefitid","in":"path","description":"The COBENEFITID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"co_benefit":{"type":"object","properties":{"co_benefit_id":{"type":"string"},"co_benefit_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"co_benefit":{"co_benefit_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","co_benefit_id":"string","co_benefit_name":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Co_benefit(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update co_benefit","description":"<p>Partially update co_benefit: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Parsed entity co_benefit. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"co_benefit\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchco_benefit_ogcr","parameters":[{"name":"cobenefitid","in":"path","description":"The COBENEFITID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"co_benefit_id":{"type":"string"},"co_benefit_name":{"type":"string"}}},"example":{"co_benefit_id":"string","co_benefit_name":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"co_benefit":{"type":"object","properties":{"co_benefit_id":{"type":"string"},"co_benefit_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"co_benefit":{"co_benefit_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","co_benefit_id":"string","co_benefit_name":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/land-manager/{landmanagerid}":{"get":{"tags":["_Land_manager(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get land_manager by id","description":"<p>Get land_manager by id.</p>\n<p>\u2018land manager\u2019 means any natural or legal person or public entity that owns land being used for an activity. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>land_manager_id: Internal identifier for the land manager entity</li>\n<li>legal_name: Name of the land manager</li>\n<li>email: Land manager email address</li>\n<li>phone: Land manager phone number</li>\n<li>ogcr_wallet_address: Wallet address to send NFTs and carbon credits to after evaluation period</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"land_manager\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleland_manager_ogcr","parameters":[{"name":"landmanagerid","in":"path","description":"The LANDMANAGERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"land_manager":{"type":"object","properties":{"email":{"type":"string"},"land_manager_id":{"type":"string"},"ogcr_wallet_address":{"type":"string"},"legal_name":{"type":"string"},"phone":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"land_manager":{"land_manager_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","land_manager_id":"lm_03PVAF03760","legal_name":"Bob Smith","email":"example.email@email.com","phone":"+49 987 654 321","ogcr_wallet_address":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Land_manager(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update land_manager","description":"<p>Update land_manager.</p>\n<p>\u2018land manager\u2019 means any natural or legal person or public entity that owns land being used for an activity. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>land_manager_id: Internal identifier for the land manager entity</li>\n<li>legal_name: Name of the land manager</li>\n<li>email: Land manager email address</li>\n<li>phone: Land manager phone number</li>\n<li>ogcr_wallet_address: Wallet address to send NFTs and carbon credits to after evaluation period</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"land_manager\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateland_manager_ogcr","parameters":[{"name":"landmanagerid","in":"path","description":"The LANDMANAGERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"land_manager_id":{"type":"string"},"ogcr_wallet_address":{"type":"string"},"legal_name":{"type":"string"},"phone":{"type":"string"}}},"example":{"land_manager_id":"lm_03PVAF03760","legal_name":"Bob Smith","email":"example.email@email.com","phone":"+49 987 654 321","ogcr_wallet_address":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"land_manager":{"type":"object","properties":{"email":{"type":"string"},"land_manager_id":{"type":"string"},"ogcr_wallet_address":{"type":"string"},"legal_name":{"type":"string"},"phone":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"land_manager":{"land_manager_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","land_manager_id":"lm_03PVAF03760","legal_name":"Bob Smith","email":"example.email@email.com","phone":"+49 987 654 321","ogcr_wallet_address":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Land_manager(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete land_manager by id","description":"<p>Delete land_manager by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"land_manager\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteland_manager_ogcr","parameters":[{"name":"landmanagerid","in":"path","description":"The LANDMANAGERID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"land_manager":{"type":"object","properties":{"email":{"type":"string"},"land_manager_id":{"type":"string"},"ogcr_wallet_address":{"type":"string"},"legal_name":{"type":"string"},"phone":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"land_manager":{"land_manager_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","land_manager_id":"lm_03PVAF03760","legal_name":"Bob Smith","email":"example.email@email.com","phone":"+49 987 654 321","ogcr_wallet_address":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Land_manager(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update land_manager","description":"<p>Partially update land_manager: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>\u2018land manager\u2019 means any natural or legal person or public entity that owns land being used for an activity. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>land_manager_id: Internal identifier for the land manager entity</li>\n<li>legal_name: Name of the land manager</li>\n<li>email: Land manager email address</li>\n<li>phone: Land manager phone number</li>\n<li>ogcr_wallet_address: Wallet address to send NFTs and carbon credits to after evaluation period</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"land_manager\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchland_manager_ogcr","parameters":[{"name":"landmanagerid","in":"path","description":"The LANDMANAGERID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"land_manager_id":{"type":"string"},"ogcr_wallet_address":{"type":"string"},"legal_name":{"type":"string"},"phone":{"type":"string"}}},"example":{"land_manager_id":"lm_03PVAF03760","legal_name":"Bob Smith","email":"example.email@email.com","phone":"+49 987 654 321","ogcr_wallet_address":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"land_manager":{"type":"object","properties":{"email":{"type":"string"},"land_manager_id":{"type":"string"},"ogcr_wallet_address":{"type":"string"},"legal_name":{"type":"string"},"phone":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"land_manager":{"land_manager_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","land_manager_id":"lm_03PVAF03760","legal_name":"Bob Smith","email":"example.email@email.com","phone":"+49 987 654 321","ogcr_wallet_address":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/test-1":{"get":{"tags":["_Test_1(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get test_1 List","description":"<p>Get test_1 List.</p>\n<p>Parsed entity test_1. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"test_1\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p><em>(no fields on this entity are declared <code>indexed</code>, so only the legacy bare-parameter filter below is available.)</em></p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_gettest_1List_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"test_1_list":{"type":"array","items":{"type":"object","properties":{"test_1":{"type":"object","properties":{"test_1_id":{"type":"string"},"field_1":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"test_1_list":[{"test_1":{"test_1_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","field_1":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Test_1(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new test_1","description":"<p>Create new test_1.</p>\n<p>Parsed entity test_1. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"test_1\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createtest_1_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"field_1":{"type":"string"}}},"example":{"field_1":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"test_1":{"type":"object","properties":{"test_1_id":{"type":"string"},"field_1":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"test_1":{"test_1_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","field_1":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/authority":{"get":{"tags":["_Authority(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get authority List","description":"<p>Get authority List.</p>\n<p>An EU or national public body that accredits, recognises or supervises. A Member State is not an entity, only the country_code on its authorities. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>authority_id: Internal identifier for the authority.</li>\n<li>legal_name: Official name of the authority.</li>\n<li>authority_type: Controlled vocabulary: eu_institution, national_competent_authority, national_accreditation_body.</li>\n<li>country_id: ISO 3166-1 alpha-2 code of the Member State. Null for EU-level bodies.</li>\n<li>department: Optional unit within the authority.</li>\n<li>email: Official contact address.</li>\n<li>website: Public URL for the authority.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"authority\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>authority_id</code>, <code>country_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>country_id</code> → <code>country</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getauthorityList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"authority_list":{"type":"array","items":{"type":"object","properties":{"authority":{"type":"object","properties":{"email":{"type":"string"},"department":{"type":"string"},"legal_name":{"type":"string"},"authority_id":{"type":"string"},"country_id":{"type":"string"},"authority_type":{"type":"string"},"website":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"authority_list":[{"authority":{"authority_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","authority_id":"auth_01HZZ4K7Q2M","legal_name":"Deutsche Akkreditierungsstelle GmbH","authority_type":"national_accreditation_body","country_id":"DE","department":"DG CLIMA","email":"registry@example.eu","website":"https://example.eu"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Authority(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new authority","description":"<p>Create new authority.</p>\n<p>An EU or national public body that accredits, recognises or supervises. A Member State is not an entity, only the country_code on its authorities. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>authority_id: Internal identifier for the authority.</li>\n<li>legal_name: Official name of the authority.</li>\n<li>authority_type: Controlled vocabulary: eu_institution, national_competent_authority, national_accreditation_body.</li>\n<li>country_id: ISO 3166-1 alpha-2 code of the Member State. Null for EU-level bodies.</li>\n<li>department: Optional unit within the authority.</li>\n<li>email: Official contact address.</li>\n<li>website: Public URL for the authority.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"authority\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createauthority_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"department":{"type":"string"},"legal_name":{"type":"string"},"authority_id":{"type":"string"},"country_id":{"type":"string"},"authority_type":{"type":"string"},"website":{"type":"string"}}},"example":{"authority_id":"auth_01HZZ4K7Q2M","legal_name":"Deutsche Akkreditierungsstelle GmbH","authority_type":"national_accreditation_body","country_id":"DE","department":"DG CLIMA","email":"registry@example.eu","website":"https://example.eu"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"authority":{"type":"object","properties":{"email":{"type":"string"},"department":{"type":"string"},"legal_name":{"type":"string"},"authority_id":{"type":"string"},"country_id":{"type":"string"},"authority_type":{"type":"string"},"website":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"authority":{"authority_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","authority_id":"auth_01HZZ4K7Q2M","legal_name":"Deutsche Akkreditierungsstelle GmbH","authority_type":"national_accreditation_body","country_id":"DE","department":"DG CLIMA","email":"registry@example.eu","website":"https://example.eu"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/certification-body/{certificationbodyid}":{"get":{"tags":["_Certification_body(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get certification_body by id","description":"<p>Get certification_body by id.</p>\n<p>\u2018certification body\u2019 means an accredited or recognised independent conformity assessment body that has concluded an agreement with a certification scheme to carry out certification audits and issue certificates of compliance;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certification_body_id: Unique identifier for the certification body</li>\n<li>legal_name: Legal or trading name of the certification body</li>\n<li>address_line_1: Certification body primary street address (street name, building number, P.O. Box if applicable)</li>\n<li>address_line_2: Certification body secondary, optional details like apartment, suite, unit, floor, or building name</li>\n<li>address_city: City</li>\n<li>address_postcode: Certification body postcode</li>\n<li>country_id: ISO 3166-1 alpha-2 country code for certification body address.</li>\n<li>logo: URL or asset reference to a logo image for UI/PDF rendering.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_body\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglecertification_body_ogcr","parameters":[{"name":"certificationbodyid","in":"path","description":"The CERTIFICATIONBODYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_body":{"type":"object","properties":{"address_city":{"type":"string"},"website":{"type":"string"},"email":{"type":"string"},"accreditation_route":{"type":"string"},"logo":{"type":"string"},"status":{"type":"string"},"address_line_2":{"type":"string"},"address_postcode":{"type":"string"},"country_id":{"type":"string"},"address_line_1":{"type":"string"},"certification_body_id":{"type":"string"},"legal_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certification_body":{"certification_body_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certification_body_id":"cb_01HZZ1M2A3B4C5D6E7F8","legal_name":"DNV Business Assurance Germany GmbH","accreditation_route":"string","address_line_1":"Brooktorkai 18","address_line_2":"5th Floor","address_city":"Hamburg","address_postcode":"20457","country_id":"DE","status":"string","email":"string","website":"string","logo":"https://cdn.example.org/logos/dnv.png"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Certification_body(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update certification_body","description":"<p>Update certification_body.</p>\n<p>\u2018certification body\u2019 means an accredited or recognised independent conformity assessment body that has concluded an agreement with a certification scheme to carry out certification audits and issue certificates of compliance;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certification_body_id: Unique identifier for the certification body</li>\n<li>legal_name: Legal or trading name of the certification body</li>\n<li>address_line_1: Certification body primary street address (street name, building number, P.O. Box if applicable)</li>\n<li>address_line_2: Certification body secondary, optional details like apartment, suite, unit, floor, or building name</li>\n<li>address_city: City</li>\n<li>address_postcode: Certification body postcode</li>\n<li>country_id: ISO 3166-1 alpha-2 country code for certification body address.</li>\n<li>logo: URL or asset reference to a logo image for UI/PDF rendering.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_body\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updatecertification_body_ogcr","parameters":[{"name":"certificationbodyid","in":"path","description":"The CERTIFICATIONBODYID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"address_city":{"type":"string"},"website":{"type":"string"},"email":{"type":"string"},"accreditation_route":{"type":"string"},"logo":{"type":"string"},"status":{"type":"string"},"address_line_2":{"type":"string"},"address_postcode":{"type":"string"},"country_id":{"type":"string"},"address_line_1":{"type":"string"},"certification_body_id":{"type":"string"},"legal_name":{"type":"string"}}},"example":{"certification_body_id":"cb_01HZZ1M2A3B4C5D6E7F8","legal_name":"DNV Business Assurance Germany GmbH","accreditation_route":"string","address_line_1":"Brooktorkai 18","address_line_2":"5th Floor","address_city":"Hamburg","address_postcode":"20457","country_id":"DE","status":"string","email":"string","website":"string","logo":"https://cdn.example.org/logos/dnv.png"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_body":{"type":"object","properties":{"address_city":{"type":"string"},"website":{"type":"string"},"email":{"type":"string"},"accreditation_route":{"type":"string"},"logo":{"type":"string"},"status":{"type":"string"},"address_line_2":{"type":"string"},"address_postcode":{"type":"string"},"country_id":{"type":"string"},"address_line_1":{"type":"string"},"certification_body_id":{"type":"string"},"legal_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certification_body":{"certification_body_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certification_body_id":"cb_01HZZ1M2A3B4C5D6E7F8","legal_name":"DNV Business Assurance Germany GmbH","accreditation_route":"string","address_line_1":"Brooktorkai 18","address_line_2":"5th Floor","address_city":"Hamburg","address_postcode":"20457","country_id":"DE","status":"string","email":"string","website":"string","logo":"https://cdn.example.org/logos/dnv.png"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Certification_body(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete certification_body by id","description":"<p>Delete certification_body by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_body\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletecertification_body_ogcr","parameters":[{"name":"certificationbodyid","in":"path","description":"The CERTIFICATIONBODYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_body":{"type":"object","properties":{"address_city":{"type":"string"},"website":{"type":"string"},"email":{"type":"string"},"accreditation_route":{"type":"string"},"logo":{"type":"string"},"status":{"type":"string"},"address_line_2":{"type":"string"},"address_postcode":{"type":"string"},"country_id":{"type":"string"},"address_line_1":{"type":"string"},"certification_body_id":{"type":"string"},"legal_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certification_body":{"certification_body_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certification_body_id":"cb_01HZZ1M2A3B4C5D6E7F8","legal_name":"DNV Business Assurance Germany GmbH","accreditation_route":"string","address_line_1":"Brooktorkai 18","address_line_2":"5th Floor","address_city":"Hamburg","address_postcode":"20457","country_id":"DE","status":"string","email":"string","website":"string","logo":"https://cdn.example.org/logos/dnv.png"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Certification_body(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update certification_body","description":"<p>Partially update certification_body: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>\u2018certification body\u2019 means an accredited or recognised independent conformity assessment body that has concluded an agreement with a certification scheme to carry out certification audits and issue certificates of compliance;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certification_body_id: Unique identifier for the certification body</li>\n<li>legal_name: Legal or trading name of the certification body</li>\n<li>address_line_1: Certification body primary street address (street name, building number, P.O. Box if applicable)</li>\n<li>address_line_2: Certification body secondary, optional details like apartment, suite, unit, floor, or building name</li>\n<li>address_city: City</li>\n<li>address_postcode: Certification body postcode</li>\n<li>country_id: ISO 3166-1 alpha-2 country code for certification body address.</li>\n<li>logo: URL or asset reference to a logo image for UI/PDF rendering.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_body\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchcertification_body_ogcr","parameters":[{"name":"certificationbodyid","in":"path","description":"The CERTIFICATIONBODYID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"address_city":{"type":"string"},"website":{"type":"string"},"email":{"type":"string"},"accreditation_route":{"type":"string"},"logo":{"type":"string"},"status":{"type":"string"},"address_line_2":{"type":"string"},"address_postcode":{"type":"string"},"country_id":{"type":"string"},"address_line_1":{"type":"string"},"certification_body_id":{"type":"string"},"legal_name":{"type":"string"}}},"example":{"certification_body_id":"cb_01HZZ1M2A3B4C5D6E7F8","legal_name":"DNV Business Assurance Germany GmbH","accreditation_route":"string","address_line_1":"Brooktorkai 18","address_line_2":"5th Floor","address_city":"Hamburg","address_postcode":"20457","country_id":"DE","status":"string","email":"string","website":"string","logo":"https://cdn.example.org/logos/dnv.png"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_body":{"type":"object","properties":{"address_city":{"type":"string"},"website":{"type":"string"},"email":{"type":"string"},"accreditation_route":{"type":"string"},"logo":{"type":"string"},"status":{"type":"string"},"address_line_2":{"type":"string"},"address_postcode":{"type":"string"},"country_id":{"type":"string"},"address_line_1":{"type":"string"},"certification_body_id":{"type":"string"},"legal_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certification_body":{"certification_body_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certification_body_id":"cb_01HZZ1M2A3B4C5D6E7F8","legal_name":"DNV Business Assurance Germany GmbH","accreditation_route":"string","address_line_1":"Brooktorkai 18","address_line_2":"5th Floor","address_city":"Hamburg","address_postcode":"20457","country_id":"DE","status":"string","email":"string","website":"string","logo":"https://cdn.example.org/logos/dnv.png"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/activity-media/{activitymediaid}":{"get":{"tags":["_Activity_media(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get activity_media by id","description":"<p>Get activity_media by id.</p>\n<p>Parsed entity activity_media. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_media\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleactivity_media_ogcr","parameters":[{"name":"activitymediaid","in":"path","description":"The ACTIVITYMEDIAID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_media":{"type":"object","properties":{"author":{"type":"string"},"activity_media_type":{"type":"string"},"image":{"type":"string"},"activity_media_id":{"type":"string"},"published_date":{"type":"string"},"activity_id":{"type":"string"},"link":{"type":"string"},"title":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_media":{"activity_media_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","activity_media_id":"string","activity_media_type":"string","title":"string","published_date":"2020-01-01","image":"string","author":"string","link":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Activity_media(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update activity_media","description":"<p>Update activity_media.</p>\n<p>Parsed entity activity_media. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_media\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateactivity_media_ogcr","parameters":[{"name":"activitymediaid","in":"path","description":"The ACTIVITYMEDIAID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"author":{"type":"string"},"activity_media_type":{"type":"string"},"image":{"type":"string"},"activity_media_id":{"type":"string"},"published_date":{"type":"string"},"activity_id":{"type":"string"},"link":{"type":"string"},"title":{"type":"string"}}},"example":{"activity_id":"string","activity_media_id":"string","activity_media_type":"string","title":"string","published_date":"2020-01-01","image":"string","author":"string","link":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_media":{"type":"object","properties":{"author":{"type":"string"},"activity_media_type":{"type":"string"},"image":{"type":"string"},"activity_media_id":{"type":"string"},"published_date":{"type":"string"},"activity_id":{"type":"string"},"link":{"type":"string"},"title":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_media":{"activity_media_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","activity_media_id":"string","activity_media_type":"string","title":"string","published_date":"2020-01-01","image":"string","author":"string","link":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Activity_media(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete activity_media by id","description":"<p>Delete activity_media by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_media\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteactivity_media_ogcr","parameters":[{"name":"activitymediaid","in":"path","description":"The ACTIVITYMEDIAID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_media":{"type":"object","properties":{"author":{"type":"string"},"activity_media_type":{"type":"string"},"image":{"type":"string"},"activity_media_id":{"type":"string"},"published_date":{"type":"string"},"activity_id":{"type":"string"},"link":{"type":"string"},"title":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_media":{"activity_media_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","activity_media_id":"string","activity_media_type":"string","title":"string","published_date":"2020-01-01","image":"string","author":"string","link":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Activity_media(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update activity_media","description":"<p>Partially update activity_media: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Parsed entity activity_media. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_media\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchactivity_media_ogcr","parameters":[{"name":"activitymediaid","in":"path","description":"The ACTIVITYMEDIAID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"author":{"type":"string"},"activity_media_type":{"type":"string"},"image":{"type":"string"},"activity_media_id":{"type":"string"},"published_date":{"type":"string"},"activity_id":{"type":"string"},"link":{"type":"string"},"title":{"type":"string"}}},"example":{"activity_id":"string","activity_media_id":"string","activity_media_type":"string","title":"string","published_date":"2020-01-01","image":"string","author":"string","link":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_media":{"type":"object","properties":{"author":{"type":"string"},"activity_media_type":{"type":"string"},"image":{"type":"string"},"activity_media_id":{"type":"string"},"published_date":{"type":"string"},"activity_id":{"type":"string"},"link":{"type":"string"},"title":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_media":{"activity_media_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","activity_media_id":"string","activity_media_type":"string","title":"string","published_date":"2020-01-01","image":"string","author":"string","link":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/sustainable-development-goals/{sustainabledevelopmentgoalsid}":{"get":{"tags":["_Sustainable_development_goals(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get sustainable_development_goals by id","description":"<p>Get sustainable_development_goals by id.</p>\n<p>Entity for listing sustainable development goals being addressed by an activity. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"sustainable_development_goals\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglesustainable_development_goals_ogcr","parameters":[{"name":"sustainabledevelopmentgoalsid","in":"path","description":"The SUSTAINABLEDEVELOPMENTGOALSID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"sustainable_development_goals":{"type":"object","properties":{"sustainable_development_goals_id":{"type":"string"},"activity_id":{"type":"string"},"sustainable_development_goal_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"sustainable_development_goals":{"sustainable_development_goals_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","sustainable_development_goal_id":"CLIMATE_ACTION"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Sustainable_development_goals(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update sustainable_development_goals","description":"<p>Update sustainable_development_goals.</p>\n<p>Entity for listing sustainable development goals being addressed by an activity. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"sustainable_development_goals\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updatesustainable_development_goals_ogcr","parameters":[{"name":"sustainabledevelopmentgoalsid","in":"path","description":"The SUSTAINABLEDEVELOPMENTGOALSID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"activity_id":{"type":"string"},"sustainable_development_goal_id":{"type":"string"}}},"example":{"activity_id":"string","sustainable_development_goal_id":"CLIMATE_ACTION"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"sustainable_development_goals":{"type":"object","properties":{"sustainable_development_goals_id":{"type":"string"},"activity_id":{"type":"string"},"sustainable_development_goal_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"sustainable_development_goals":{"sustainable_development_goals_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","sustainable_development_goal_id":"CLIMATE_ACTION"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Sustainable_development_goals(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete sustainable_development_goals by id","description":"<p>Delete sustainable_development_goals by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"sustainable_development_goals\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletesustainable_development_goals_ogcr","parameters":[{"name":"sustainabledevelopmentgoalsid","in":"path","description":"The SUSTAINABLEDEVELOPMENTGOALSID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"sustainable_development_goals":{"type":"object","properties":{"sustainable_development_goals_id":{"type":"string"},"activity_id":{"type":"string"},"sustainable_development_goal_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"sustainable_development_goals":{"sustainable_development_goals_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","sustainable_development_goal_id":"CLIMATE_ACTION"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Sustainable_development_goals(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update sustainable_development_goals","description":"<p>Partially update sustainable_development_goals: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Entity for listing sustainable development goals being addressed by an activity. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"sustainable_development_goals\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchsustainable_development_goals_ogcr","parameters":[{"name":"sustainabledevelopmentgoalsid","in":"path","description":"The SUSTAINABLEDEVELOPMENTGOALSID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"activity_id":{"type":"string"},"sustainable_development_goal_id":{"type":"string"}}},"example":{"activity_id":"string","sustainable_development_goal_id":"CLIMATE_ACTION"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"sustainable_development_goals":{"type":"object","properties":{"sustainable_development_goals_id":{"type":"string"},"activity_id":{"type":"string"},"sustainable_development_goal_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"sustainable_development_goals":{"sustainable_development_goals_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","sustainable_development_goal_id":"CLIMATE_ACTION"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/activity-media":{"get":{"tags":["_Activity_media(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public activity_media List","description":"<p>Get Public activity_media List.</p>\n<p>Parsed entity activity_media. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_media\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>activity_media_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPublicactivity_mediaList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_media_list":{"type":"array","items":{"type":"object","properties":{"activity_media":{"type":"object","properties":{"author":{"type":"string"},"activity_media_type":{"type":"string"},"image":{"type":"string"},"activity_media_id":{"type":"string"},"published_date":{"type":"string"},"activity_id":{"type":"string"},"link":{"type":"string"},"title":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"activity_media_list":[{"activity_media":{"activity_media_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","activity_media_id":"string","activity_media_type":"string","title":"string","published_date":"2020-01-01","image":"string","author":"string","link":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/public/supervisory-non-conformity/{supervisorynonconformityid}":{"get":{"tags":["_Supervisory_non_conformity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public supervisory_non_conformity by id","description":"<p>Get Public supervisory_non_conformity by id.</p>\n<p>\u2018non-conformity\u2019 means a failure by an operator or a certification body to comply with the rules and procedures, established by the certification scheme, of which they are members or under which they operate. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>category: critical, major and minor</li>\n<li>remediation_timeline: Timeline for remediation of non-conformities</li>\n<li>sanction: Sanction imposed for the non-conformity, e.g. warning, suspension or withdrawal of certification</li>\n<li>certification_body_id: The certification body this non  conformity refers to</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"supervisory_non_conformity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePublicsupervisory_non_conformity_ogcr","parameters":[{"name":"supervisorynonconformityid","in":"path","description":"The SUPERVISORYNONCONFORMITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"supervisory_non_conformity":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"sanction":{"type":"string"},"audit_report_id":{"type":"string"},"supervisory_finding_id":{"type":"string"},"remediation_timeline":{"type":"string"},"supervisory_non_conformity_id":{"type":"string"},"certification_body_id":{"type":"string"},"category":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"supervisory_non_conformity":{"supervisory_non_conformity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supervisory_non_conformity_id":"string","supervisory_finding_id":"string","audit_report_id":"string","category":"string","remediation_timeline":"string","sanction":"warning","certification_scheme_id":"string","certification_body_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/public/carbon-credit-batch/{carboncreditbatchid}":{"get":{"tags":["_Carbon_credit_batch(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public carbon_credit_batch by id","description":"<p>Get Public carbon_credit_batch by id.</p>\n<p>One batch of certified carbon credit units issued for an activity over one monitoring period after certification or re-certification. Represented by a Batch NFT. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>carbon_credit_batch_id: Internal identifier for the batch</li>\n<li>activity_id: Activity that generated the units</li>\n<li>certificate_of_compliance_id: Certificate (or updated certificate after re-certification) the units were issued from</li>\n<li>unit_type: Permanent Removal, Carbon Farming Sequestration, Soil Emission Reduction or Carbon Storage in Product</li>\n<li>status_code: Unit status: issued, retired, expired, cancelled</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"carbon_credit_batch\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePubliccarbon_credit_batch_ogcr","parameters":[{"name":"carboncreditbatchid","in":"path","description":"The CARBONCREDITBATCHID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"carbon_credit_batch":{"type":"object","properties":{"unit_type":{"type":"string"},"status_code":{"type":"string"},"activity_id":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"carbon_credit_batch_id":{"type":"string"},"expiry_date":{"type":"string"},"monitoring_period_end_date":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"carbon_credit_batch":{"carbon_credit_batch_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","carbon_credit_batch_id":"string","activity_id":"string","certificate_of_compliance_id":"string","unit_type":"Soil Emission Reduction","monitoring_period_start_date":"2020-01-01","monitoring_period_end_date":"2020-01-01","amount":1.0,"status_code":"string","issue_date":"2020-01-01","expiry_date":"2020-01-01"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/parcel":{"get":{"tags":["_Parcel(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get parcel List","description":"<p>Get parcel List.</p>\n<p>Parcel' means a geospatially defined unit of land, identified by its boundary geometry. parcel holds the stable, rarely-changing identity of the land (geometry, CRS, official land-registry codes). This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>parcel_id: Internal identifier for the parcel.</li>\n<li>multipolygon_coordinates: GeoJSON MultiPolygon boundary of the parcel.</li>\n<li>coordinate_reference_system: Coordinate Reference System (CRS) identifier that defines how to interpret the geometry coordinates (e.g., EPSG:4326 for WGS84).</li>\n<li>cadastral_reference: Member state national cadastral registry ID</li>\n<li>iacs_codes: Array of identifiers referencing the parcel in the Member State\u2019s IACS (Integrated Administration and Control System). Only if applicable.</li>\n<li>lpis_codes: Identifiers from the Land Parcel Identification System (LPIS) that reference official \u201creference parcels\u201d/land blocks.  Only if applicable.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>parcel_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getparcelList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_list":{"type":"array","items":{"type":"object","properties":{"parcel":{"type":"object","properties":{"iacs_codes":{"type":"string"},"multipolygon_coordinates":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"array","maxItems":2,"minItems":2,"items":{"type":"number"}}}}}}},"coordinate_reference_system":{"type":"string"},"parcel_id":{"type":"string"},"cadastral_reference":{"type":"string"},"lpis_codes":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"parcel_list":[{"parcel":{"parcel_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_id":"parcel_03OGNWO397234DQ","multipolygon_coordinates":{"type":"MultiPolygon","coordinates":[[[[13.405,52.52],[13.406,52.52],[13.406,52.521],[13.405,52.521],[13.405,52.52]]]]},"coordinate_reference_system":"EPSG:4326","cadastral_reference":"string","iacs_codes":"DE-BB-IACS-2026-0012345678","lpis_codes":"DE-BB-LPIS-REFPARCEL-0098765432"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Parcel(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new parcel","description":"<p>Create new parcel.</p>\n<p>Parcel' means a geospatially defined unit of land, identified by its boundary geometry. parcel holds the stable, rarely-changing identity of the land (geometry, CRS, official land-registry codes). This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>parcel_id: Internal identifier for the parcel.</li>\n<li>multipolygon_coordinates: GeoJSON MultiPolygon boundary of the parcel.</li>\n<li>coordinate_reference_system: Coordinate Reference System (CRS) identifier that defines how to interpret the geometry coordinates (e.g., EPSG:4326 for WGS84).</li>\n<li>cadastral_reference: Member state national cadastral registry ID</li>\n<li>iacs_codes: Array of identifiers referencing the parcel in the Member State\u2019s IACS (Integrated Administration and Control System). Only if applicable.</li>\n<li>lpis_codes: Identifiers from the Land Parcel Identification System (LPIS) that reference official \u201creference parcels\u201d/land blocks.  Only if applicable.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createparcel_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"iacs_codes":{"type":"string"},"multipolygon_coordinates":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"array","maxItems":2,"minItems":2,"items":{"type":"number"}}}}}}},"coordinate_reference_system":{"type":"string"},"parcel_id":{"type":"string"},"cadastral_reference":{"type":"string"},"lpis_codes":{"type":"string"}}},"example":{"parcel_id":"parcel_03OGNWO397234DQ","multipolygon_coordinates":{"type":"MultiPolygon","coordinates":[[[[13.405,52.52],[13.406,52.52],[13.406,52.521],[13.405,52.521],[13.405,52.52]]]]},"coordinate_reference_system":"EPSG:4326","cadastral_reference":"string","iacs_codes":"DE-BB-IACS-2026-0012345678","lpis_codes":"DE-BB-LPIS-REFPARCEL-0098765432"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel":{"type":"object","properties":{"iacs_codes":{"type":"string"},"multipolygon_coordinates":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"array","maxItems":2,"minItems":2,"items":{"type":"number"}}}}}}},"coordinate_reference_system":{"type":"string"},"parcel_id":{"type":"string"},"cadastral_reference":{"type":"string"},"lpis_codes":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel":{"parcel_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_id":"parcel_03OGNWO397234DQ","multipolygon_coordinates":{"type":"MultiPolygon","coordinates":[[[[13.405,52.52],[13.406,52.52],[13.406,52.521],[13.405,52.521],[13.405,52.52]]]]},"coordinate_reference_system":"EPSG:4326","cadastral_reference":"string","iacs_codes":"DE-BB-IACS-2026-0012345678","lpis_codes":"DE-BB-LPIS-REFPARCEL-0098765432"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/parcel-owner-verification-supporting-document/{parcelownerverificationsupportingdocumentid}":{"get":{"tags":["_Parcel_owner_verification_supporting_document(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get parcel_owner_verification_supporting_document by id","description":"<p>Get parcel_owner_verification_supporting_document by id.</p>\n<p>Parsed entity parcel_owner_verification_supporting_document. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_owner_verification_supporting_document\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleparcel_owner_verification_supporting_document_ogcr","parameters":[{"name":"parcelownerverificationsupportingdocumentid","in":"path","description":"The PARCELOWNERVERIFICATIONSUPPORTINGDOCUMENTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_owner_verification_supporting_document":{"type":"object","properties":{"parcel_owner_verification_supporting_document_id":{"type":"string"},"supporting_document_id":{"type":"string"},"parcel_owner_verification_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_owner_verification_supporting_document":{"parcel_owner_verification_supporting_document_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supporting_document_id":"string","parcel_owner_verification_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Parcel_owner_verification_supporting_document(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update parcel_owner_verification_supporting_document","description":"<p>Update parcel_owner_verification_supporting_document.</p>\n<p>Parsed entity parcel_owner_verification_supporting_document. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_owner_verification_supporting_document\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateparcel_owner_verification_supporting_document_ogcr","parameters":[{"name":"parcelownerverificationsupportingdocumentid","in":"path","description":"The PARCELOWNERVERIFICATIONSUPPORTINGDOCUMENTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"parcel_owner_verification_id":{"type":"string"}}},"example":{"supporting_document_id":"string","parcel_owner_verification_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_owner_verification_supporting_document":{"type":"object","properties":{"parcel_owner_verification_supporting_document_id":{"type":"string"},"supporting_document_id":{"type":"string"},"parcel_owner_verification_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_owner_verification_supporting_document":{"parcel_owner_verification_supporting_document_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supporting_document_id":"string","parcel_owner_verification_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Parcel_owner_verification_supporting_document(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete parcel_owner_verification_supporting_document by id","description":"<p>Delete parcel_owner_verification_supporting_document by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_owner_verification_supporting_document\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteparcel_owner_verification_supporting_document_ogcr","parameters":[{"name":"parcelownerverificationsupportingdocumentid","in":"path","description":"The PARCELOWNERVERIFICATIONSUPPORTINGDOCUMENTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_owner_verification_supporting_document":{"type":"object","properties":{"parcel_owner_verification_supporting_document_id":{"type":"string"},"supporting_document_id":{"type":"string"},"parcel_owner_verification_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_owner_verification_supporting_document":{"parcel_owner_verification_supporting_document_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supporting_document_id":"string","parcel_owner_verification_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Parcel_owner_verification_supporting_document(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update parcel_owner_verification_supporting_document","description":"<p>Partially update parcel_owner_verification_supporting_document: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Parsed entity parcel_owner_verification_supporting_document. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_owner_verification_supporting_document\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchparcel_owner_verification_supporting_document_ogcr","parameters":[{"name":"parcelownerverificationsupportingdocumentid","in":"path","description":"The PARCELOWNERVERIFICATIONSUPPORTINGDOCUMENTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"supporting_document_id":{"type":"string"},"parcel_owner_verification_id":{"type":"string"}}},"example":{"supporting_document_id":"string","parcel_owner_verification_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_owner_verification_supporting_document":{"type":"object","properties":{"parcel_owner_verification_supporting_document_id":{"type":"string"},"supporting_document_id":{"type":"string"},"parcel_owner_verification_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_owner_verification_supporting_document":{"parcel_owner_verification_supporting_document_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supporting_document_id":"string","parcel_owner_verification_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/activity-sustainable-development-goal/{activitysustainabledevelopmentgoalid}":{"get":{"tags":["_Activity_sustainable_development_goal(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public activity_sustainable_development_goal by id","description":"<p>Get Public activity_sustainable_development_goal by id.</p>\n<p>Entity for listing sustainable development goals being addressed by an activity. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_sustainable_development_goal\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePublicactivity_sustainable_development_goal_ogcr","parameters":[{"name":"activitysustainabledevelopmentgoalid","in":"path","description":"The ACTIVITYSUSTAINABLEDEVELOPMENTGOALID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_sustainable_development_goal":{"type":"object","properties":{"activity_sustainable_development_goal_id":{"type":"string"},"activity_id":{"type":"string"},"sustainable_development_goal_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"activity_sustainable_development_goal":{"activity_sustainable_development_goal_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","sustainable_development_goal_id":"CLIMATE_ACTION"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/activity-sustainable-development-goal/{activitysustainabledevelopmentgoalid}":{"get":{"tags":["_Activity_sustainable_development_goal(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get activity_sustainable_development_goal by id","description":"<p>Get activity_sustainable_development_goal by id.</p>\n<p>Entity for listing sustainable development goals being addressed by an activity. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_sustainable_development_goal\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleactivity_sustainable_development_goal_ogcr","parameters":[{"name":"activitysustainabledevelopmentgoalid","in":"path","description":"The ACTIVITYSUSTAINABLEDEVELOPMENTGOALID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_sustainable_development_goal":{"type":"object","properties":{"activity_sustainable_development_goal_id":{"type":"string"},"activity_id":{"type":"string"},"sustainable_development_goal_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_sustainable_development_goal":{"activity_sustainable_development_goal_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","sustainable_development_goal_id":"CLIMATE_ACTION"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Activity_sustainable_development_goal(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update activity_sustainable_development_goal","description":"<p>Update activity_sustainable_development_goal.</p>\n<p>Entity for listing sustainable development goals being addressed by an activity. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_sustainable_development_goal\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateactivity_sustainable_development_goal_ogcr","parameters":[{"name":"activitysustainabledevelopmentgoalid","in":"path","description":"The ACTIVITYSUSTAINABLEDEVELOPMENTGOALID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"activity_id":{"type":"string"},"sustainable_development_goal_id":{"type":"string"}}},"example":{"activity_id":"string","sustainable_development_goal_id":"CLIMATE_ACTION"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_sustainable_development_goal":{"type":"object","properties":{"activity_sustainable_development_goal_id":{"type":"string"},"activity_id":{"type":"string"},"sustainable_development_goal_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_sustainable_development_goal":{"activity_sustainable_development_goal_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","sustainable_development_goal_id":"CLIMATE_ACTION"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Activity_sustainable_development_goal(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete activity_sustainable_development_goal by id","description":"<p>Delete activity_sustainable_development_goal by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_sustainable_development_goal\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteactivity_sustainable_development_goal_ogcr","parameters":[{"name":"activitysustainabledevelopmentgoalid","in":"path","description":"The ACTIVITYSUSTAINABLEDEVELOPMENTGOALID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_sustainable_development_goal":{"type":"object","properties":{"activity_sustainable_development_goal_id":{"type":"string"},"activity_id":{"type":"string"},"sustainable_development_goal_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_sustainable_development_goal":{"activity_sustainable_development_goal_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","sustainable_development_goal_id":"CLIMATE_ACTION"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Activity_sustainable_development_goal(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update activity_sustainable_development_goal","description":"<p>Partially update activity_sustainable_development_goal: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Entity for listing sustainable development goals being addressed by an activity. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_sustainable_development_goal\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchactivity_sustainable_development_goal_ogcr","parameters":[{"name":"activitysustainabledevelopmentgoalid","in":"path","description":"The ACTIVITYSUSTAINABLEDEVELOPMENTGOALID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"activity_id":{"type":"string"},"sustainable_development_goal_id":{"type":"string"}}},"example":{"activity_id":"string","sustainable_development_goal_id":"CLIMATE_ACTION"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_sustainable_development_goal":{"type":"object","properties":{"activity_sustainable_development_goal_id":{"type":"string"},"activity_id":{"type":"string"},"sustainable_development_goal_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_sustainable_development_goal":{"activity_sustainable_development_goal_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","sustainable_development_goal_id":"CLIMATE_ACTION"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/retirement-event":{"get":{"tags":["_Retirement_event(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get retirement_event List","description":"<p>Get retirement_event List.</p>\n<p>Parsed entity retirement_event. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>retirement_event_id: Internal identifier for the retirement event</li>\n<li>carbon_credit_batch_id: Batch the retired credits are drawn from</li>\n<li>unit_type: Unit category being retired, must match the batch</li>\n<li>amount: Quantity of CO2e tonnes to retire</li>\n<li>owner_address: Wallet/TBA the credits are retired from</li>\n<li>beneficiary_name: The \"entity that uses the certified units\" (Annex III(h))</li>\n<li>end_use: Declared end-use of the unit (Recital 42)</li>\n<li>retirement_reason: Free-text claim statement</li>\n<li>status_code: in_progress, failed</li>\n<li>status_message: further explanation of status code</li>\n<li>retirement_date: Date retirement was requested</li>\n<li>certificate_of_compliance_id: Traces the unit back to its certificate</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_event\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>carbon_credit_batch_id</code>, <code>certificate_of_compliance_id</code>, <code>retirement_event_id</code>, <code>status_code</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>carbon_credit_batch_id</code> → <code>carbon_credit_batch</code>, <code>certificate_of_compliance_id</code> → <code>certificate_of_compliance</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getretirement_eventList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_event_list":{"type":"array","items":{"type":"object","properties":{"retirement_event":{"type":"object","properties":{"end_use":{"type":"string"},"unit_type":{"type":"string"},"retirement_date":{"type":"string"},"owner_address":{"type":"string"},"status_message":{"type":"string"},"carbon_credit_batch_id":{"type":"string"},"beneficiary_name":{"type":"string"},"status_code":{"type":"string"},"retirement_reason":{"type":"string"},"retirement_event_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"amount":{"type":"number"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"retirement_event_list":[{"retirement_event":{"retirement_event_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_event_id":"ret_01JS0347FKH","carbon_credit_batch_id":"batch_03OGNWO397234DQ","unit_type":"string","amount":1.0,"owner_address":"string","beneficiary_name":"string","end_use":"string","retirement_reason":"string","status_code":"string","status_message":"string","retirement_date":"2020-01-01","certificate_of_compliance_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Retirement_event(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new retirement_event","description":"<p>Create new retirement_event.</p>\n<p>Parsed entity retirement_event. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>retirement_event_id: Internal identifier for the retirement event</li>\n<li>carbon_credit_batch_id: Batch the retired credits are drawn from</li>\n<li>unit_type: Unit category being retired, must match the batch</li>\n<li>amount: Quantity of CO2e tonnes to retire</li>\n<li>owner_address: Wallet/TBA the credits are retired from</li>\n<li>beneficiary_name: The \"entity that uses the certified units\" (Annex III(h))</li>\n<li>end_use: Declared end-use of the unit (Recital 42)</li>\n<li>retirement_reason: Free-text claim statement</li>\n<li>status_code: in_progress, failed</li>\n<li>status_message: further explanation of status code</li>\n<li>retirement_date: Date retirement was requested</li>\n<li>certificate_of_compliance_id: Traces the unit back to its certificate</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_event\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createretirement_event_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"end_use":{"type":"string"},"unit_type":{"type":"string"},"retirement_date":{"type":"string"},"owner_address":{"type":"string"},"status_message":{"type":"string"},"carbon_credit_batch_id":{"type":"string"},"beneficiary_name":{"type":"string"},"status_code":{"type":"string"},"retirement_reason":{"type":"string"},"retirement_event_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"amount":{"type":"number"}}},"example":{"retirement_event_id":"ret_01JS0347FKH","carbon_credit_batch_id":"batch_03OGNWO397234DQ","unit_type":"string","amount":1.0,"owner_address":"string","beneficiary_name":"string","end_use":"string","retirement_reason":"string","status_code":"string","status_message":"string","retirement_date":"2020-01-01","certificate_of_compliance_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_event":{"type":"object","properties":{"end_use":{"type":"string"},"unit_type":{"type":"string"},"retirement_date":{"type":"string"},"owner_address":{"type":"string"},"status_message":{"type":"string"},"carbon_credit_batch_id":{"type":"string"},"beneficiary_name":{"type":"string"},"status_code":{"type":"string"},"retirement_reason":{"type":"string"},"retirement_event_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"amount":{"type":"number"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"retirement_event":{"retirement_event_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_event_id":"ret_01JS0347FKH","carbon_credit_batch_id":"batch_03OGNWO397234DQ","unit_type":"string","amount":1.0,"owner_address":"string","beneficiary_name":"string","end_use":"string","retirement_reason":"string","status_code":"string","status_message":"string","retirement_date":"2020-01-01","certificate_of_compliance_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/digital-mrv-observation":{"get":{"tags":["_Digital_mrv_observation(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get digital_mrv_observation List","description":"<p>Get digital_mrv_observation List.</p>\n<p>A single digital MRV (Monitoring, Reporting and Verification) output record for a parcel, covering a defined monitoring period. dMRV uses satellite imagery, geospatial data, and modelling (from WP3) to quantify soil organic carbon (SOC) and biomass changes continuously and at scale, without requiring a formal CRCF audit for each period. These records feed into Batch NFT issuance at the CRCF registry layer and into Scope 3 marketplace pricing and filtering. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>digital_mrv_observation_id: Unique internal identifier automatically assigned to this dMRV observation record.</li>\n<li>parcel_id: The parcel this observation covers. Links the dMRV result to the parcel geometry, ownership record, and any associated CRCF activity.</li>\n<li>growing_season_id: Optional link to the specific crop season this observation is associated with. Useful when dMRV data is available at crop-season resolution, allowing the carbon signal to be attributed to a particular practice change (e.g., cover cropping in winter 2026).</li>\n<li>observation_date_start: Start date of the monitoring window covered by this dMRV observation. Defines the period over which carbon stock changes are measured. Must align with the activity or reporting period for CRCF or Scope 3 use.</li>\n<li>observation_date_end: End date of the monitoring window. Together with observation_date_start, this defines the observation period. Corporate buyers need this to confirm the period overlaps their reporting year.</li>\n<li>digital_mrv_protocol: The name and version of the dMRV methodology used to produce this estimate. Generated by WP3. Required for audit trails, marketplace filtering, and CSRD methodology disclosure.</li>\n<li>data_source: The primary remote sensing or modelling data source used to generate this observation. Controlled vocabulary: sentinel2, planetscope, modelled (no imagery), combined (imagery + model ensemble).</li>\n<li>lulc_classification: The Land Use / Land Cover (LULC) class assigned to this parcel during the observation period, using the LUCAS classification standard. Used to confirm the parcel is in active agricultural use and to flag land use change events that would affect carbon accounting.</li>\n<li>soc_estimate_t_per_ha: The soil organic carbon (SOC) stock on this parcel under the counterfactual baseline scenario (what would have happened without the activity), expressed in tonnes of carbon per hectare. Derived from the GCDC standardised baseline for the parcel's pedoclimatic zone.</li>\n<li>soc_baseline_t_per_ha: The measured or modelled soil organic carbon stock on this parcel at the end of the observation period, in tonnes of carbon per hectare. Compared against soc_baseline_t_ha to determine the net carbon removal signal.</li>\n<li>soc_delta_t_per_ha: The change in soil organic carbon stock between the baseline and the end of the observation period, in tonnes of carbon per hectare. A positive value indicates carbon sequestration. This is the primary carbon removal signal used for the Parcel Snapshot.</li>\n<li>biomass_estimate_t_per_ha: Above-ground biomass carbon stock estimated for this parcel at the end of the observation period, in tonnes of carbon per hectare. Relevant for agroforestry or perennial cropping activities where above-ground woody biomass contributes to the carbon removal claim.</li>\n<li>uncertainty_pct: The percentage uncertainty band around the SOC or biomass estimate, reflecting model error, spatial heterogeneity, and data quality. Required by CRCF methodology rules and used by the Scope 3 marketplace to apply conservative discounting to credit quantities and pricing.</li>\n<li>data_quality_indicator: A tiered quality rating for this dMRV observation, reflecting cloud cover, image resolution, model confidence, and validation against ground-truth samples. Controlled vocabulary: high, medium, low. Used by certifiers and marketplace buyers to assess reliability.</li>\n<li>risk_score: A score between 0 and 1 representing the probability of carbon reversal on this parcel over the monitoring period, produced by the WP4 risk assessment model. A higher score means higher reversal risk. Used by the registry to apply buffer pool deductions and by the marketplace to adjust pricing.</li>\n<li>verification_method: Indicates whether this observation was verified through automated dMRV only, a traditional CRCF third-party audit, or a combination of both. Determines the applicable  pathway.</li>\n<li>generated_by: The name and version of the WP3 processing pipeline or algorithm that produced this observation. Needed for reproducibility, audit trails, and methodology version tracking.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"digital_mrv_observation\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>digital_mrv_observation_id</code>, <code>growing_season_id</code>, <code>parcel_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>growing_season_id</code> → <code>growing_season</code>, <code>parcel_id</code> → <code>parcel</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getdigital_mrv_observationList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"digital_mrv_observation_list":{"type":"array","items":{"type":"object","properties":{"digital_mrv_observation":{"type":"object","properties":{"growing_season_id":{"type":"string"},"observation_date_start":{"type":"string"},"lulc_classification":{"type":"string"},"verification_method":{"type":"string"},"risk_score":{"type":"number"},"data_quality_indicator":{"type":"string"},"uncertainty_pct":{"type":"number"},"soc_baseline_t_per_ha":{"type":"number"},"biomass_estimate_t_per_ha":{"type":"number"},"digital_mrv_protocol":{"type":"string"},"generated_by":{"type":"string"},"observation_date_end":{"type":"string"},"parcel_id":{"type":"string"},"soc_estimate_t_per_ha":{"type":"number"},"data_source":{"type":"string"},"digital_mrv_observation_id":{"type":"string"},"soc_delta_t_per_ha":{"type":"number"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"digital_mrv_observation_list":[{"digital_mrv_observation":{"digital_mrv_observation_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","digital_mrv_observation_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","growing_season_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","observation_date_start":"2026-01-01","observation_date_end":"2026-12-31","digital_mrv_protocol":"WP3-SOC-Sentinel2-v1.2","data_source":"sentinel2","lulc_classification":"cropland_annual","soc_estimate_t_per_ha":42.3,"soc_baseline_t_per_ha":44.1,"soc_delta_t_per_ha":1.8,"biomass_estimate_t_per_ha":3.2,"uncertainty_pct":12.5,"data_quality_indicator":"medium","risk_score":0.08,"verification_method":"dMRV","generated_by":"WP3-pipeline-v2.0.1"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Digital_mrv_observation(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new digital_mrv_observation","description":"<p>Create new digital_mrv_observation.</p>\n<p>A single digital MRV (Monitoring, Reporting and Verification) output record for a parcel, covering a defined monitoring period. dMRV uses satellite imagery, geospatial data, and modelling (from WP3) to quantify soil organic carbon (SOC) and biomass changes continuously and at scale, without requiring a formal CRCF audit for each period. These records feed into Batch NFT issuance at the CRCF registry layer and into Scope 3 marketplace pricing and filtering. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>digital_mrv_observation_id: Unique internal identifier automatically assigned to this dMRV observation record.</li>\n<li>parcel_id: The parcel this observation covers. Links the dMRV result to the parcel geometry, ownership record, and any associated CRCF activity.</li>\n<li>growing_season_id: Optional link to the specific crop season this observation is associated with. Useful when dMRV data is available at crop-season resolution, allowing the carbon signal to be attributed to a particular practice change (e.g., cover cropping in winter 2026).</li>\n<li>observation_date_start: Start date of the monitoring window covered by this dMRV observation. Defines the period over which carbon stock changes are measured. Must align with the activity or reporting period for CRCF or Scope 3 use.</li>\n<li>observation_date_end: End date of the monitoring window. Together with observation_date_start, this defines the observation period. Corporate buyers need this to confirm the period overlaps their reporting year.</li>\n<li>digital_mrv_protocol: The name and version of the dMRV methodology used to produce this estimate. Generated by WP3. Required for audit trails, marketplace filtering, and CSRD methodology disclosure.</li>\n<li>data_source: The primary remote sensing or modelling data source used to generate this observation. Controlled vocabulary: sentinel2, planetscope, modelled (no imagery), combined (imagery + model ensemble).</li>\n<li>lulc_classification: The Land Use / Land Cover (LULC) class assigned to this parcel during the observation period, using the LUCAS classification standard. Used to confirm the parcel is in active agricultural use and to flag land use change events that would affect carbon accounting.</li>\n<li>soc_estimate_t_per_ha: The soil organic carbon (SOC) stock on this parcel under the counterfactual baseline scenario (what would have happened without the activity), expressed in tonnes of carbon per hectare. Derived from the GCDC standardised baseline for the parcel's pedoclimatic zone.</li>\n<li>soc_baseline_t_per_ha: The measured or modelled soil organic carbon stock on this parcel at the end of the observation period, in tonnes of carbon per hectare. Compared against soc_baseline_t_ha to determine the net carbon removal signal.</li>\n<li>soc_delta_t_per_ha: The change in soil organic carbon stock between the baseline and the end of the observation period, in tonnes of carbon per hectare. A positive value indicates carbon sequestration. This is the primary carbon removal signal used for the Parcel Snapshot.</li>\n<li>biomass_estimate_t_per_ha: Above-ground biomass carbon stock estimated for this parcel at the end of the observation period, in tonnes of carbon per hectare. Relevant for agroforestry or perennial cropping activities where above-ground woody biomass contributes to the carbon removal claim.</li>\n<li>uncertainty_pct: The percentage uncertainty band around the SOC or biomass estimate, reflecting model error, spatial heterogeneity, and data quality. Required by CRCF methodology rules and used by the Scope 3 marketplace to apply conservative discounting to credit quantities and pricing.</li>\n<li>data_quality_indicator: A tiered quality rating for this dMRV observation, reflecting cloud cover, image resolution, model confidence, and validation against ground-truth samples. Controlled vocabulary: high, medium, low. Used by certifiers and marketplace buyers to assess reliability.</li>\n<li>risk_score: A score between 0 and 1 representing the probability of carbon reversal on this parcel over the monitoring period, produced by the WP4 risk assessment model. A higher score means higher reversal risk. Used by the registry to apply buffer pool deductions and by the marketplace to adjust pricing.</li>\n<li>verification_method: Indicates whether this observation was verified through automated dMRV only, a traditional CRCF third-party audit, or a combination of both. Determines the applicable  pathway.</li>\n<li>generated_by: The name and version of the WP3 processing pipeline or algorithm that produced this observation. Needed for reproducibility, audit trails, and methodology version tracking.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"digital_mrv_observation\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createdigital_mrv_observation_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"growing_season_id":{"type":"string"},"observation_date_start":{"type":"string"},"lulc_classification":{"type":"string"},"verification_method":{"type":"string"},"risk_score":{"type":"number"},"data_quality_indicator":{"type":"string"},"uncertainty_pct":{"type":"number"},"soc_baseline_t_per_ha":{"type":"number"},"biomass_estimate_t_per_ha":{"type":"number"},"digital_mrv_protocol":{"type":"string"},"generated_by":{"type":"string"},"observation_date_end":{"type":"string"},"parcel_id":{"type":"string"},"soc_estimate_t_per_ha":{"type":"number"},"data_source":{"type":"string"},"digital_mrv_observation_id":{"type":"string"},"soc_delta_t_per_ha":{"type":"number"}}},"example":{"digital_mrv_observation_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","growing_season_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","observation_date_start":"2026-01-01","observation_date_end":"2026-12-31","digital_mrv_protocol":"WP3-SOC-Sentinel2-v1.2","data_source":"sentinel2","lulc_classification":"cropland_annual","soc_estimate_t_per_ha":42.3,"soc_baseline_t_per_ha":44.1,"soc_delta_t_per_ha":1.8,"biomass_estimate_t_per_ha":3.2,"uncertainty_pct":12.5,"data_quality_indicator":"medium","risk_score":0.08,"verification_method":"dMRV","generated_by":"WP3-pipeline-v2.0.1"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"digital_mrv_observation":{"type":"object","properties":{"growing_season_id":{"type":"string"},"observation_date_start":{"type":"string"},"lulc_classification":{"type":"string"},"verification_method":{"type":"string"},"risk_score":{"type":"number"},"data_quality_indicator":{"type":"string"},"uncertainty_pct":{"type":"number"},"soc_baseline_t_per_ha":{"type":"number"},"biomass_estimate_t_per_ha":{"type":"number"},"digital_mrv_protocol":{"type":"string"},"generated_by":{"type":"string"},"observation_date_end":{"type":"string"},"parcel_id":{"type":"string"},"soc_estimate_t_per_ha":{"type":"number"},"data_source":{"type":"string"},"digital_mrv_observation_id":{"type":"string"},"soc_delta_t_per_ha":{"type":"number"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"digital_mrv_observation":{"digital_mrv_observation_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","digital_mrv_observation_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","growing_season_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","observation_date_start":"2026-01-01","observation_date_end":"2026-12-31","digital_mrv_protocol":"WP3-SOC-Sentinel2-v1.2","data_source":"sentinel2","lulc_classification":"cropland_annual","soc_estimate_t_per_ha":42.3,"soc_baseline_t_per_ha":44.1,"soc_delta_t_per_ha":1.8,"biomass_estimate_t_per_ha":3.2,"uncertainty_pct":12.5,"data_quality_indicator":"medium","risk_score":0.08,"verification_method":"dMRV","generated_by":"WP3-pipeline-v2.0.1"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/carbon-credit-batch-on-chain":{"get":{"tags":["_Carbon_credit_batch_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get carbon_credit_batch_on_chain List","description":"<p>Get carbon_credit_batch_on_chain List.</p>\n<p>Cache of CarbonCreditBatchNFT data minted on the OGCR chain (chain id 20253). One record per carbon_credit_batch_id: the units of one unit type issued for an activity over one monitoring period. Each batch owns an ERC-6551 token-bound account that holds its CarbonCredit (ERC-20) balance. Populated by OGCR-chain-cache reading the chain. Join to <code>activity_on_chain</code> on activity_id (or activity_nft_id = token_id) to reach the OBP activity.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_hash: activity_hash stored on-chain: keccak256 of the raw activity entity body.</li>\n<li>activity_id: activity_id this batch was issued for, as stored on-chain.</li>\n<li>activity_name: Activity name as stored on-chain.</li>\n<li>activity_nft_id: ActivityNFT token id this batch was issued against. Join to <code>activity_on_chain</code>.token_id to reach the OBP activity_id.</li>\n<li>activity_url: activity_url stored on-chain: link back to the OBP activity entity.</li>\n<li>amount: Units issued for the batch, fixed at mint, in CarbonCredit base units (18 decimals): 6.5 tonnes is 6500000000000000000. Decimal string because a uint256 does not fit an integer field. The live balance is credit_balance.</li>\n<li>batch_name: Display name of the batch by unit type, as stored on-chain.</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>block_number_balance: Block height the credit_balance was read at. Unlike the mint fields, the balance is current-state, not historical, so it is only true as of this block.</li>\n<li>carbon_credit_batch_id: Business key for this record, as stored on-chain. The contract permits one batch token per id (tokenIdByBatchId), so it is used to match records for upsert.</li>\n<li>certificate_of_compliance_hash: certificate_of_compliance_hash stored on-chain: keccak256 of the raw certificate_of_compliance entity body.</li>\n<li>certificate_of_compliance_uri: certificate_of_compliance_uri stored on-chain: link back to the OBP certificate_of_compliance entity.</li>\n<li>certification_body_hash: certification_body_hash stored on-chain: keccak256 of the raw certification body entity body.</li>\n<li>certification_body_url: certification_body_url stored on-chain: link back to the OBP certification body entity.</li>\n<li>certification_scheme_hash: certification_scheme_hash stored on-chain: keccak256 of the raw certification scheme entity body.</li>\n<li>certification_scheme_url: certification_scheme_url stored on-chain: link back to the OBP certification_scheme entity.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: CarbonCreditBatchNFT contract address the token was read from.</li>\n<li>country_id: Country id as stored on-chain.</li>\n<li>credit_balance: CarbonCredit (ERC-20) balance held by token_bound_account, in smallest units, as read at block_number_balance. Decimal string because a uint256 does not fit an integer field. Divide by 10^credit_decimals for tonnes CO2e. Empty when no CarbonCredit contract address is configured.</li>\n<li>credit_contract_address: CarbonCredit ERC-20 contract address the balance was read from.</li>\n<li>credit_decimals: Decimals of the CarbonCredit ERC-20, for rendering credit_balance. 0 when no CarbonCredit contract address is configured.</li>\n<li>expiry_date: Batch expiry date as stored on-chain.</li>\n<li>issue_date: Batch issue date as stored on-chain.</li>\n<li>monitoring_period_end_date: Monitoring period end date as stored on-chain.</li>\n<li>monitoring_period_start_date: Monitoring period start date as stored on-chain.</li>\n<li>operator_hash: operator_hash stored on-chain: keccak256 of the raw operator entity body.</li>\n<li>operator_url: operator_url stored on-chain: link back to the OBP operator entity.</li>\n<li>owner_address: Current owner of the batch NFT (operator OGCR wallet address). Owning the NFT gates the right to move the credits held in its token-bound account.</li>\n<li>status_code: Batch status as stored on-chain.</li>\n<li>token_bound_account: ERC-6551 token-bound account for this batch. This address holds the batch's CarbonCredit (ERC-20) balance.</li>\n<li>token_id: CarbonCreditBatchNFT token id, unique per contract. Records are matched on carbon_credit_batch_id rather than this, so that the match uses a string field.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI, rendered on-chain from the batch data).</li>\n<li>tx_hash: Mint transaction hash (from the BatchMinted event).</li>\n<li>unit_type: CRCF unit type this batch represents, as stored on-chain.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"carbon_credit_batch_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p><em>(no fields on this entity are declared <code>indexed</code>, so only the legacy bare-parameter filter below is available.)</em></p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getcarbon_credit_batch_on_chainList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"carbon_credit_batch_on_chain_list":{"type":"array","items":{"type":"object","properties":{"carbon_credit_batch_on_chain":{"type":"object","properties":{"activity_nft_id":{"type":"integer"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"block_number_balance":{"type":"integer"},"contract_address":{"type":"string"},"operator_hash":{"type":"string"},"carbon_credit_batch_on_chain_id":{"type":"string"},"unit_type":{"type":"string"},"credit_contract_address":{"type":"string"},"token_uri":{"type":"string"},"certificate_of_compliance_hash":{"type":"string"},"status_code":{"type":"string"},"credit_decimals":{"type":"integer"},"monitoring_period_end_date":{"type":"string"},"amount":{"type":"string"},"issue_date":{"type":"string"},"certificate_of_compliance_uri":{"type":"string"},"activity_url":{"type":"string"},"token_bound_account":{"type":"string"},"certification_scheme_hash":{"type":"string"},"certification_scheme_url":{"type":"string"},"certification_body_url":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"integer"},"activity_name":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"batch_name":{"type":"string"},"operator_url":{"type":"string"},"activity_hash":{"type":"string"},"block_number":{"type":"integer"},"carbon_credit_batch_id":{"type":"string"},"country_id":{"type":"string"},"certification_body_hash":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"},"credit_balance":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"carbon_credit_batch_on_chain_list":[{"carbon_credit_batch_on_chain":{"carbon_credit_batch_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_name":"Reforestation 2024","activity_nft_id":1,"activity_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/activity/activity_AB12CD34EF","amount":"6500000000000000000","batch_name":"Permanent Removals Carbon Credit Batch","block_number":12345,"block_number_balance":12400,"carbon_credit_batch_id":"verification_AB12:permanent_removal","certificate_of_compliance_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certificate_of_compliance_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certificate_of_compliance/coc_AB12CD34EF","certification_body_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_body_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/certification_body/body_VERRA","certification_scheme_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_scheme_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/certification_scheme/scheme_SALUS","chain_id":20253,"contract_address":"0x38cF23C52Bb4B13F051Aec09580a2dE845a7FA35","country_id":"DK","credit_balance":"1000000000000000000","credit_contract_address":"0x1B4bC0dE8b6A1A2b3C4d5E6f7A8b9C0d1E2f3A4b","credit_decimals":18,"expiry_date":"2030-01-01","issue_date":"2025-01-01","monitoring_period_end_date":"2024-12-31","monitoring_period_start_date":"2024-01-01","operator_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","operator_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/operator/op_01JS0347FKH","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","status_code":"issued","token_bound_account":"0x9F2fCc7C4E1C0eA0dB1A0EbD79b0Cc7Ee4c3e5a1","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQmF0Y2gifQ==","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_type":"Permanent Removal"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Carbon_credit_batch_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new carbon_credit_batch_on_chain","description":"<p>Create new carbon_credit_batch_on_chain.</p>\n<p>Cache of CarbonCreditBatchNFT data minted on the OGCR chain (chain id 20253). One record per carbon_credit_batch_id: the units of one unit type issued for an activity over one monitoring period. Each batch owns an ERC-6551 token-bound account that holds its CarbonCredit (ERC-20) balance. Populated by OGCR-chain-cache reading the chain. Join to <code>activity_on_chain</code> on activity_id (or activity_nft_id = token_id) to reach the OBP activity.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_hash: activity_hash stored on-chain: keccak256 of the raw activity entity body.</li>\n<li>activity_id: activity_id this batch was issued for, as stored on-chain.</li>\n<li>activity_name: Activity name as stored on-chain.</li>\n<li>activity_nft_id: ActivityNFT token id this batch was issued against. Join to <code>activity_on_chain</code>.token_id to reach the OBP activity_id.</li>\n<li>activity_url: activity_url stored on-chain: link back to the OBP activity entity.</li>\n<li>amount: Units issued for the batch, fixed at mint, in CarbonCredit base units (18 decimals): 6.5 tonnes is 6500000000000000000. Decimal string because a uint256 does not fit an integer field. The live balance is credit_balance.</li>\n<li>batch_name: Display name of the batch by unit type, as stored on-chain.</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>block_number_balance: Block height the credit_balance was read at. Unlike the mint fields, the balance is current-state, not historical, so it is only true as of this block.</li>\n<li>carbon_credit_batch_id: Business key for this record, as stored on-chain. The contract permits one batch token per id (tokenIdByBatchId), so it is used to match records for upsert.</li>\n<li>certificate_of_compliance_hash: certificate_of_compliance_hash stored on-chain: keccak256 of the raw certificate_of_compliance entity body.</li>\n<li>certificate_of_compliance_uri: certificate_of_compliance_uri stored on-chain: link back to the OBP certificate_of_compliance entity.</li>\n<li>certification_body_hash: certification_body_hash stored on-chain: keccak256 of the raw certification body entity body.</li>\n<li>certification_body_url: certification_body_url stored on-chain: link back to the OBP certification body entity.</li>\n<li>certification_scheme_hash: certification_scheme_hash stored on-chain: keccak256 of the raw certification scheme entity body.</li>\n<li>certification_scheme_url: certification_scheme_url stored on-chain: link back to the OBP certification_scheme entity.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: CarbonCreditBatchNFT contract address the token was read from.</li>\n<li>country_id: Country id as stored on-chain.</li>\n<li>credit_balance: CarbonCredit (ERC-20) balance held by token_bound_account, in smallest units, as read at block_number_balance. Decimal string because a uint256 does not fit an integer field. Divide by 10^credit_decimals for tonnes CO2e. Empty when no CarbonCredit contract address is configured.</li>\n<li>credit_contract_address: CarbonCredit ERC-20 contract address the balance was read from.</li>\n<li>credit_decimals: Decimals of the CarbonCredit ERC-20, for rendering credit_balance. 0 when no CarbonCredit contract address is configured.</li>\n<li>expiry_date: Batch expiry date as stored on-chain.</li>\n<li>issue_date: Batch issue date as stored on-chain.</li>\n<li>monitoring_period_end_date: Monitoring period end date as stored on-chain.</li>\n<li>monitoring_period_start_date: Monitoring period start date as stored on-chain.</li>\n<li>operator_hash: operator_hash stored on-chain: keccak256 of the raw operator entity body.</li>\n<li>operator_url: operator_url stored on-chain: link back to the OBP operator entity.</li>\n<li>owner_address: Current owner of the batch NFT (operator OGCR wallet address). Owning the NFT gates the right to move the credits held in its token-bound account.</li>\n<li>status_code: Batch status as stored on-chain.</li>\n<li>token_bound_account: ERC-6551 token-bound account for this batch. This address holds the batch's CarbonCredit (ERC-20) balance.</li>\n<li>token_id: CarbonCreditBatchNFT token id, unique per contract. Records are matched on carbon_credit_batch_id rather than this, so that the match uses a string field.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI, rendered on-chain from the batch data).</li>\n<li>tx_hash: Mint transaction hash (from the BatchMinted event).</li>\n<li>unit_type: CRCF unit type this batch represents, as stored on-chain.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"carbon_credit_batch_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createcarbon_credit_batch_on_chain_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"activity_nft_id":{"type":"integer"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"block_number_balance":{"type":"integer"},"contract_address":{"type":"string"},"operator_hash":{"type":"string"},"unit_type":{"type":"string"},"credit_contract_address":{"type":"string"},"token_uri":{"type":"string"},"certificate_of_compliance_hash":{"type":"string"},"status_code":{"type":"string"},"credit_decimals":{"type":"integer"},"monitoring_period_end_date":{"type":"string"},"amount":{"type":"string"},"issue_date":{"type":"string"},"certificate_of_compliance_uri":{"type":"string"},"activity_url":{"type":"string"},"token_bound_account":{"type":"string"},"certification_scheme_hash":{"type":"string"},"certification_scheme_url":{"type":"string"},"certification_body_url":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"integer"},"activity_name":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"batch_name":{"type":"string"},"operator_url":{"type":"string"},"activity_hash":{"type":"string"},"block_number":{"type":"integer"},"carbon_credit_batch_id":{"type":"string"},"country_id":{"type":"string"},"certification_body_hash":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"},"credit_balance":{"type":"string"}}},"example":{"activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_name":"Reforestation 2024","activity_nft_id":1,"activity_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/activity/activity_AB12CD34EF","amount":"6500000000000000000","batch_name":"Permanent Removals Carbon Credit Batch","block_number":12345,"block_number_balance":12400,"carbon_credit_batch_id":"verification_AB12:permanent_removal","certificate_of_compliance_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certificate_of_compliance_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certificate_of_compliance/coc_AB12CD34EF","certification_body_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_body_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/certification_body/body_VERRA","certification_scheme_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_scheme_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/certification_scheme/scheme_SALUS","chain_id":20253,"contract_address":"0x38cF23C52Bb4B13F051Aec09580a2dE845a7FA35","country_id":"DK","credit_balance":"1000000000000000000","credit_contract_address":"0x1B4bC0dE8b6A1A2b3C4d5E6f7A8b9C0d1E2f3A4b","credit_decimals":18,"expiry_date":"2030-01-01","issue_date":"2025-01-01","monitoring_period_end_date":"2024-12-31","monitoring_period_start_date":"2024-01-01","operator_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","operator_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/operator/op_01JS0347FKH","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","status_code":"issued","token_bound_account":"0x9F2fCc7C4E1C0eA0dB1A0EbD79b0Cc7Ee4c3e5a1","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQmF0Y2gifQ==","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_type":"Permanent Removal"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"carbon_credit_batch_on_chain":{"type":"object","properties":{"activity_nft_id":{"type":"integer"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"block_number_balance":{"type":"integer"},"contract_address":{"type":"string"},"operator_hash":{"type":"string"},"carbon_credit_batch_on_chain_id":{"type":"string"},"unit_type":{"type":"string"},"credit_contract_address":{"type":"string"},"token_uri":{"type":"string"},"certificate_of_compliance_hash":{"type":"string"},"status_code":{"type":"string"},"credit_decimals":{"type":"integer"},"monitoring_period_end_date":{"type":"string"},"amount":{"type":"string"},"issue_date":{"type":"string"},"certificate_of_compliance_uri":{"type":"string"},"activity_url":{"type":"string"},"token_bound_account":{"type":"string"},"certification_scheme_hash":{"type":"string"},"certification_scheme_url":{"type":"string"},"certification_body_url":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"integer"},"activity_name":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"batch_name":{"type":"string"},"operator_url":{"type":"string"},"activity_hash":{"type":"string"},"block_number":{"type":"integer"},"carbon_credit_batch_id":{"type":"string"},"country_id":{"type":"string"},"certification_body_hash":{"type":"string"},"expiry_date":{"type":"string"},"chain_id":{"type":"integer"},"credit_balance":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"carbon_credit_batch_on_chain":{"carbon_credit_batch_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_name":"Reforestation 2024","activity_nft_id":1,"activity_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/activity/activity_AB12CD34EF","amount":"6500000000000000000","batch_name":"Permanent Removals Carbon Credit Batch","block_number":12345,"block_number_balance":12400,"carbon_credit_batch_id":"verification_AB12:permanent_removal","certificate_of_compliance_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certificate_of_compliance_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/banks/ogcr/certificate_of_compliance/coc_AB12CD34EF","certification_body_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_body_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/certification_body/body_VERRA","certification_scheme_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","certification_scheme_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/certification_scheme/scheme_SALUS","chain_id":20253,"contract_address":"0x38cF23C52Bb4B13F051Aec09580a2dE845a7FA35","country_id":"DK","credit_balance":"1000000000000000000","credit_contract_address":"0x1B4bC0dE8b6A1A2b3C4d5E6f7A8b9C0d1E2f3A4b","credit_decimals":18,"expiry_date":"2030-01-01","issue_date":"2025-01-01","monitoring_period_end_date":"2024-12-31","monitoring_period_start_date":"2024-01-01","operator_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","operator_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/operator/op_01JS0347FKH","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","status_code":"issued","token_bound_account":"0x9F2fCc7C4E1C0eA0dB1A0EbD79b0Cc7Ee4c3e5a1","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQmF0Y2gifQ==","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_type":"Permanent Removal"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/activity":{"get":{"tags":["_Activity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public activity List","description":"<p>Get Public activity List.</p>\n<p>\u2018activity\u2019 means one or more practices or processes carried out by an operator, or a group of operators, resulting in a permanent/temporary carbon removal through carbon farming or carbon storage in products, or soil emission reductions. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_id: Internal identifier for the activity</li>\n<li>name: Human-readable activity name shown in UI and exports.</li>\n<li>summary: 1\u20132 sentence public summary, used in Activity listing.</li>\n<li>description: Longer narrative description (scope, intent, participants, context).</li>\n<li>website: Public URL with activity/operator details</li>\n<li>hero_image: Primary image URL for hero image</li>\n<li>image: Primary image URL or asset reference for UI cards.</li>\n<li>operator_id: Internal identifier for the operator entity</li>\n<li>activity_type: Activity category, based on technologies, practices and processes. (CARBON_FARMING, PERMANENT_REMOVAL, CARBON_STORAGE_IN_PRODUCTS)</li>\n<li>unit_types: Unit category that will be produced during this activity. (Permanent Removal,<br />\nCarbon Farming Sequestration, Soil Emission Reduction, Carbon Storage in Product)</li>\n<li>city: Primary city/municipality associated with the activity</li>\n<li>country_id: ISO 3166-1 alpha-2 country code for where the activity occurs.</li>\n<li>multipolygon_coordinates: GeoJSON MultiPolygon boundary of the activity area.</li>\n<li>start_date: Start date of the activity implementation period (when practices/process begin).</li>\n<li>end_date: End date of the activity implementation period.</li>\n<li>term_commitment: Commitment/contract duration for maintaining practices.</li>\n<li>cobenefits: Declared co-benefits</li>\n<li>methodologies: Methodology IDs/names and versions used to quantify outcomes</li>\n<li>monitoring_period_years: Planned monitoring duration in years</li>\n<li>monitoring_period_start_date: Start date of the monitoring window used for MRV/accounting</li>\n<li>monitoring_period_end_date: End date of the monitoring window</li>\n<li>certification_scheme_id: ID of the certification scheme chosen by the operator.</li>\n<li>internal_note: An internal note that will not be displayed to the public</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>certification_scheme_id</code>, <code>country_id</code>, <code>operator_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPublicactivityList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_list":{"type":"array","items":{"type":"object","properties":{"activity":{"type":"object","properties":{"name":{"type":"string"},"start_date":{"type":"string"},"certification_scheme_id":{"type":"string"},"methodologies":{"type":"string"},"image":{"type":"string"},"description":{"type":"string"},"cobenefits":{"type":"string"},"internal_note":{"type":"string"},"multipolygon_coordinates":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"array","maxItems":2,"minItems":2,"items":{"type":"number"}}}}}}},"activity_type":{"type":"string"},"hero_image":{"type":"string"},"monitoring_period_end_date":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"summary":{"type":"string"},"website":{"type":"string"},"city":{"type":"string"},"term_commitment":{"type":"integer"},"end_date":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"unit_types":{"type":"string"},"monitoring_period_years":{"type":"integer"},"country_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"activity_list":[{"activity":{"activity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"a_05OFWI037022","name":"Brandenburg Regenerative Wheat","summary":"Wheat rotation adopting cover crops and reduced tillage across enrolled parcels.","description":"This activity aggregates multiple parcels under a single operator to monitor practice changes and estimate carbon stock change over the monitoring period.","website":"https://example.org/activities/brandenburg-wheat","hero_image":"https://cdn.example.org/activity-images/activity_123.png","image":"https://cdn.example.org/activity-images/activity_123.png","operator_id":"op_01JS0347FKH","activity_type":"CARBON_FARMING","unit_types":"Soil Emission Reduction","city":"Seelow","country_id":"DE","multipolygon_coordinates":{"type":"MultiPolygon","coordinates":[[[[14.3801,52.5201],[14.3901,52.5201],[14.3901,52.5301],[14.3801,52.5301],[14.3801,52.5201]]]]},"start_date":"2027-01-01","end_date":"2031-12-31","term_commitment":5,"cobenefits":"[\"biodiversity\", \"water_quality\", \"soil_health\"]","methodologies":"[{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}]","monitoring_period_years":5,"monitoring_period_start_date":"2027-01-01","monitoring_period_end_date":"2031-12-31","certification_scheme_id":"CRCF Scheme","internal_note":"I'm flagging this for review"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/reversal-event/{reversaleventid}":{"get":{"tags":["_Reversal_event(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get reversal_event by id","description":"<p>Get reversal_event by id.</p>\n<p>\u2018certificate of compliance\u2019 means a conformity statement issued by a certification body certifying that an activity complies with this Regulation;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>reversal_event_id: Internal identifier for the reversal event</li>\n<li>activity_id: Activity the reversal traces back to</li>\n<li>parcel_id: Parcel(s) affected by the reversal, if reversal is parcel-specific rather than activity-wide</li>\n<li>monitoring_period_id: Monitoring period during which the reversal occurred (Art. 6(2)(a) ties mitigation rules to the monitoring period)</li>\n<li>token_id: The minted unit(s)/token(s) affected \u2014 feeds the state transition to Invalidated/Revoked</li>\n<li>quantity_reversed_tco2e: Amount of carbon released back to the atmosphere, quantified conservatively per Art. 4(12)</li>\n<li>reversal_cause: Cause of the reversal (fire, drought, tillage/ploughing, land-use change, pest/disease, other)</li>\n<li>voluntary_flag: Whether the reversal was voluntary, involuntary, or undetermined (Recital 22 distinction)</li>\n<li>occurrence_date: Date the reversal actually happened</li>\n<li>detected_date: Date the reversal was detected/reported</li>\n<li>detection_source: Who/what detected it (self-report, monitoring system, certifier audit, third-party)</li>\n<li>status_code: Workflow status of the reversal case</li>\n<li>liability_choice_id: Which liability mechanism applies (buffer pool / individual liability / insurance) \u2014 Art. 6(2)(b)</li>\n<li>buffer_pool_drawdown_amount: Amount drawn from the buffer pool to cover the reversal, if applicable</li>\n<li>units_cancelled: Reference(s) to units directly cancelled as last resort (Art. 6(3)(i))</li>\n<li>verification_body_id: Certification body that confirmed the reversal</li>\n<li>audit_report_id: Audit report documenting confirmation of the reversal</li>\n<li>certification_methodology_reference: Which methodology's reversal/liability rules governed this case</li>\n<li>corrective_measures: Remediation actions required/taken</li>\n<li>on_chain_tx_hash: Transaction hash of the invalidation/cancellation event on-chain</li>\n<li>created_at: Record creation timestamp</li>\n<li>updated_at: Last update timestamp</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"reversal_event\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglereversal_event_ogcr","parameters":[{"name":"reversaleventid","in":"path","description":"The REVERSALEVENTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"reversal_event":{"type":"object","properties":{"buffer_pool_drawdown_amount":{"type":"number"},"liability_choice_id":{"type":"string"},"on_chain_tx_hash":{"type":"string"},"verification_body_id":{"type":"string"},"voluntary_flag":{"type":"string"},"certification_methodology_reference":{"type":"string"},"reversal_cause":{"type":"string"},"monitoring_period_id":{"type":"string"},"corrective_measures":{"type":"string"},"parcel_id":{"type":"string"},"updated_at":{"type":"string"},"status_code":{"type":"string"},"quantity_reversed_tco2e":{"type":"number"},"units_cancelled":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"string"},"reversal_event_id":{"type":"string"},"created_at":{"type":"string"},"audit_report_id":{"type":"string"},"detected_date":{"type":"string"},"occurrence_date":{"type":"string"},"detection_source":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"reversal_event":{"reversal_event_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","reversal_event_id":"rev_01HZZ2P3Q4R5S6T7U8V9","activity_id":"a_05OFWI037022","parcel_id":"parcel_03OGNWO397234DQ","monitoring_period_id":"mp_01HZYW8C9R7P4D2A6K1TQ3","token_id":"0xAb58...token_id_42","quantity_reversed_tco2e":6.0,"reversal_cause":"fire","voluntary_flag":"involuntary","occurrence_date":"2028-06-14","detected_date":"2028-06-20","detection_source":"monitoring_system","status_code":"reported / under_review / confirmed / liability_applied / resolved","liability_choice_id":"lc_01HZZ3...","buffer_pool_drawdown_amount":6.0,"units_cancelled":"0xAb58...token_id_42","verification_body_id":"cb_01HZZ1M2A3B4C5D6E7F8","audit_report_id":"ar_01HZZ4...","certification_methodology_reference":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","corrective_measures":"Re-establishment of cover crop, revised monitoring frequency","on_chain_tx_hash":"0x8f2a...c91e","created_at":"2028-06-20","updated_at":"2028-07-01"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Reversal_event(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update reversal_event","description":"<p>Update reversal_event.</p>\n<p>\u2018certificate of compliance\u2019 means a conformity statement issued by a certification body certifying that an activity complies with this Regulation;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>reversal_event_id: Internal identifier for the reversal event</li>\n<li>activity_id: Activity the reversal traces back to</li>\n<li>parcel_id: Parcel(s) affected by the reversal, if reversal is parcel-specific rather than activity-wide</li>\n<li>monitoring_period_id: Monitoring period during which the reversal occurred (Art. 6(2)(a) ties mitigation rules to the monitoring period)</li>\n<li>token_id: The minted unit(s)/token(s) affected \u2014 feeds the state transition to Invalidated/Revoked</li>\n<li>quantity_reversed_tco2e: Amount of carbon released back to the atmosphere, quantified conservatively per Art. 4(12)</li>\n<li>reversal_cause: Cause of the reversal (fire, drought, tillage/ploughing, land-use change, pest/disease, other)</li>\n<li>voluntary_flag: Whether the reversal was voluntary, involuntary, or undetermined (Recital 22 distinction)</li>\n<li>occurrence_date: Date the reversal actually happened</li>\n<li>detected_date: Date the reversal was detected/reported</li>\n<li>detection_source: Who/what detected it (self-report, monitoring system, certifier audit, third-party)</li>\n<li>status_code: Workflow status of the reversal case</li>\n<li>liability_choice_id: Which liability mechanism applies (buffer pool / individual liability / insurance) \u2014 Art. 6(2)(b)</li>\n<li>buffer_pool_drawdown_amount: Amount drawn from the buffer pool to cover the reversal, if applicable</li>\n<li>units_cancelled: Reference(s) to units directly cancelled as last resort (Art. 6(3)(i))</li>\n<li>verification_body_id: Certification body that confirmed the reversal</li>\n<li>audit_report_id: Audit report documenting confirmation of the reversal</li>\n<li>certification_methodology_reference: Which methodology's reversal/liability rules governed this case</li>\n<li>corrective_measures: Remediation actions required/taken</li>\n<li>on_chain_tx_hash: Transaction hash of the invalidation/cancellation event on-chain</li>\n<li>created_at: Record creation timestamp</li>\n<li>updated_at: Last update timestamp</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"reversal_event\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updatereversal_event_ogcr","parameters":[{"name":"reversaleventid","in":"path","description":"The REVERSALEVENTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"buffer_pool_drawdown_amount":{"type":"number"},"liability_choice_id":{"type":"string"},"on_chain_tx_hash":{"type":"string"},"verification_body_id":{"type":"string"},"voluntary_flag":{"type":"string"},"certification_methodology_reference":{"type":"string"},"reversal_cause":{"type":"string"},"monitoring_period_id":{"type":"string"},"corrective_measures":{"type":"string"},"parcel_id":{"type":"string"},"updated_at":{"type":"string"},"status_code":{"type":"string"},"quantity_reversed_tco2e":{"type":"number"},"units_cancelled":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"string"},"reversal_event_id":{"type":"string"},"created_at":{"type":"string"},"audit_report_id":{"type":"string"},"detected_date":{"type":"string"},"occurrence_date":{"type":"string"},"detection_source":{"type":"string"}}},"example":{"reversal_event_id":"rev_01HZZ2P3Q4R5S6T7U8V9","activity_id":"a_05OFWI037022","parcel_id":"parcel_03OGNWO397234DQ","monitoring_period_id":"mp_01HZYW8C9R7P4D2A6K1TQ3","token_id":"0xAb58...token_id_42","quantity_reversed_tco2e":6.0,"reversal_cause":"fire","voluntary_flag":"involuntary","occurrence_date":"2028-06-14","detected_date":"2028-06-20","detection_source":"monitoring_system","status_code":"reported / under_review / confirmed / liability_applied / resolved","liability_choice_id":"lc_01HZZ3...","buffer_pool_drawdown_amount":6.0,"units_cancelled":"0xAb58...token_id_42","verification_body_id":"cb_01HZZ1M2A3B4C5D6E7F8","audit_report_id":"ar_01HZZ4...","certification_methodology_reference":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","corrective_measures":"Re-establishment of cover crop, revised monitoring frequency","on_chain_tx_hash":"0x8f2a...c91e","created_at":"2028-06-20","updated_at":"2028-07-01"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"reversal_event":{"type":"object","properties":{"buffer_pool_drawdown_amount":{"type":"number"},"liability_choice_id":{"type":"string"},"on_chain_tx_hash":{"type":"string"},"verification_body_id":{"type":"string"},"voluntary_flag":{"type":"string"},"certification_methodology_reference":{"type":"string"},"reversal_cause":{"type":"string"},"monitoring_period_id":{"type":"string"},"corrective_measures":{"type":"string"},"parcel_id":{"type":"string"},"updated_at":{"type":"string"},"status_code":{"type":"string"},"quantity_reversed_tco2e":{"type":"number"},"units_cancelled":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"string"},"reversal_event_id":{"type":"string"},"created_at":{"type":"string"},"audit_report_id":{"type":"string"},"detected_date":{"type":"string"},"occurrence_date":{"type":"string"},"detection_source":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"reversal_event":{"reversal_event_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","reversal_event_id":"rev_01HZZ2P3Q4R5S6T7U8V9","activity_id":"a_05OFWI037022","parcel_id":"parcel_03OGNWO397234DQ","monitoring_period_id":"mp_01HZYW8C9R7P4D2A6K1TQ3","token_id":"0xAb58...token_id_42","quantity_reversed_tco2e":6.0,"reversal_cause":"fire","voluntary_flag":"involuntary","occurrence_date":"2028-06-14","detected_date":"2028-06-20","detection_source":"monitoring_system","status_code":"reported / under_review / confirmed / liability_applied / resolved","liability_choice_id":"lc_01HZZ3...","buffer_pool_drawdown_amount":6.0,"units_cancelled":"0xAb58...token_id_42","verification_body_id":"cb_01HZZ1M2A3B4C5D6E7F8","audit_report_id":"ar_01HZZ4...","certification_methodology_reference":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","corrective_measures":"Re-establishment of cover crop, revised monitoring frequency","on_chain_tx_hash":"0x8f2a...c91e","created_at":"2028-06-20","updated_at":"2028-07-01"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Reversal_event(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete reversal_event by id","description":"<p>Delete reversal_event by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"reversal_event\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletereversal_event_ogcr","parameters":[{"name":"reversaleventid","in":"path","description":"The REVERSALEVENTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"reversal_event":{"type":"object","properties":{"buffer_pool_drawdown_amount":{"type":"number"},"liability_choice_id":{"type":"string"},"on_chain_tx_hash":{"type":"string"},"verification_body_id":{"type":"string"},"voluntary_flag":{"type":"string"},"certification_methodology_reference":{"type":"string"},"reversal_cause":{"type":"string"},"monitoring_period_id":{"type":"string"},"corrective_measures":{"type":"string"},"parcel_id":{"type":"string"},"updated_at":{"type":"string"},"status_code":{"type":"string"},"quantity_reversed_tco2e":{"type":"number"},"units_cancelled":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"string"},"reversal_event_id":{"type":"string"},"created_at":{"type":"string"},"audit_report_id":{"type":"string"},"detected_date":{"type":"string"},"occurrence_date":{"type":"string"},"detection_source":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"reversal_event":{"reversal_event_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","reversal_event_id":"rev_01HZZ2P3Q4R5S6T7U8V9","activity_id":"a_05OFWI037022","parcel_id":"parcel_03OGNWO397234DQ","monitoring_period_id":"mp_01HZYW8C9R7P4D2A6K1TQ3","token_id":"0xAb58...token_id_42","quantity_reversed_tco2e":6.0,"reversal_cause":"fire","voluntary_flag":"involuntary","occurrence_date":"2028-06-14","detected_date":"2028-06-20","detection_source":"monitoring_system","status_code":"reported / under_review / confirmed / liability_applied / resolved","liability_choice_id":"lc_01HZZ3...","buffer_pool_drawdown_amount":6.0,"units_cancelled":"0xAb58...token_id_42","verification_body_id":"cb_01HZZ1M2A3B4C5D6E7F8","audit_report_id":"ar_01HZZ4...","certification_methodology_reference":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","corrective_measures":"Re-establishment of cover crop, revised monitoring frequency","on_chain_tx_hash":"0x8f2a...c91e","created_at":"2028-06-20","updated_at":"2028-07-01"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Reversal_event(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update reversal_event","description":"<p>Partially update reversal_event: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>\u2018certificate of compliance\u2019 means a conformity statement issued by a certification body certifying that an activity complies with this Regulation;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>reversal_event_id: Internal identifier for the reversal event</li>\n<li>activity_id: Activity the reversal traces back to</li>\n<li>parcel_id: Parcel(s) affected by the reversal, if reversal is parcel-specific rather than activity-wide</li>\n<li>monitoring_period_id: Monitoring period during which the reversal occurred (Art. 6(2)(a) ties mitigation rules to the monitoring period)</li>\n<li>token_id: The minted unit(s)/token(s) affected \u2014 feeds the state transition to Invalidated/Revoked</li>\n<li>quantity_reversed_tco2e: Amount of carbon released back to the atmosphere, quantified conservatively per Art. 4(12)</li>\n<li>reversal_cause: Cause of the reversal (fire, drought, tillage/ploughing, land-use change, pest/disease, other)</li>\n<li>voluntary_flag: Whether the reversal was voluntary, involuntary, or undetermined (Recital 22 distinction)</li>\n<li>occurrence_date: Date the reversal actually happened</li>\n<li>detected_date: Date the reversal was detected/reported</li>\n<li>detection_source: Who/what detected it (self-report, monitoring system, certifier audit, third-party)</li>\n<li>status_code: Workflow status of the reversal case</li>\n<li>liability_choice_id: Which liability mechanism applies (buffer pool / individual liability / insurance) \u2014 Art. 6(2)(b)</li>\n<li>buffer_pool_drawdown_amount: Amount drawn from the buffer pool to cover the reversal, if applicable</li>\n<li>units_cancelled: Reference(s) to units directly cancelled as last resort (Art. 6(3)(i))</li>\n<li>verification_body_id: Certification body that confirmed the reversal</li>\n<li>audit_report_id: Audit report documenting confirmation of the reversal</li>\n<li>certification_methodology_reference: Which methodology's reversal/liability rules governed this case</li>\n<li>corrective_measures: Remediation actions required/taken</li>\n<li>on_chain_tx_hash: Transaction hash of the invalidation/cancellation event on-chain</li>\n<li>created_at: Record creation timestamp</li>\n<li>updated_at: Last update timestamp</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"reversal_event\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchreversal_event_ogcr","parameters":[{"name":"reversaleventid","in":"path","description":"The REVERSALEVENTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"buffer_pool_drawdown_amount":{"type":"number"},"liability_choice_id":{"type":"string"},"on_chain_tx_hash":{"type":"string"},"verification_body_id":{"type":"string"},"voluntary_flag":{"type":"string"},"certification_methodology_reference":{"type":"string"},"reversal_cause":{"type":"string"},"monitoring_period_id":{"type":"string"},"corrective_measures":{"type":"string"},"parcel_id":{"type":"string"},"updated_at":{"type":"string"},"status_code":{"type":"string"},"quantity_reversed_tco2e":{"type":"number"},"units_cancelled":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"string"},"reversal_event_id":{"type":"string"},"created_at":{"type":"string"},"audit_report_id":{"type":"string"},"detected_date":{"type":"string"},"occurrence_date":{"type":"string"},"detection_source":{"type":"string"}}},"example":{"reversal_event_id":"rev_01HZZ2P3Q4R5S6T7U8V9","activity_id":"a_05OFWI037022","parcel_id":"parcel_03OGNWO397234DQ","monitoring_period_id":"mp_01HZYW8C9R7P4D2A6K1TQ3","token_id":"0xAb58...token_id_42","quantity_reversed_tco2e":6.0,"reversal_cause":"fire","voluntary_flag":"involuntary","occurrence_date":"2028-06-14","detected_date":"2028-06-20","detection_source":"monitoring_system","status_code":"reported / under_review / confirmed / liability_applied / resolved","liability_choice_id":"lc_01HZZ3...","buffer_pool_drawdown_amount":6.0,"units_cancelled":"0xAb58...token_id_42","verification_body_id":"cb_01HZZ1M2A3B4C5D6E7F8","audit_report_id":"ar_01HZZ4...","certification_methodology_reference":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","corrective_measures":"Re-establishment of cover crop, revised monitoring frequency","on_chain_tx_hash":"0x8f2a...c91e","created_at":"2028-06-20","updated_at":"2028-07-01"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"reversal_event":{"type":"object","properties":{"buffer_pool_drawdown_amount":{"type":"number"},"liability_choice_id":{"type":"string"},"on_chain_tx_hash":{"type":"string"},"verification_body_id":{"type":"string"},"voluntary_flag":{"type":"string"},"certification_methodology_reference":{"type":"string"},"reversal_cause":{"type":"string"},"monitoring_period_id":{"type":"string"},"corrective_measures":{"type":"string"},"parcel_id":{"type":"string"},"updated_at":{"type":"string"},"status_code":{"type":"string"},"quantity_reversed_tco2e":{"type":"number"},"units_cancelled":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"string"},"reversal_event_id":{"type":"string"},"created_at":{"type":"string"},"audit_report_id":{"type":"string"},"detected_date":{"type":"string"},"occurrence_date":{"type":"string"},"detection_source":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"reversal_event":{"reversal_event_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","reversal_event_id":"rev_01HZZ2P3Q4R5S6T7U8V9","activity_id":"a_05OFWI037022","parcel_id":"parcel_03OGNWO397234DQ","monitoring_period_id":"mp_01HZYW8C9R7P4D2A6K1TQ3","token_id":"0xAb58...token_id_42","quantity_reversed_tco2e":6.0,"reversal_cause":"fire","voluntary_flag":"involuntary","occurrence_date":"2028-06-14","detected_date":"2028-06-20","detection_source":"monitoring_system","status_code":"reported / under_review / confirmed / liability_applied / resolved","liability_choice_id":"lc_01HZZ3...","buffer_pool_drawdown_amount":6.0,"units_cancelled":"0xAb58...token_id_42","verification_body_id":"cb_01HZZ1M2A3B4C5D6E7F8","audit_report_id":"ar_01HZZ4...","certification_methodology_reference":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","corrective_measures":"Re-establishment of cover crop, revised monitoring frequency","on_chain_tx_hash":"0x8f2a...c91e","created_at":"2028-06-20","updated_at":"2028-07-01"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/activity-non-conformity":{"get":{"tags":["_Activity_non_conformity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get activity_non_conformity List","description":"<p>Get activity_non_conformity List.</p>\n<p>\u2018non-conformity\u2019 means a failure by an operator or a certification body to comply with the rules and procedures, established by the certification scheme, of which they are members or under which they operate. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>category: critical, major and minor</li>\n<li>remediation_timeline: Timeline for remediation of non-conformities</li>\n<li>sanction: Sanction imposed for the non-conformity, e.g. warning, suspension or withdrawal of certification</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_non_conformity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>audit_report_id</code>, <code>certification_body_id</code>, <code>certification_scheme_id</code>, <code>non_conformity_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>audit_report_id</code> → <code>audit_report</code>, <code>certification_body_id</code> → <code>certification_body</code>, <code>certification_scheme_id</code> → <code>certification_scheme</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getactivity_non_conformityList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_non_conformity_list":{"type":"array","items":{"type":"object","properties":{"activity_non_conformity":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"non_conformity_id":{"type":"string"},"sanction":{"type":"string"},"audit_report_id":{"type":"string"},"remediation_timeline":{"type":"string"},"activity_non_conformity_id":{"type":"string"},"certification_body_id":{"type":"string"},"category":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"activity_non_conformity_list":[{"activity_non_conformity":{"activity_non_conformity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","non_conformity_id":"string","audit_report_id":"string","category":"string","remediation_timeline":"string","sanction":"warning","certification_scheme_id":"string","certification_body_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Activity_non_conformity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new activity_non_conformity","description":"<p>Create new activity_non_conformity.</p>\n<p>\u2018non-conformity\u2019 means a failure by an operator or a certification body to comply with the rules and procedures, established by the certification scheme, of which they are members or under which they operate. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>category: critical, major and minor</li>\n<li>remediation_timeline: Timeline for remediation of non-conformities</li>\n<li>sanction: Sanction imposed for the non-conformity, e.g. warning, suspension or withdrawal of certification</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_non_conformity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createactivity_non_conformity_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"non_conformity_id":{"type":"string"},"sanction":{"type":"string"},"audit_report_id":{"type":"string"},"remediation_timeline":{"type":"string"},"certification_body_id":{"type":"string"},"category":{"type":"string"}}},"example":{"non_conformity_id":"string","audit_report_id":"string","category":"string","remediation_timeline":"string","sanction":"warning","certification_scheme_id":"string","certification_body_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_non_conformity":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"non_conformity_id":{"type":"string"},"sanction":{"type":"string"},"audit_report_id":{"type":"string"},"remediation_timeline":{"type":"string"},"activity_non_conformity_id":{"type":"string"},"certification_body_id":{"type":"string"},"category":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_non_conformity":{"activity_non_conformity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","non_conformity_id":"string","audit_report_id":"string","category":"string","remediation_timeline":"string","sanction":"warning","certification_scheme_id":"string","certification_body_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/parcel/{parcelid}":{"get":{"tags":["_Parcel(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get parcel by id","description":"<p>Get parcel by id.</p>\n<p>Parcel' means a geospatially defined unit of land, identified by its boundary geometry. parcel holds the stable, rarely-changing identity of the land (geometry, CRS, official land-registry codes). This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>parcel_id: Internal identifier for the parcel.</li>\n<li>multipolygon_coordinates: GeoJSON MultiPolygon boundary of the parcel.</li>\n<li>coordinate_reference_system: Coordinate Reference System (CRS) identifier that defines how to interpret the geometry coordinates (e.g., EPSG:4326 for WGS84).</li>\n<li>cadastral_reference: Member state national cadastral registry ID</li>\n<li>iacs_codes: Array of identifiers referencing the parcel in the Member State\u2019s IACS (Integrated Administration and Control System). Only if applicable.</li>\n<li>lpis_codes: Identifiers from the Land Parcel Identification System (LPIS) that reference official \u201creference parcels\u201d/land blocks.  Only if applicable.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleparcel_ogcr","parameters":[{"name":"parcelid","in":"path","description":"The PARCELID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel":{"type":"object","properties":{"iacs_codes":{"type":"string"},"multipolygon_coordinates":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"array","maxItems":2,"minItems":2,"items":{"type":"number"}}}}}}},"coordinate_reference_system":{"type":"string"},"parcel_id":{"type":"string"},"cadastral_reference":{"type":"string"},"lpis_codes":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel":{"parcel_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_id":"parcel_03OGNWO397234DQ","multipolygon_coordinates":{"type":"MultiPolygon","coordinates":[[[[13.405,52.52],[13.406,52.52],[13.406,52.521],[13.405,52.521],[13.405,52.52]]]]},"coordinate_reference_system":"EPSG:4326","cadastral_reference":"string","iacs_codes":"DE-BB-IACS-2026-0012345678","lpis_codes":"DE-BB-LPIS-REFPARCEL-0098765432"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Parcel(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update parcel","description":"<p>Update parcel.</p>\n<p>Parcel' means a geospatially defined unit of land, identified by its boundary geometry. parcel holds the stable, rarely-changing identity of the land (geometry, CRS, official land-registry codes). This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>parcel_id: Internal identifier for the parcel.</li>\n<li>multipolygon_coordinates: GeoJSON MultiPolygon boundary of the parcel.</li>\n<li>coordinate_reference_system: Coordinate Reference System (CRS) identifier that defines how to interpret the geometry coordinates (e.g., EPSG:4326 for WGS84).</li>\n<li>cadastral_reference: Member state national cadastral registry ID</li>\n<li>iacs_codes: Array of identifiers referencing the parcel in the Member State\u2019s IACS (Integrated Administration and Control System). Only if applicable.</li>\n<li>lpis_codes: Identifiers from the Land Parcel Identification System (LPIS) that reference official \u201creference parcels\u201d/land blocks.  Only if applicable.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateparcel_ogcr","parameters":[{"name":"parcelid","in":"path","description":"The PARCELID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"iacs_codes":{"type":"string"},"multipolygon_coordinates":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"array","maxItems":2,"minItems":2,"items":{"type":"number"}}}}}}},"coordinate_reference_system":{"type":"string"},"parcel_id":{"type":"string"},"cadastral_reference":{"type":"string"},"lpis_codes":{"type":"string"}}},"example":{"parcel_id":"parcel_03OGNWO397234DQ","multipolygon_coordinates":{"type":"MultiPolygon","coordinates":[[[[13.405,52.52],[13.406,52.52],[13.406,52.521],[13.405,52.521],[13.405,52.52]]]]},"coordinate_reference_system":"EPSG:4326","cadastral_reference":"string","iacs_codes":"DE-BB-IACS-2026-0012345678","lpis_codes":"DE-BB-LPIS-REFPARCEL-0098765432"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel":{"type":"object","properties":{"iacs_codes":{"type":"string"},"multipolygon_coordinates":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"array","maxItems":2,"minItems":2,"items":{"type":"number"}}}}}}},"coordinate_reference_system":{"type":"string"},"parcel_id":{"type":"string"},"cadastral_reference":{"type":"string"},"lpis_codes":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel":{"parcel_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_id":"parcel_03OGNWO397234DQ","multipolygon_coordinates":{"type":"MultiPolygon","coordinates":[[[[13.405,52.52],[13.406,52.52],[13.406,52.521],[13.405,52.521],[13.405,52.52]]]]},"coordinate_reference_system":"EPSG:4326","cadastral_reference":"string","iacs_codes":"DE-BB-IACS-2026-0012345678","lpis_codes":"DE-BB-LPIS-REFPARCEL-0098765432"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Parcel(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete parcel by id","description":"<p>Delete parcel by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteparcel_ogcr","parameters":[{"name":"parcelid","in":"path","description":"The PARCELID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel":{"type":"object","properties":{"iacs_codes":{"type":"string"},"multipolygon_coordinates":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"array","maxItems":2,"minItems":2,"items":{"type":"number"}}}}}}},"coordinate_reference_system":{"type":"string"},"parcel_id":{"type":"string"},"cadastral_reference":{"type":"string"},"lpis_codes":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel":{"parcel_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_id":"parcel_03OGNWO397234DQ","multipolygon_coordinates":{"type":"MultiPolygon","coordinates":[[[[13.405,52.52],[13.406,52.52],[13.406,52.521],[13.405,52.521],[13.405,52.52]]]]},"coordinate_reference_system":"EPSG:4326","cadastral_reference":"string","iacs_codes":"DE-BB-IACS-2026-0012345678","lpis_codes":"DE-BB-LPIS-REFPARCEL-0098765432"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Parcel(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update parcel","description":"<p>Partially update parcel: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Parcel' means a geospatially defined unit of land, identified by its boundary geometry. parcel holds the stable, rarely-changing identity of the land (geometry, CRS, official land-registry codes). This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>parcel_id: Internal identifier for the parcel.</li>\n<li>multipolygon_coordinates: GeoJSON MultiPolygon boundary of the parcel.</li>\n<li>coordinate_reference_system: Coordinate Reference System (CRS) identifier that defines how to interpret the geometry coordinates (e.g., EPSG:4326 for WGS84).</li>\n<li>cadastral_reference: Member state national cadastral registry ID</li>\n<li>iacs_codes: Array of identifiers referencing the parcel in the Member State\u2019s IACS (Integrated Administration and Control System). Only if applicable.</li>\n<li>lpis_codes: Identifiers from the Land Parcel Identification System (LPIS) that reference official \u201creference parcels\u201d/land blocks.  Only if applicable.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchparcel_ogcr","parameters":[{"name":"parcelid","in":"path","description":"The PARCELID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"iacs_codes":{"type":"string"},"multipolygon_coordinates":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"array","maxItems":2,"minItems":2,"items":{"type":"number"}}}}}}},"coordinate_reference_system":{"type":"string"},"parcel_id":{"type":"string"},"cadastral_reference":{"type":"string"},"lpis_codes":{"type":"string"}}},"example":{"parcel_id":"parcel_03OGNWO397234DQ","multipolygon_coordinates":{"type":"MultiPolygon","coordinates":[[[[13.405,52.52],[13.406,52.52],[13.406,52.521],[13.405,52.521],[13.405,52.52]]]]},"coordinate_reference_system":"EPSG:4326","cadastral_reference":"string","iacs_codes":"DE-BB-IACS-2026-0012345678","lpis_codes":"DE-BB-LPIS-REFPARCEL-0098765432"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel":{"type":"object","properties":{"iacs_codes":{"type":"string"},"multipolygon_coordinates":{"type":"object","properties":{"type":{"type":"string"},"coordinates":{"type":"array","items":{"type":"array","items":{"type":"array","items":{"type":"array","maxItems":2,"minItems":2,"items":{"type":"number"}}}}}}},"coordinate_reference_system":{"type":"string"},"parcel_id":{"type":"string"},"cadastral_reference":{"type":"string"},"lpis_codes":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel":{"parcel_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","parcel_id":"parcel_03OGNWO397234DQ","multipolygon_coordinates":{"type":"MultiPolygon","coordinates":[[[[13.405,52.52],[13.406,52.52],[13.406,52.521],[13.405,52.521],[13.405,52.52]]]]},"coordinate_reference_system":"EPSG:4326","cadastral_reference":"string","iacs_codes":"DE-BB-IACS-2026-0012345678","lpis_codes":"DE-BB-LPIS-REFPARCEL-0098765432"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/retirement-certificate":{"get":{"tags":["_Retirement_certificate(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get retirement_certificate List","description":"<p>Get retirement_certificate List.</p>\n<p>Parsed entity retirement_certificate. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>retirement_certificate_id: (uu)id of the retirement certificate</li>\n<li>serial_number: Unique serial number of the retirement certificate</li>\n<li>retirement_event_id: Reference to the retirement event this certificate is certifying.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_certificate\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>certification_body_id</code>, <code>certification_scheme_id</code>, <code>operator_id</code>, <code>retirement_certificate_id</code>, <code>retirement_event_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>activity_id</code> → <code>activity</code>, <code>certification_body_id</code> → <code>certification_body</code>, <code>certification_scheme_id</code> → <code>certification_scheme</code>, <code>operator_id</code> → <code>operator</code>, <code>retirement_event_id</code> → <code>retirement_event</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getretirement_certificateList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_certificate_list":{"type":"array","items":{"type":"object","properties":{"retirement_certificate":{"type":"object","properties":{"end_use":{"type":"string"},"retirement_event_id":{"type":"string"},"retirement_certificate_id":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"activity_name":{"type":"string"},"certification_body_id":{"type":"string"},"serial_number":{"type":"string"},"beneficiary_name":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"retirement_certificate_list":[{"retirement_certificate":{"retirement_certificate_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_certificate_id":"string","serial_number":"string","retirement_event_id":"string","issue_date":"2020-01-01","beneficiary_name":"string","end_use":"string","amount":1.0,"unit_type":"string","activity_id":"string","activity_name":"string","operator_id":"string","certification_scheme_id":"string","certification_body_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Retirement_certificate(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new retirement_certificate","description":"<p>Create new retirement_certificate.</p>\n<p>Parsed entity retirement_certificate. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>retirement_certificate_id: (uu)id of the retirement certificate</li>\n<li>serial_number: Unique serial number of the retirement certificate</li>\n<li>retirement_event_id: Reference to the retirement event this certificate is certifying.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"retirement_certificate\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createretirement_certificate_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"end_use":{"type":"string"},"retirement_event_id":{"type":"string"},"retirement_certificate_id":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"activity_name":{"type":"string"},"certification_body_id":{"type":"string"},"serial_number":{"type":"string"},"beneficiary_name":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"}}},"example":{"retirement_certificate_id":"string","serial_number":"string","retirement_event_id":"string","issue_date":"2020-01-01","beneficiary_name":"string","end_use":"string","amount":1.0,"unit_type":"string","activity_id":"string","activity_name":"string","operator_id":"string","certification_scheme_id":"string","certification_body_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"retirement_certificate":{"type":"object","properties":{"end_use":{"type":"string"},"retirement_event_id":{"type":"string"},"retirement_certificate_id":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"activity_name":{"type":"string"},"certification_body_id":{"type":"string"},"serial_number":{"type":"string"},"beneficiary_name":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"retirement_certificate":{"retirement_certificate_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","retirement_certificate_id":"string","serial_number":"string","retirement_event_id":"string","issue_date":"2020-01-01","beneficiary_name":"string","end_use":"string","amount":1.0,"unit_type":"string","activity_id":"string","activity_name":"string","operator_id":"string","certification_scheme_id":"string","certification_body_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/user-certification-body-relationship":{"get":{"tags":["_User_certification_body_relationship(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get user_certification_body_relationship List","description":"<p>Get user_certification_body_relationship List.</p>\n<p>Describes the relationship between a User (the logged in User via OAuth2/OIDC or a Consent) and the Certification Body. This intersecting entity allows a many to many relationship between Users and Certification Bodies. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>user_id: (Authenticated) User</li>\n<li>certification_body_id: the certification body (uu)id</li>\n<li>relationship_to_certification_body: relationship describes the user's relationship to the certification body: the user is the subject, the certification body is the  object</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"user_certification_body_relationship\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p><em>(no fields on this entity are declared <code>indexed</code>, so only the legacy bare-parameter filter below is available.)</em></p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getuser_certification_body_relationshipList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"user_certification_body_relationship_list":{"type":"array","items":{"type":"object","properties":{"user_certification_body_relationship":{"type":"object","properties":{"user_certification_body_relationship_id":{"type":"string"},"user_id":{"type":"string"},"certification_body_id":{"type":"string"},"relationship_to_certification_body":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"user_certification_body_relationship_list":[{"user_certification_body_relationship":{"user_certification_body_relationship_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_certification_body":"Managing Director, Employee, Accountant"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_User_certification_body_relationship(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new user_certification_body_relationship","description":"<p>Create new user_certification_body_relationship.</p>\n<p>Describes the relationship between a User (the logged in User via OAuth2/OIDC or a Consent) and the Certification Body. This intersecting entity allows a many to many relationship between Users and Certification Bodies. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>user_id: (Authenticated) User</li>\n<li>certification_body_id: the certification body (uu)id</li>\n<li>relationship_to_certification_body: relationship describes the user's relationship to the certification body: the user is the subject, the certification body is the  object</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"user_certification_body_relationship\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createuser_certification_body_relationship_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string"},"certification_body_id":{"type":"string"},"relationship_to_certification_body":{"type":"string"}}},"example":{"user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_certification_body":"Managing Director, Employee, Accountant"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"user_certification_body_relationship":{"type":"object","properties":{"user_certification_body_relationship_id":{"type":"string"},"user_id":{"type":"string"},"certification_body_id":{"type":"string"},"relationship_to_certification_body":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"user_certification_body_relationship":{"user_certification_body_relationship_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_certification_body":"Managing Director, Employee, Accountant"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/carbon-credit-batch/{carboncreditbatchid}":{"get":{"tags":["_Carbon_credit_batch(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get carbon_credit_batch by id","description":"<p>Get carbon_credit_batch by id.</p>\n<p>One batch of certified carbon credit units issued for an activity over one monitoring period after certification or re-certification. Represented by a Batch NFT. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>carbon_credit_batch_id: Internal identifier for the batch</li>\n<li>activity_id: Activity that generated the units</li>\n<li>certificate_of_compliance_id: Certificate (or updated certificate after re-certification) the units were issued from</li>\n<li>unit_type: Permanent Removal, Carbon Farming Sequestration, Soil Emission Reduction or Carbon Storage in Product</li>\n<li>status_code: Unit status: issued, retired, expired, cancelled</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"carbon_credit_batch\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglecarbon_credit_batch_ogcr","parameters":[{"name":"carboncreditbatchid","in":"path","description":"The CARBONCREDITBATCHID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"carbon_credit_batch":{"type":"object","properties":{"unit_type":{"type":"string"},"status_code":{"type":"string"},"activity_id":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"carbon_credit_batch_id":{"type":"string"},"expiry_date":{"type":"string"},"monitoring_period_end_date":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"carbon_credit_batch":{"carbon_credit_batch_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","carbon_credit_batch_id":"string","activity_id":"string","certificate_of_compliance_id":"string","unit_type":"Soil Emission Reduction","monitoring_period_start_date":"2020-01-01","monitoring_period_end_date":"2020-01-01","amount":1.0,"status_code":"string","issue_date":"2020-01-01","expiry_date":"2020-01-01"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Carbon_credit_batch(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update carbon_credit_batch","description":"<p>Update carbon_credit_batch.</p>\n<p>One batch of certified carbon credit units issued for an activity over one monitoring period after certification or re-certification. Represented by a Batch NFT. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>carbon_credit_batch_id: Internal identifier for the batch</li>\n<li>activity_id: Activity that generated the units</li>\n<li>certificate_of_compliance_id: Certificate (or updated certificate after re-certification) the units were issued from</li>\n<li>unit_type: Permanent Removal, Carbon Farming Sequestration, Soil Emission Reduction or Carbon Storage in Product</li>\n<li>status_code: Unit status: issued, retired, expired, cancelled</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"carbon_credit_batch\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updatecarbon_credit_batch_ogcr","parameters":[{"name":"carboncreditbatchid","in":"path","description":"The CARBONCREDITBATCHID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"unit_type":{"type":"string"},"status_code":{"type":"string"},"activity_id":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"carbon_credit_batch_id":{"type":"string"},"expiry_date":{"type":"string"},"monitoring_period_end_date":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"}}},"example":{"carbon_credit_batch_id":"string","activity_id":"string","certificate_of_compliance_id":"string","unit_type":"Soil Emission Reduction","monitoring_period_start_date":"2020-01-01","monitoring_period_end_date":"2020-01-01","amount":1.0,"status_code":"string","issue_date":"2020-01-01","expiry_date":"2020-01-01"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"carbon_credit_batch":{"type":"object","properties":{"unit_type":{"type":"string"},"status_code":{"type":"string"},"activity_id":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"carbon_credit_batch_id":{"type":"string"},"expiry_date":{"type":"string"},"monitoring_period_end_date":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"carbon_credit_batch":{"carbon_credit_batch_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","carbon_credit_batch_id":"string","activity_id":"string","certificate_of_compliance_id":"string","unit_type":"Soil Emission Reduction","monitoring_period_start_date":"2020-01-01","monitoring_period_end_date":"2020-01-01","amount":1.0,"status_code":"string","issue_date":"2020-01-01","expiry_date":"2020-01-01"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Carbon_credit_batch(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete carbon_credit_batch by id","description":"<p>Delete carbon_credit_batch by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"carbon_credit_batch\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletecarbon_credit_batch_ogcr","parameters":[{"name":"carboncreditbatchid","in":"path","description":"The CARBONCREDITBATCHID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"carbon_credit_batch":{"type":"object","properties":{"unit_type":{"type":"string"},"status_code":{"type":"string"},"activity_id":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"carbon_credit_batch_id":{"type":"string"},"expiry_date":{"type":"string"},"monitoring_period_end_date":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"carbon_credit_batch":{"carbon_credit_batch_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","carbon_credit_batch_id":"string","activity_id":"string","certificate_of_compliance_id":"string","unit_type":"Soil Emission Reduction","monitoring_period_start_date":"2020-01-01","monitoring_period_end_date":"2020-01-01","amount":1.0,"status_code":"string","issue_date":"2020-01-01","expiry_date":"2020-01-01"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Carbon_credit_batch(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update carbon_credit_batch","description":"<p>Partially update carbon_credit_batch: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>One batch of certified carbon credit units issued for an activity over one monitoring period after certification or re-certification. Represented by a Batch NFT. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>carbon_credit_batch_id: Internal identifier for the batch</li>\n<li>activity_id: Activity that generated the units</li>\n<li>certificate_of_compliance_id: Certificate (or updated certificate after re-certification) the units were issued from</li>\n<li>unit_type: Permanent Removal, Carbon Farming Sequestration, Soil Emission Reduction or Carbon Storage in Product</li>\n<li>status_code: Unit status: issued, retired, expired, cancelled</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"carbon_credit_batch\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchcarbon_credit_batch_ogcr","parameters":[{"name":"carboncreditbatchid","in":"path","description":"The CARBONCREDITBATCHID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"unit_type":{"type":"string"},"status_code":{"type":"string"},"activity_id":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"carbon_credit_batch_id":{"type":"string"},"expiry_date":{"type":"string"},"monitoring_period_end_date":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"}}},"example":{"carbon_credit_batch_id":"string","activity_id":"string","certificate_of_compliance_id":"string","unit_type":"Soil Emission Reduction","monitoring_period_start_date":"2020-01-01","monitoring_period_end_date":"2020-01-01","amount":1.0,"status_code":"string","issue_date":"2020-01-01","expiry_date":"2020-01-01"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"carbon_credit_batch":{"type":"object","properties":{"unit_type":{"type":"string"},"status_code":{"type":"string"},"activity_id":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"carbon_credit_batch_id":{"type":"string"},"expiry_date":{"type":"string"},"monitoring_period_end_date":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"carbon_credit_batch":{"carbon_credit_batch_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","carbon_credit_batch_id":"string","activity_id":"string","certificate_of_compliance_id":"string","unit_type":"Soil Emission Reduction","monitoring_period_start_date":"2020-01-01","monitoring_period_end_date":"2020-01-01","amount":1.0,"status_code":"string","issue_date":"2020-01-01","expiry_date":"2020-01-01"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/activity-monitoring-period-verification":{"get":{"tags":["_Activity_monitoring_period_verification(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get activity_monitoring_period_verification List","description":"<p>Get activity_monitoring_period_verification List.</p>\n<p>Parsed entity activity_monitoring_period_verification. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_id: ID of the project verified</li>\n<li>certificate_of_compliance_id: ID of the certificate</li>\n<li>activity_plan_id: ID of the activity plan</li>\n<li>monitoring_plan_id: ID of the monitoring plan</li>\n<li>status_code: in_progress, verified, failed</li>\n<li>start_date: Start date of the monitoring period</li>\n<li>end_date: End date of the monitoring period</li>\n<li>status_message: further explanation of status code</li>\n<li>permanent_net_carbon_removal_benefit: Confirmed amount of CO2e tonnes removed under permanent removals</li>\n<li>carbon_farming_temporary_net_carbon_removal_benefit: Confirmed amount of CO2e tonnes removed under carbon farming temporary practices</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: Confirmed amount of CO2e tonnes reduced under soil emission reductions</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: Confirmed amount of CO2e tonnes removed or reduced</li>\n<li>buffer_contribution_pct: Percentage of units to send to buffer pool. Only if liability_choice connected to activity is equal to buffer_pool</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_monitoring_period_verification\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>activity_monitoring_period_verification_id</code>, <code>activity_plan_id</code>, <code>certificate_of_compliance_id</code>, <code>monitoring_plan_id</code>, <code>status_code</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>activity_id</code> → <code>activity</code>, <code>activity_plan_id</code> → <code>activity_plan</code>, <code>certificate_of_compliance_id</code> → <code>certificate_of_compliance</code>, <code>monitoring_plan_id</code> → <code>monitoring_plan</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getactivity_monitoring_period_verificationList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_monitoring_period_verification_list":{"type":"array","items":{"type":"object","properties":{"activity_monitoring_period_verification":{"type":"object","properties":{"activity_monitoring_period_verification_id":{"type":"string"},"start_date":{"type":"string"},"activity_plan_id":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"buffer_contribution_pct":{"type":"integer"},"status_code":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"activity_id":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"monitoring_plan_id":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"end_date":{"type":"string"},"status_message":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"activity_monitoring_period_verification_list":[{"activity_monitoring_period_verification":{"activity_monitoring_period_verification_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_monitoring_period_verification_id":"string","activity_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certificate_of_compliance_id":"string","activity_plan_id":"string","monitoring_plan_id":"string","status_code":"verified","start_date":"2020-01-01","end_date":"2020-01-01","status_message":"Reversal occurred","permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"buffer_contribution_pct":5},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Activity_monitoring_period_verification(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new activity_monitoring_period_verification","description":"<p>Create new activity_monitoring_period_verification.</p>\n<p>Parsed entity activity_monitoring_period_verification. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_id: ID of the project verified</li>\n<li>certificate_of_compliance_id: ID of the certificate</li>\n<li>activity_plan_id: ID of the activity plan</li>\n<li>monitoring_plan_id: ID of the monitoring plan</li>\n<li>status_code: in_progress, verified, failed</li>\n<li>start_date: Start date of the monitoring period</li>\n<li>end_date: End date of the monitoring period</li>\n<li>status_message: further explanation of status code</li>\n<li>permanent_net_carbon_removal_benefit: Confirmed amount of CO2e tonnes removed under permanent removals</li>\n<li>carbon_farming_temporary_net_carbon_removal_benefit: Confirmed amount of CO2e tonnes removed under carbon farming temporary practices</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: Confirmed amount of CO2e tonnes reduced under soil emission reductions</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: Confirmed amount of CO2e tonnes removed or reduced</li>\n<li>buffer_contribution_pct: Percentage of units to send to buffer pool. Only if liability_choice connected to activity is equal to buffer_pool</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_monitoring_period_verification\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createactivity_monitoring_period_verification_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"activity_monitoring_period_verification_id":{"type":"string"},"start_date":{"type":"string"},"activity_plan_id":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"buffer_contribution_pct":{"type":"integer"},"status_code":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"activity_id":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"monitoring_plan_id":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"end_date":{"type":"string"},"status_message":{"type":"string"}}},"example":{"activity_monitoring_period_verification_id":"string","activity_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certificate_of_compliance_id":"string","activity_plan_id":"string","monitoring_plan_id":"string","status_code":"verified","start_date":"2020-01-01","end_date":"2020-01-01","status_message":"Reversal occurred","permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"buffer_contribution_pct":5}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_monitoring_period_verification":{"type":"object","properties":{"activity_monitoring_period_verification_id":{"type":"string"},"start_date":{"type":"string"},"activity_plan_id":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"buffer_contribution_pct":{"type":"integer"},"status_code":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"activity_id":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"monitoring_plan_id":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"end_date":{"type":"string"},"status_message":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_monitoring_period_verification":{"activity_monitoring_period_verification_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_monitoring_period_verification_id":"string","activity_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certificate_of_compliance_id":"string","activity_plan_id":"string","monitoring_plan_id":"string","status_code":"verified","start_date":"2020-01-01","end_date":"2020-01-01","status_message":"Reversal occurred","permanent_net_carbon_removal_benefit":5.5,"carbon_farming_temporary_net_carbon_removal_benefit":5.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"buffer_contribution_pct":5},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/crop/{cropid}":{"get":{"tags":["_Crop(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get crop by id","description":"<p>Get crop by id.</p>\n<p>A reference table of agricultural crop types. Each record defines a crop category with its commodity classification. growing_season records (below) reference this entity for each instance of a crop grown on a parcel. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>crop_id: Unique internal identifier automatically assigned to each crop type entry.</li>\n<li>crop_type: The specific type of crop, drawn from a controlled vocabulary to ensure consistency across the registry. Used to classify and filter parcels by crop in the supply shed view.</li>\n<li>local_name: The local or vernacular name for the crop as used by the farmer or in the national context. Optional, for display and farmer-facing interfaces only.</li>\n<li>commodity_category: The broad commodity group this crop belongs to, used to aggregate parcels into supply sheds for Scope 3 reporting. Examples: cereals, oilseeds, legumes, forage, vegetables.</li>\n<li>lca_emission_factor: The lifecycle assessment (LCA) emission factor for this crop type, expressed in kilograms of CO2 equivalent per tonne of harvested product. Sourced from IPCC, JRC or Ecoinvent reference datasets \u2014 not entered by farmers. Used by the Scope 3 marketplace to compute emission intensity per sourced tonne.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"crop\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglecrop_ogcr","parameters":[{"name":"cropid","in":"path","description":"The CROPID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"crop":{"type":"object","properties":{"crop_id":{"type":"string"},"lca_emission_factor":{"type":"number"},"commodity_category":{"type":"string"},"local_name":{"type":"string"},"crop_type":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"crop":{"crop_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","crop_id":"crop_01JS0347FKH","crop_type":"winter_wheat","local_name":"Winterweizen","commodity_category":"cereals","lca_emission_factor":0.52},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Crop(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update crop","description":"<p>Update crop.</p>\n<p>A reference table of agricultural crop types. Each record defines a crop category with its commodity classification. growing_season records (below) reference this entity for each instance of a crop grown on a parcel. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>crop_id: Unique internal identifier automatically assigned to each crop type entry.</li>\n<li>crop_type: The specific type of crop, drawn from a controlled vocabulary to ensure consistency across the registry. Used to classify and filter parcels by crop in the supply shed view.</li>\n<li>local_name: The local or vernacular name for the crop as used by the farmer or in the national context. Optional, for display and farmer-facing interfaces only.</li>\n<li>commodity_category: The broad commodity group this crop belongs to, used to aggregate parcels into supply sheds for Scope 3 reporting. Examples: cereals, oilseeds, legumes, forage, vegetables.</li>\n<li>lca_emission_factor: The lifecycle assessment (LCA) emission factor for this crop type, expressed in kilograms of CO2 equivalent per tonne of harvested product. Sourced from IPCC, JRC or Ecoinvent reference datasets \u2014 not entered by farmers. Used by the Scope 3 marketplace to compute emission intensity per sourced tonne.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"crop\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updatecrop_ogcr","parameters":[{"name":"cropid","in":"path","description":"The CROPID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"crop_id":{"type":"string"},"lca_emission_factor":{"type":"number"},"commodity_category":{"type":"string"},"local_name":{"type":"string"},"crop_type":{"type":"string"}}},"example":{"crop_id":"crop_01JS0347FKH","crop_type":"winter_wheat","local_name":"Winterweizen","commodity_category":"cereals","lca_emission_factor":0.52}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"crop":{"type":"object","properties":{"crop_id":{"type":"string"},"lca_emission_factor":{"type":"number"},"commodity_category":{"type":"string"},"local_name":{"type":"string"},"crop_type":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"crop":{"crop_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","crop_id":"crop_01JS0347FKH","crop_type":"winter_wheat","local_name":"Winterweizen","commodity_category":"cereals","lca_emission_factor":0.52},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Crop(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete crop by id","description":"<p>Delete crop by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"crop\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletecrop_ogcr","parameters":[{"name":"cropid","in":"path","description":"The CROPID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"crop":{"type":"object","properties":{"crop_id":{"type":"string"},"lca_emission_factor":{"type":"number"},"commodity_category":{"type":"string"},"local_name":{"type":"string"},"crop_type":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"crop":{"crop_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","crop_id":"crop_01JS0347FKH","crop_type":"winter_wheat","local_name":"Winterweizen","commodity_category":"cereals","lca_emission_factor":0.52},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Crop(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update crop","description":"<p>Partially update crop: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>A reference table of agricultural crop types. Each record defines a crop category with its commodity classification. growing_season records (below) reference this entity for each instance of a crop grown on a parcel. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>crop_id: Unique internal identifier automatically assigned to each crop type entry.</li>\n<li>crop_type: The specific type of crop, drawn from a controlled vocabulary to ensure consistency across the registry. Used to classify and filter parcels by crop in the supply shed view.</li>\n<li>local_name: The local or vernacular name for the crop as used by the farmer or in the national context. Optional, for display and farmer-facing interfaces only.</li>\n<li>commodity_category: The broad commodity group this crop belongs to, used to aggregate parcels into supply sheds for Scope 3 reporting. Examples: cereals, oilseeds, legumes, forage, vegetables.</li>\n<li>lca_emission_factor: The lifecycle assessment (LCA) emission factor for this crop type, expressed in kilograms of CO2 equivalent per tonne of harvested product. Sourced from IPCC, JRC or Ecoinvent reference datasets \u2014 not entered by farmers. Used by the Scope 3 marketplace to compute emission intensity per sourced tonne.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"crop\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchcrop_ogcr","parameters":[{"name":"cropid","in":"path","description":"The CROPID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"crop_id":{"type":"string"},"lca_emission_factor":{"type":"number"},"commodity_category":{"type":"string"},"local_name":{"type":"string"},"crop_type":{"type":"string"}}},"example":{"crop_id":"crop_01JS0347FKH","crop_type":"winter_wheat","local_name":"Winterweizen","commodity_category":"cereals","lca_emission_factor":0.52}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"crop":{"type":"object","properties":{"crop_id":{"type":"string"},"lca_emission_factor":{"type":"number"},"commodity_category":{"type":"string"},"local_name":{"type":"string"},"crop_type":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"crop":{"crop_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","crop_id":"crop_01JS0347FKH","crop_type":"winter_wheat","local_name":"Winterweizen","commodity_category":"cereals","lca_emission_factor":0.52},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/user-operator-relationship/{useroperatorrelationshipid}":{"get":{"tags":["_User_operator_relationship(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get user_operator_relationship by id","description":"<p>Get user_operator_relationship by id.</p>\n<p>Describes the relationship between a User (the logged in User via OAuth2/OIDC or a Consent) and the Operator. This intersecting entity allows a many to many relationship between Users and Operators. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>user_id: (Authenticated) User</li>\n<li>operator_id: the operator (uu)id</li>\n<li>relationship_to_operator: relationship describes the user's relationship to the operator: the user is the subject, the operator is the  object</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"user_operator_relationship\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleuser_operator_relationship_ogcr","parameters":[{"name":"useroperatorrelationshipid","in":"path","description":"The USEROPERATORRELATIONSHIPID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"user_operator_relationship":{"type":"object","properties":{"user_operator_relationship_id":{"type":"string"},"user_id":{"type":"string"},"operator_id":{"type":"string"},"relationship_to_operator":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"user_operator_relationship":{"user_operator_relationship_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","operator_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_operator":"Managing Director, Employee, Accountant"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_User_operator_relationship(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update user_operator_relationship","description":"<p>Update user_operator_relationship.</p>\n<p>Describes the relationship between a User (the logged in User via OAuth2/OIDC or a Consent) and the Operator. This intersecting entity allows a many to many relationship between Users and Operators. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>user_id: (Authenticated) User</li>\n<li>operator_id: the operator (uu)id</li>\n<li>relationship_to_operator: relationship describes the user's relationship to the operator: the user is the subject, the operator is the  object</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"user_operator_relationship\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateuser_operator_relationship_ogcr","parameters":[{"name":"useroperatorrelationshipid","in":"path","description":"The USEROPERATORRELATIONSHIPID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string"},"operator_id":{"type":"string"},"relationship_to_operator":{"type":"string"}}},"example":{"user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","operator_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_operator":"Managing Director, Employee, Accountant"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"user_operator_relationship":{"type":"object","properties":{"user_operator_relationship_id":{"type":"string"},"user_id":{"type":"string"},"operator_id":{"type":"string"},"relationship_to_operator":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"user_operator_relationship":{"user_operator_relationship_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","operator_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_operator":"Managing Director, Employee, Accountant"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_User_operator_relationship(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete user_operator_relationship by id","description":"<p>Delete user_operator_relationship by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"user_operator_relationship\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteuser_operator_relationship_ogcr","parameters":[{"name":"useroperatorrelationshipid","in":"path","description":"The USEROPERATORRELATIONSHIPID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"user_operator_relationship":{"type":"object","properties":{"user_operator_relationship_id":{"type":"string"},"user_id":{"type":"string"},"operator_id":{"type":"string"},"relationship_to_operator":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"user_operator_relationship":{"user_operator_relationship_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","operator_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_operator":"Managing Director, Employee, Accountant"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_User_operator_relationship(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update user_operator_relationship","description":"<p>Partially update user_operator_relationship: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Describes the relationship between a User (the logged in User via OAuth2/OIDC or a Consent) and the Operator. This intersecting entity allows a many to many relationship between Users and Operators. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>user_id: (Authenticated) User</li>\n<li>operator_id: the operator (uu)id</li>\n<li>relationship_to_operator: relationship describes the user's relationship to the operator: the user is the subject, the operator is the  object</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"user_operator_relationship\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchuser_operator_relationship_ogcr","parameters":[{"name":"useroperatorrelationshipid","in":"path","description":"The USEROPERATORRELATIONSHIPID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string"},"operator_id":{"type":"string"},"relationship_to_operator":{"type":"string"}}},"example":{"user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","operator_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_operator":"Managing Director, Employee, Accountant"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"user_operator_relationship":{"type":"object","properties":{"user_operator_relationship_id":{"type":"string"},"user_id":{"type":"string"},"operator_id":{"type":"string"},"relationship_to_operator":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"user_operator_relationship":{"user_operator_relationship_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","user_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","operator_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","relationship_to_operator":"Managing Director, Employee, Accountant"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/buffer-pool":{"get":{"tags":["_Buffer_pool(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get buffer_pool List","description":"<p>Get buffer_pool List.</p>\n<p>Parsed entity buffer_pool. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>buffer_pool_id: (uu)id of the buffer pool</li>\n<li>name: Human-readable name</li>\n<li>activity_id: ID of the activity</li>\n<li>unit_type: Which unit type it holds (the CRCF requires unit types to stay distinct)</li>\n<li>certification_scheme_id: Scheme that runs the pool</li>\n<li>rules_uri: The document defining contribution, cancellation and release rules</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"buffer_pool\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>buffer_pool_id</code>, <code>certification_scheme_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>activity_id</code> → <code>activity</code>, <code>certification_scheme_id</code> → <code>certification_scheme</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getbuffer_poolList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"buffer_pool_list":{"type":"array","items":{"type":"object","properties":{"buffer_pool":{"type":"object","properties":{"name":{"type":"string"},"buffer_pool_id":{"type":"string"},"activity_id":{"type":"string"},"rules_uri":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"buffer_pool_list":[{"buffer_pool":{"buffer_pool_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","buffer_pool_id":"string","name":"string","activity_id":"string","unit_type":"string","certification_scheme_id":"string","rules_uri":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Buffer_pool(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new buffer_pool","description":"<p>Create new buffer_pool.</p>\n<p>Parsed entity buffer_pool. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>buffer_pool_id: (uu)id of the buffer pool</li>\n<li>name: Human-readable name</li>\n<li>activity_id: ID of the activity</li>\n<li>unit_type: Which unit type it holds (the CRCF requires unit types to stay distinct)</li>\n<li>certification_scheme_id: Scheme that runs the pool</li>\n<li>rules_uri: The document defining contribution, cancellation and release rules</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"buffer_pool\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createbuffer_pool_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"buffer_pool_id":{"type":"string"},"activity_id":{"type":"string"},"rules_uri":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"}}},"example":{"buffer_pool_id":"string","name":"string","activity_id":"string","unit_type":"string","certification_scheme_id":"string","rules_uri":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"buffer_pool":{"type":"object","properties":{"name":{"type":"string"},"buffer_pool_id":{"type":"string"},"activity_id":{"type":"string"},"rules_uri":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"buffer_pool":{"buffer_pool_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","buffer_pool_id":"string","name":"string","activity_id":"string","unit_type":"string","certification_scheme_id":"string","rules_uri":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/supervisory-non-conformity":{"get":{"tags":["_Supervisory_non_conformity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public supervisory_non_conformity List","description":"<p>Get Public supervisory_non_conformity List.</p>\n<p>\u2018non-conformity\u2019 means a failure by an operator or a certification body to comply with the rules and procedures, established by the certification scheme, of which they are members or under which they operate. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>category: critical, major and minor</li>\n<li>remediation_timeline: Timeline for remediation of non-conformities</li>\n<li>sanction: Sanction imposed for the non-conformity, e.g. warning, suspension or withdrawal of certification</li>\n<li>certification_body_id: The certification body this non  conformity refers to</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"supervisory_non_conformity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>audit_report_id</code>, <code>certification_body_id</code>, <code>certification_scheme_id</code>, <code>supervisory_finding_id</code>, <code>supervisory_non_conformity_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPublicsupervisory_non_conformityList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"supervisory_non_conformity_list":{"type":"array","items":{"type":"object","properties":{"supervisory_non_conformity":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"sanction":{"type":"string"},"audit_report_id":{"type":"string"},"supervisory_finding_id":{"type":"string"},"remediation_timeline":{"type":"string"},"supervisory_non_conformity_id":{"type":"string"},"certification_body_id":{"type":"string"},"category":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"supervisory_non_conformity_list":[{"supervisory_non_conformity":{"supervisory_non_conformity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supervisory_non_conformity_id":"string","supervisory_finding_id":"string","audit_report_id":"string","category":"string","remediation_timeline":"string","sanction":"warning","certification_scheme_id":"string","certification_body_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/supervisory-finding":{"get":{"tags":["_Supervisory_finding(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get supervisory_finding List","description":"<p>Get supervisory_finding List.</p>\n<p>A Member State finding of non-conformity (Art. 10). This is separate from the audit report's non_conformities_list, which the certification body writes. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>supervisory_finding_id: Internal identifier for the finding.</li>\n<li>authority_id: The authority that raised the finding.</li>\n<li>certification_body_id: The body the finding concerns.</li>\n<li>certification_scheme_id: The scheme informed. Optional.</li>\n<li>audit_report_id: The audit report concerned, if any. Optional.</li>\n<li>finding_date: Date the non-conformity was identified.</li>\n<li>description: What was found.</li>\n<li>notified_date: Date the body and scheme were informed.</li>\n<li>published: Whether the finding is public in the registry.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"supervisory_finding\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>audit_report_id</code>, <code>authority_id</code>, <code>certification_body_id</code>, <code>certification_scheme_id</code>, <code>supervisory_finding_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>audit_report_id</code> → <code>audit_report</code>, <code>authority_id</code> → <code>authority</code>, <code>certification_body_id</code> → <code>certification_body</code>, <code>certification_scheme_id</code> → <code>certification_scheme</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getsupervisory_findingList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"supervisory_finding_list":{"type":"array","items":{"type":"object","properties":{"supervisory_finding":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"description":{"type":"string"},"notified_date":{"type":"string"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"authority_id":{"type":"string"},"supervisory_finding_id":{"type":"string"},"published":{"type":"boolean"},"finding_date":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"supervisory_finding_list":[{"supervisory_finding":{"supervisory_finding_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supervisory_finding_id":"sf_01HZZ6P9S4Q","authority_id":"auth_01HZZ4K7Q2M","certification_body_id":"cb_01HZZ1M2A3B4C","certification_scheme_id":"cs_01HZZ1K0X5F6Q7R8S9T0","audit_report_id":"ar_01HZZ7R1T5U","finding_date":"2027-03-10","description":"Audit sampling below scheme minimum","notified_date":"2027-03-11","published":true},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Supervisory_finding(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new supervisory_finding","description":"<p>Create new supervisory_finding.</p>\n<p>A Member State finding of non-conformity (Art. 10). This is separate from the audit report's non_conformities_list, which the certification body writes. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>supervisory_finding_id: Internal identifier for the finding.</li>\n<li>authority_id: The authority that raised the finding.</li>\n<li>certification_body_id: The body the finding concerns.</li>\n<li>certification_scheme_id: The scheme informed. Optional.</li>\n<li>audit_report_id: The audit report concerned, if any. Optional.</li>\n<li>finding_date: Date the non-conformity was identified.</li>\n<li>description: What was found.</li>\n<li>notified_date: Date the body and scheme were informed.</li>\n<li>published: Whether the finding is public in the registry.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"supervisory_finding\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createsupervisory_finding_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"description":{"type":"string"},"notified_date":{"type":"string"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"authority_id":{"type":"string"},"supervisory_finding_id":{"type":"string"},"published":{"type":"boolean"},"finding_date":{"type":"string"}}},"example":{"supervisory_finding_id":"sf_01HZZ6P9S4Q","authority_id":"auth_01HZZ4K7Q2M","certification_body_id":"cb_01HZZ1M2A3B4C","certification_scheme_id":"cs_01HZZ1K0X5F6Q7R8S9T0","audit_report_id":"ar_01HZZ7R1T5U","finding_date":"2027-03-10","description":"Audit sampling below scheme minimum","notified_date":"2027-03-11","published":true}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"supervisory_finding":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"description":{"type":"string"},"notified_date":{"type":"string"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"authority_id":{"type":"string"},"supervisory_finding_id":{"type":"string"},"published":{"type":"boolean"},"finding_date":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"supervisory_finding":{"supervisory_finding_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","supervisory_finding_id":"sf_01HZZ6P9S4Q","authority_id":"auth_01HZZ4K7Q2M","certification_body_id":"cb_01HZZ1M2A3B4C","certification_scheme_id":"cs_01HZZ1K0X5F6Q7R8S9T0","audit_report_id":"ar_01HZZ7R1T5U","finding_date":"2027-03-10","description":"Audit sampling below scheme minimum","notified_date":"2027-03-11","published":true},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/certification-scheme/{certificationschemeid}":{"get":{"tags":["_Certification_scheme(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get certification_scheme by id","description":"<p>Get certification_scheme by id.</p>\n<p>\u2018certification scheme\u2019 means an organisation that certifies the compliance of activities and operators with the quality criteria and certification rules set out in this Regulation;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certification_scheme_id: Unique identifier for certification scheme entity.</li>\n<li>legal_name: Public name of the certification scheme.</li>\n<li>logo: URL or asset reference to a logo image for UI/PDF rendering.</li>\n<li>commission_decision_reference: \"the Commission decision recognising that scheme\"</li>\n<li>certification_methodology: Methodology(ies) the scheme applies (identifier + version).</li>\n<li>scheme_version_number: Scheme rulebook version used for this certification</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_scheme\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglecertification_scheme_ogcr","parameters":[{"name":"certificationschemeid","in":"path","description":"The CERTIFICATIONSCHEMEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_scheme":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"email":{"type":"string"},"logo":{"type":"string"},"scheme_version_number":{"type":"string"},"legal_name":{"type":"string"},"commission_decision_reference":{"type":"string"},"certification_methodology":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certification_scheme":{"certification_scheme_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certification_scheme_id":"cs_01HZZ1K0X5F6Q7R8S9T0","legal_name":"CRCF Scheme","logo":"https://cdn.example.org/logos/dnv.png","email":"string","commission_decision_reference":"Commission Decision C(2026)1234","certification_methodology":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","scheme_version_number":"v1.3"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Certification_scheme(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update certification_scheme","description":"<p>Update certification_scheme.</p>\n<p>\u2018certification scheme\u2019 means an organisation that certifies the compliance of activities and operators with the quality criteria and certification rules set out in this Regulation;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certification_scheme_id: Unique identifier for certification scheme entity.</li>\n<li>legal_name: Public name of the certification scheme.</li>\n<li>logo: URL or asset reference to a logo image for UI/PDF rendering.</li>\n<li>commission_decision_reference: \"the Commission decision recognising that scheme\"</li>\n<li>certification_methodology: Methodology(ies) the scheme applies (identifier + version).</li>\n<li>scheme_version_number: Scheme rulebook version used for this certification</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_scheme\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updatecertification_scheme_ogcr","parameters":[{"name":"certificationschemeid","in":"path","description":"The CERTIFICATIONSCHEMEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"email":{"type":"string"},"logo":{"type":"string"},"scheme_version_number":{"type":"string"},"legal_name":{"type":"string"},"commission_decision_reference":{"type":"string"},"certification_methodology":{"type":"string"}}},"example":{"certification_scheme_id":"cs_01HZZ1K0X5F6Q7R8S9T0","legal_name":"CRCF Scheme","logo":"https://cdn.example.org/logos/dnv.png","email":"string","commission_decision_reference":"Commission Decision C(2026)1234","certification_methodology":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","scheme_version_number":"v1.3"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_scheme":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"email":{"type":"string"},"logo":{"type":"string"},"scheme_version_number":{"type":"string"},"legal_name":{"type":"string"},"commission_decision_reference":{"type":"string"},"certification_methodology":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certification_scheme":{"certification_scheme_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certification_scheme_id":"cs_01HZZ1K0X5F6Q7R8S9T0","legal_name":"CRCF Scheme","logo":"https://cdn.example.org/logos/dnv.png","email":"string","commission_decision_reference":"Commission Decision C(2026)1234","certification_methodology":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","scheme_version_number":"v1.3"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Certification_scheme(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete certification_scheme by id","description":"<p>Delete certification_scheme by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_scheme\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletecertification_scheme_ogcr","parameters":[{"name":"certificationschemeid","in":"path","description":"The CERTIFICATIONSCHEMEID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_scheme":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"email":{"type":"string"},"logo":{"type":"string"},"scheme_version_number":{"type":"string"},"legal_name":{"type":"string"},"commission_decision_reference":{"type":"string"},"certification_methodology":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certification_scheme":{"certification_scheme_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certification_scheme_id":"cs_01HZZ1K0X5F6Q7R8S9T0","legal_name":"CRCF Scheme","logo":"https://cdn.example.org/logos/dnv.png","email":"string","commission_decision_reference":"Commission Decision C(2026)1234","certification_methodology":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","scheme_version_number":"v1.3"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Certification_scheme(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update certification_scheme","description":"<p>Partially update certification_scheme: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>\u2018certification scheme\u2019 means an organisation that certifies the compliance of activities and operators with the quality criteria and certification rules set out in this Regulation;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certification_scheme_id: Unique identifier for certification scheme entity.</li>\n<li>legal_name: Public name of the certification scheme.</li>\n<li>logo: URL or asset reference to a logo image for UI/PDF rendering.</li>\n<li>commission_decision_reference: \"the Commission decision recognising that scheme\"</li>\n<li>certification_methodology: Methodology(ies) the scheme applies (identifier + version).</li>\n<li>scheme_version_number: Scheme rulebook version used for this certification</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_scheme\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchcertification_scheme_ogcr","parameters":[{"name":"certificationschemeid","in":"path","description":"The CERTIFICATIONSCHEMEID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"email":{"type":"string"},"logo":{"type":"string"},"scheme_version_number":{"type":"string"},"legal_name":{"type":"string"},"commission_decision_reference":{"type":"string"},"certification_methodology":{"type":"string"}}},"example":{"certification_scheme_id":"cs_01HZZ1K0X5F6Q7R8S9T0","legal_name":"CRCF Scheme","logo":"https://cdn.example.org/logos/dnv.png","email":"string","commission_decision_reference":"Commission Decision C(2026)1234","certification_methodology":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","scheme_version_number":"v1.3"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_scheme":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"email":{"type":"string"},"logo":{"type":"string"},"scheme_version_number":{"type":"string"},"legal_name":{"type":"string"},"commission_decision_reference":{"type":"string"},"certification_methodology":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certification_scheme":{"certification_scheme_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certification_scheme_id":"cs_01HZZ1K0X5F6Q7R8S9T0","legal_name":"CRCF Scheme","logo":"https://cdn.example.org/logos/dnv.png","email":"string","commission_decision_reference":"Commission Decision C(2026)1234","certification_methodology":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","scheme_version_number":"v1.3"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/chain-sync-status":{"get":{"tags":["_Chain_sync_status(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get chain_sync_status List","description":"<p>Get chain_sync_status List.</p>\n<p>Liveness record for OGCR-chain-cache: one record per chain, rewritten at the end of every mirror run. The other *_on_chain entities say what is on the chain; this says when anything last looked. Without it a quiet chain is indistinguishable from a dead mirror, because the newest mint could be old for either reason. Consumers should treat a record older than a few multiples of interval_seconds as stale.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_count: Activity tokens mirrored in this run.</li>\n<li>certification_count: Certification tokens mirrored in this run.</li>\n<li>chain_id: EVM chain id that was read.</li>\n<li>credit_balance_count: Carbon credit holder balances mirrored in this run.</li>\n<li>credit_batch_count: Carbon credit batch tokens mirrored in this run.</li>\n<li>error_count: Records that failed to upsert during the run.</li>\n<li>head_block: Chain head at the end of the run. Rising across runs is the clearest sign the chain itself is alive, as opposed to only the mirror.</li>\n<li>interval_seconds: Expected seconds between runs, from SYNC_INTERVAL_SECONDS. 0 when the cacher was run by hand. Lets a consumer decide what counts as stale without hardcoding the schedule.</li>\n<li>mirrored_types: Which mirrors ran, comma separated. Distinguishes a count of zero meaning \"none found\" from a mirror that was skipped because its contract is not configured.</li>\n<li>parcel_count: Parcel tokens mirrored in this run.</li>\n<li>run_status: \"ok\" when every configured mirror completed with no errors, \"partial\" when the chain was reachable but some records failed to write. A run that cannot reach the chain at all writes nothing, so the previous record simply ages.</li>\n<li>sync_key: Business key: \"chain-&lt;chain_id&gt;\". One record per chain, overwritten each run. A string key so it can be matched with a server-side query filter.</li>\n<li>synced_at: UTC RFC-3339 timestamp of when the run finished. This is the field a heartbeat is actually built on.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"chain_sync_status\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p><em>(no fields on this entity are declared <code>indexed</code>, so only the legacy bare-parameter filter below is available.)</em></p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getchain_sync_statusList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"chain_sync_status_list":{"type":"array","items":{"type":"object","properties":{"chain_sync_status":{"type":"object","properties":{"activity_count":{"type":"integer"},"mirrored_types":{"type":"string"},"error_count":{"type":"integer"},"credit_balance_count":{"type":"integer"},"chain_sync_status_id":{"type":"string"},"sync_key":{"type":"string"},"credit_batch_count":{"type":"integer"},"synced_at":{"type":"string"},"certification_count":{"type":"integer"},"chain_id":{"type":"integer"},"parcel_count":{"type":"integer"},"interval_seconds":{"type":"integer"},"head_block":{"type":"integer"},"run_status":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"chain_sync_status_list":[{"chain_sync_status":{"chain_sync_status_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_count":2,"certification_count":2,"chain_id":20253,"credit_balance_count":5,"credit_batch_count":2,"error_count":0,"head_block":12400,"interval_seconds":30,"mirrored_types":"parcel,activity,certification,credit","parcel_count":2,"run_status":"ok","sync_key":"chain-20253","synced_at":"2026-09-08T20:14:03Z"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Chain_sync_status(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new chain_sync_status","description":"<p>Create new chain_sync_status.</p>\n<p>Liveness record for OGCR-chain-cache: one record per chain, rewritten at the end of every mirror run. The other *_on_chain entities say what is on the chain; this says when anything last looked. Without it a quiet chain is indistinguishable from a dead mirror, because the newest mint could be old for either reason. Consumers should treat a record older than a few multiples of interval_seconds as stale.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_count: Activity tokens mirrored in this run.</li>\n<li>certification_count: Certification tokens mirrored in this run.</li>\n<li>chain_id: EVM chain id that was read.</li>\n<li>credit_balance_count: Carbon credit holder balances mirrored in this run.</li>\n<li>credit_batch_count: Carbon credit batch tokens mirrored in this run.</li>\n<li>error_count: Records that failed to upsert during the run.</li>\n<li>head_block: Chain head at the end of the run. Rising across runs is the clearest sign the chain itself is alive, as opposed to only the mirror.</li>\n<li>interval_seconds: Expected seconds between runs, from SYNC_INTERVAL_SECONDS. 0 when the cacher was run by hand. Lets a consumer decide what counts as stale without hardcoding the schedule.</li>\n<li>mirrored_types: Which mirrors ran, comma separated. Distinguishes a count of zero meaning \"none found\" from a mirror that was skipped because its contract is not configured.</li>\n<li>parcel_count: Parcel tokens mirrored in this run.</li>\n<li>run_status: \"ok\" when every configured mirror completed with no errors, \"partial\" when the chain was reachable but some records failed to write. A run that cannot reach the chain at all writes nothing, so the previous record simply ages.</li>\n<li>sync_key: Business key: \"chain-&lt;chain_id&gt;\". One record per chain, overwritten each run. A string key so it can be matched with a server-side query filter.</li>\n<li>synced_at: UTC RFC-3339 timestamp of when the run finished. This is the field a heartbeat is actually built on.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"chain_sync_status\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createchain_sync_status_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"activity_count":{"type":"integer"},"mirrored_types":{"type":"string"},"error_count":{"type":"integer"},"credit_balance_count":{"type":"integer"},"sync_key":{"type":"string"},"credit_batch_count":{"type":"integer"},"synced_at":{"type":"string"},"certification_count":{"type":"integer"},"chain_id":{"type":"integer"},"parcel_count":{"type":"integer"},"interval_seconds":{"type":"integer"},"head_block":{"type":"integer"},"run_status":{"type":"string"}}},"example":{"activity_count":2,"certification_count":2,"chain_id":20253,"credit_balance_count":5,"credit_batch_count":2,"error_count":0,"head_block":12400,"interval_seconds":30,"mirrored_types":"parcel,activity,certification,credit","parcel_count":2,"run_status":"ok","sync_key":"chain-20253","synced_at":"2026-09-08T20:14:03Z"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"chain_sync_status":{"type":"object","properties":{"activity_count":{"type":"integer"},"mirrored_types":{"type":"string"},"error_count":{"type":"integer"},"credit_balance_count":{"type":"integer"},"chain_sync_status_id":{"type":"string"},"sync_key":{"type":"string"},"credit_batch_count":{"type":"integer"},"synced_at":{"type":"string"},"certification_count":{"type":"integer"},"chain_id":{"type":"integer"},"parcel_count":{"type":"integer"},"interval_seconds":{"type":"integer"},"head_block":{"type":"integer"},"run_status":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"chain_sync_status":{"chain_sync_status_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_count":2,"certification_count":2,"chain_id":20253,"credit_balance_count":5,"credit_batch_count":2,"error_count":0,"head_block":12400,"interval_seconds":30,"mirrored_types":"parcel,activity,certification,credit","parcel_count":2,"run_status":"ok","sync_key":"chain-20253","synced_at":"2026-09-08T20:14:03Z"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/registry/activities-query":{"get":{"tags":["OGCR-Registry"],"summary":"Get OGCR registry activities","description":"<p>User Authentication is Optional. The User need not be logged in.</p>\n<p><strong>JSON response body fields:</strong></p>\n","operationId":"OBPv4.0.0-getRegistryActivitiesQuery_1440519393","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activities":{"type":"array","items":{"type":"object","properties":{"city":{"type":"string"},"start_date":{"type":"string"},"minted_at":{"type":"integer"},"token_uri":{"type":"string"},"activity_type":{"type":"string"},"certificate_issue_date":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"end_date":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"certification_status":{"type":"string"},"country_id":{"type":"string"},"name":{"type":"string"},"certificate_expiry_date":{"type":"string"},"verification_status":{"type":"string"},"internal_note":{"type":"string"},"monitoring_period_end_date":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"summary":{"type":"string"},"operator_legal_name":{"type":"string"},"country_name":{"type":"string"}}}},"count":{"type":"integer"}}},"example":{"activities":[{"activity_id":"string","name":"string","summary":"string","activity_type":"string","country_id":"string","country_name":"string","city":"string","start_date":"string","end_date":"string","monitoring_period_start_date":"string","monitoring_period_end_date":"string","operator_id":"string","operator_legal_name":"string","verification_status":"string","certificate_of_compliance_id":"string","certification_status":"string","certificate_issue_date":"string","certificate_expiry_date":"string","internal_note":"string","minted_at":1779280448,"token_uri":"string"}],"count":1}}}},"500":{"description":"Internal Server Error"}}}},"/public/activity-on-chain":{"get":{"tags":["_Activity_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public activity_on_chain List","description":"<p>Get Public activity_on_chain List.</p>\n<p>Cache of ActivityNFT data minted on the OGCR chain (chain id 20253). One record per activity_id, populated by OGCR-chain-cache reading the chain.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_hash: activity_hash stored on-chain: keccak256 of the raw activity entity body.</li>\n<li>activity_id: The <code>activity</code> this NFT was minted for (a reference, so OBP joins activity -&gt; activity_on_chain, e.g. in the registry query). OBP refuses a record whose activity is not in this space.</li>\n<li>activity_type: Activity type as stored on-chain.</li>\n<li>activity_url: activity_url stored on-chain: link back to the OBP activity entity.</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>certification_scheme_id: certification_scheme_id as stored on-chain.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>city: City as stored on-chain.</li>\n<li>contract_address: ActivityNFT contract address the token was read from.</li>\n<li>country_id: Country id as stored on-chain.</li>\n<li>end_date: Activity end date as stored on-chain.</li>\n<li>minted_at: Unix time (seconds) of the block the mint was included in.</li>\n<li>name: Activity name as stored on-chain.</li>\n<li>operator_id: operator_id stored on-chain (owning operator).</li>\n<li>operator_name: Operator legal name (operator.legal_name) as stored on-chain.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>parcel_ids: Parcels linked to the activity at mint time: the contract's parcel_ids[] joined with commas, as tokenURI renders it.</li>\n<li>start_date: Activity start date as stored on-chain.</li>\n<li>summary: Activity summary as stored on-chain.</li>\n<li>token_id: ActivityNFT token id minted for this activity.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>tx_hash: Mint transaction hash (from the ActivityMinted event).</li>\n<li>unit_types: Unit types of the activity as stored on-chain.</li>\n<li>website: Activity website as stored on-chain.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>minted_at</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPublicactivity_on_chainList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_on_chain_list":{"type":"array","items":{"type":"object","properties":{"activity_on_chain":{"type":"object","properties":{"name":{"type":"string"},"token_uri":{"type":"string"},"activity_on_chain_id":{"type":"string"},"tx_hash":{"type":"string"},"activity_type":{"type":"string"},"owner_address":{"type":"string"},"activity_url":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"integer"},"block_number":{"type":"integer"},"contract_address":{"type":"string"},"country_id":{"type":"string"},"summary":{"type":"string"},"chain_id":{"type":"integer"},"website":{"type":"string"},"city":{"type":"string"},"operator_name":{"type":"string"},"start_date":{"type":"string"},"minted_at":{"type":"integer"},"certification_scheme_id":{"type":"string"},"parcel_ids":{"type":"string"},"end_date":{"type":"string"},"unit_types":{"type":"string"},"activity_hash":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"activity_on_chain_list":[{"activity_on_chain":{"activity_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_type":"carbon_farming","activity_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/activity/activity_AB12CD34EF","block_number":12345,"certification_scheme_id":"scheme_SALUS","chain_id":20253,"city":"Viborg","contract_address":"0x5034F49b27353CeDc562b49eA91C7438Ea351d36","country_id":"DK","end_date":"2024-12-31","minted_at":1779280448,"name":"Reforestation 2024","operator_id":"operator_9XYZ","operator_name":"Example Operator GmbH","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","parcel_ids":"parcel_01,parcel_02","start_date":"2024-01-01","summary":"Rewetting of drained peat soils.","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQWN0aXZpdHkifQ==","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_types":"Permanent Removal","website":"https://example.org"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/livestock/{livestockid}":{"get":{"tags":["_Livestock(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get livestock by id","description":"<p>Get livestock by id.</p>\n<p>Records a group of animals of the same species kept by an operator, either grazing on a parcel or housed on a farm. Livestock data is not currently within CRCF scope (enteric fermentation 3.A and manure management 3.B are under Commission review until July 2026) but is included here as a v2 entity to support future certification methodologies and Scope 3 supply chain reporting. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>livestock_id: Unique internal identifier automatically assigned to this livestock herd record.</li>\n<li>parcel_id: The parcel where this herd grazes, if applicable. Null for housed animals (pigs, poultry). When populated, links the herd to parcel geometry so that grazing impacts on soil carbon (compaction, manure deposition) can be spatially attributed.</li>\n<li>species: The animal species. Controlled vocabulary aligned with IPCC 3.A/3.B emission factor categories. Determines which emission factors apply for enteric fermentation and manure management.</li>\n<li>breed: The breed of the animals in this herd. Breed affects feed conversion efficiency and methane emission rates, and may be required by future certification methodologies.</li>\n<li>head_count: The number of individual animals in this herd at the time of recording. Used to calculate total livestock units (LU) for the holding and to scale emission estimates.</li>\n<li>head_count_date: The date on which the head count was recorded. Herd size can change over the year (births, sales, slaughter), so the date is required to interpret the figure correctly.</li>\n<li>livestock_unit: Standardised livestock unit (LU) value for this herd, calculated from head count and species. One LU equals one adult dairy cow (500 kg). Used for cross-species comparisons and regulatory thresholds (e.g., nitrates directive).</li>\n<li>production_system: The management system under which these animals are kept. Affects both emission factors and carbon farming practice eligibility. Controlled vocabulary: grazing (animals outdoors year-round), mixed (indoor/outdoor), housed (indoor year-round), feedlot.</li>\n<li>manure_management_system: How animal manure is collected, stored, and applied. This is the primary factor driving methane and N2O emissions under IPCC category 3.B. Controlled vocabulary: slurry_tank, solid_storage, anaerobic_digester, pasture_range, biogas_with_flaring.</li>\n<li>feed_type: The primary feed source for this herd. Feed composition is the main determinant of enteric fermentation rates (IPCC 3.A). High-quality pasture produces less methane per unit of output than low-quality roughage or concentrate-heavy rations.</li>\n<li>avg_daily_weight_gain_kg: Average daily live weight gain per animal, in kilograms. Recorded for beef cattle only. Used with feed conversion ratios to estimate feed intake (this is for enteric fermentation emissions.)</li>\n<li>milk_yield_litres_per_day: Average daily milk production per cow, in litres. Recorded for dairy cattle only. Higher-yielding cows tend to have lower emission intensity per litre of milk, which is relevant for Scope 3 intensity-based reporting.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"livestock\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglelivestock_ogcr","parameters":[{"name":"livestockid","in":"path","description":"The LIVESTOCKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"livestock":{"type":"object","properties":{"milk_yield_litres_per_day":{"type":"number"},"production_system":{"type":"string"},"avg_daily_weight_gain_kg":{"type":"number"},"head_count_date":{"type":"string"},"breed":{"type":"string"},"livestock_unit":{"type":"number"},"head_count":{"type":"integer"},"manure_management_system":{"type":"string"},"livestock_id":{"type":"string"},"species":{"type":"string"},"feed_type":{"type":"string"},"parcel_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"livestock":{"livestock_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","livestock_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","species":"cattle_dairy","breed":"Holstein Friesian","head_count":85,"head_count_date":"2026-01-01","livestock_unit":85.0,"production_system":"grazing","manure_management_system":"slurry_tank","feed_type":"pasture","avg_daily_weight_gain_kg":1.1,"milk_yield_litres_per_day":28.5},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Livestock(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update livestock","description":"<p>Update livestock.</p>\n<p>Records a group of animals of the same species kept by an operator, either grazing on a parcel or housed on a farm. Livestock data is not currently within CRCF scope (enteric fermentation 3.A and manure management 3.B are under Commission review until July 2026) but is included here as a v2 entity to support future certification methodologies and Scope 3 supply chain reporting. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>livestock_id: Unique internal identifier automatically assigned to this livestock herd record.</li>\n<li>parcel_id: The parcel where this herd grazes, if applicable. Null for housed animals (pigs, poultry). When populated, links the herd to parcel geometry so that grazing impacts on soil carbon (compaction, manure deposition) can be spatially attributed.</li>\n<li>species: The animal species. Controlled vocabulary aligned with IPCC 3.A/3.B emission factor categories. Determines which emission factors apply for enteric fermentation and manure management.</li>\n<li>breed: The breed of the animals in this herd. Breed affects feed conversion efficiency and methane emission rates, and may be required by future certification methodologies.</li>\n<li>head_count: The number of individual animals in this herd at the time of recording. Used to calculate total livestock units (LU) for the holding and to scale emission estimates.</li>\n<li>head_count_date: The date on which the head count was recorded. Herd size can change over the year (births, sales, slaughter), so the date is required to interpret the figure correctly.</li>\n<li>livestock_unit: Standardised livestock unit (LU) value for this herd, calculated from head count and species. One LU equals one adult dairy cow (500 kg). Used for cross-species comparisons and regulatory thresholds (e.g., nitrates directive).</li>\n<li>production_system: The management system under which these animals are kept. Affects both emission factors and carbon farming practice eligibility. Controlled vocabulary: grazing (animals outdoors year-round), mixed (indoor/outdoor), housed (indoor year-round), feedlot.</li>\n<li>manure_management_system: How animal manure is collected, stored, and applied. This is the primary factor driving methane and N2O emissions under IPCC category 3.B. Controlled vocabulary: slurry_tank, solid_storage, anaerobic_digester, pasture_range, biogas_with_flaring.</li>\n<li>feed_type: The primary feed source for this herd. Feed composition is the main determinant of enteric fermentation rates (IPCC 3.A). High-quality pasture produces less methane per unit of output than low-quality roughage or concentrate-heavy rations.</li>\n<li>avg_daily_weight_gain_kg: Average daily live weight gain per animal, in kilograms. Recorded for beef cattle only. Used with feed conversion ratios to estimate feed intake (this is for enteric fermentation emissions.)</li>\n<li>milk_yield_litres_per_day: Average daily milk production per cow, in litres. Recorded for dairy cattle only. Higher-yielding cows tend to have lower emission intensity per litre of milk, which is relevant for Scope 3 intensity-based reporting.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"livestock\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updatelivestock_ogcr","parameters":[{"name":"livestockid","in":"path","description":"The LIVESTOCKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"milk_yield_litres_per_day":{"type":"number"},"production_system":{"type":"string"},"avg_daily_weight_gain_kg":{"type":"number"},"head_count_date":{"type":"string"},"breed":{"type":"string"},"livestock_unit":{"type":"number"},"head_count":{"type":"integer"},"manure_management_system":{"type":"string"},"livestock_id":{"type":"string"},"species":{"type":"string"},"feed_type":{"type":"string"},"parcel_id":{"type":"string"}}},"example":{"livestock_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","species":"cattle_dairy","breed":"Holstein Friesian","head_count":85,"head_count_date":"2026-01-01","livestock_unit":85.0,"production_system":"grazing","manure_management_system":"slurry_tank","feed_type":"pasture","avg_daily_weight_gain_kg":1.1,"milk_yield_litres_per_day":28.5}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"livestock":{"type":"object","properties":{"milk_yield_litres_per_day":{"type":"number"},"production_system":{"type":"string"},"avg_daily_weight_gain_kg":{"type":"number"},"head_count_date":{"type":"string"},"breed":{"type":"string"},"livestock_unit":{"type":"number"},"head_count":{"type":"integer"},"manure_management_system":{"type":"string"},"livestock_id":{"type":"string"},"species":{"type":"string"},"feed_type":{"type":"string"},"parcel_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"livestock":{"livestock_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","livestock_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","species":"cattle_dairy","breed":"Holstein Friesian","head_count":85,"head_count_date":"2026-01-01","livestock_unit":85.0,"production_system":"grazing","manure_management_system":"slurry_tank","feed_type":"pasture","avg_daily_weight_gain_kg":1.1,"milk_yield_litres_per_day":28.5},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Livestock(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete livestock by id","description":"<p>Delete livestock by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"livestock\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletelivestock_ogcr","parameters":[{"name":"livestockid","in":"path","description":"The LIVESTOCKID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"livestock":{"type":"object","properties":{"milk_yield_litres_per_day":{"type":"number"},"production_system":{"type":"string"},"avg_daily_weight_gain_kg":{"type":"number"},"head_count_date":{"type":"string"},"breed":{"type":"string"},"livestock_unit":{"type":"number"},"head_count":{"type":"integer"},"manure_management_system":{"type":"string"},"livestock_id":{"type":"string"},"species":{"type":"string"},"feed_type":{"type":"string"},"parcel_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"livestock":{"livestock_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","livestock_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","species":"cattle_dairy","breed":"Holstein Friesian","head_count":85,"head_count_date":"2026-01-01","livestock_unit":85.0,"production_system":"grazing","manure_management_system":"slurry_tank","feed_type":"pasture","avg_daily_weight_gain_kg":1.1,"milk_yield_litres_per_day":28.5},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Livestock(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update livestock","description":"<p>Partially update livestock: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Records a group of animals of the same species kept by an operator, either grazing on a parcel or housed on a farm. Livestock data is not currently within CRCF scope (enteric fermentation 3.A and manure management 3.B are under Commission review until July 2026) but is included here as a v2 entity to support future certification methodologies and Scope 3 supply chain reporting. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>livestock_id: Unique internal identifier automatically assigned to this livestock herd record.</li>\n<li>parcel_id: The parcel where this herd grazes, if applicable. Null for housed animals (pigs, poultry). When populated, links the herd to parcel geometry so that grazing impacts on soil carbon (compaction, manure deposition) can be spatially attributed.</li>\n<li>species: The animal species. Controlled vocabulary aligned with IPCC 3.A/3.B emission factor categories. Determines which emission factors apply for enteric fermentation and manure management.</li>\n<li>breed: The breed of the animals in this herd. Breed affects feed conversion efficiency and methane emission rates, and may be required by future certification methodologies.</li>\n<li>head_count: The number of individual animals in this herd at the time of recording. Used to calculate total livestock units (LU) for the holding and to scale emission estimates.</li>\n<li>head_count_date: The date on which the head count was recorded. Herd size can change over the year (births, sales, slaughter), so the date is required to interpret the figure correctly.</li>\n<li>livestock_unit: Standardised livestock unit (LU) value for this herd, calculated from head count and species. One LU equals one adult dairy cow (500 kg). Used for cross-species comparisons and regulatory thresholds (e.g., nitrates directive).</li>\n<li>production_system: The management system under which these animals are kept. Affects both emission factors and carbon farming practice eligibility. Controlled vocabulary: grazing (animals outdoors year-round), mixed (indoor/outdoor), housed (indoor year-round), feedlot.</li>\n<li>manure_management_system: How animal manure is collected, stored, and applied. This is the primary factor driving methane and N2O emissions under IPCC category 3.B. Controlled vocabulary: slurry_tank, solid_storage, anaerobic_digester, pasture_range, biogas_with_flaring.</li>\n<li>feed_type: The primary feed source for this herd. Feed composition is the main determinant of enteric fermentation rates (IPCC 3.A). High-quality pasture produces less methane per unit of output than low-quality roughage or concentrate-heavy rations.</li>\n<li>avg_daily_weight_gain_kg: Average daily live weight gain per animal, in kilograms. Recorded for beef cattle only. Used with feed conversion ratios to estimate feed intake (this is for enteric fermentation emissions.)</li>\n<li>milk_yield_litres_per_day: Average daily milk production per cow, in litres. Recorded for dairy cattle only. Higher-yielding cows tend to have lower emission intensity per litre of milk, which is relevant for Scope 3 intensity-based reporting.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"livestock\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchlivestock_ogcr","parameters":[{"name":"livestockid","in":"path","description":"The LIVESTOCKID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"milk_yield_litres_per_day":{"type":"number"},"production_system":{"type":"string"},"avg_daily_weight_gain_kg":{"type":"number"},"head_count_date":{"type":"string"},"breed":{"type":"string"},"livestock_unit":{"type":"number"},"head_count":{"type":"integer"},"manure_management_system":{"type":"string"},"livestock_id":{"type":"string"},"species":{"type":"string"},"feed_type":{"type":"string"},"parcel_id":{"type":"string"}}},"example":{"livestock_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","species":"cattle_dairy","breed":"Holstein Friesian","head_count":85,"head_count_date":"2026-01-01","livestock_unit":85.0,"production_system":"grazing","manure_management_system":"slurry_tank","feed_type":"pasture","avg_daily_weight_gain_kg":1.1,"milk_yield_litres_per_day":28.5}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"livestock":{"type":"object","properties":{"milk_yield_litres_per_day":{"type":"number"},"production_system":{"type":"string"},"avg_daily_weight_gain_kg":{"type":"number"},"head_count_date":{"type":"string"},"breed":{"type":"string"},"livestock_unit":{"type":"number"},"head_count":{"type":"integer"},"manure_management_system":{"type":"string"},"livestock_id":{"type":"string"},"species":{"type":"string"},"feed_type":{"type":"string"},"parcel_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"livestock":{"livestock_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","livestock_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","species":"cattle_dairy","breed":"Holstein Friesian","head_count":85,"head_count_date":"2026-01-01","livestock_unit":85.0,"production_system":"grazing","manure_management_system":"slurry_tank","feed_type":"pasture","avg_daily_weight_gain_kg":1.1,"milk_yield_litres_per_day":28.5},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/chain-sync-status/{chainsyncstatusid}":{"get":{"tags":["_Chain_sync_status(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get chain_sync_status by id","description":"<p>Get chain_sync_status by id.</p>\n<p>Liveness record for OGCR-chain-cache: one record per chain, rewritten at the end of every mirror run. The other *_on_chain entities say what is on the chain; this says when anything last looked. Without it a quiet chain is indistinguishable from a dead mirror, because the newest mint could be old for either reason. Consumers should treat a record older than a few multiples of interval_seconds as stale.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_count: Activity tokens mirrored in this run.</li>\n<li>certification_count: Certification tokens mirrored in this run.</li>\n<li>chain_id: EVM chain id that was read.</li>\n<li>credit_balance_count: Carbon credit holder balances mirrored in this run.</li>\n<li>credit_batch_count: Carbon credit batch tokens mirrored in this run.</li>\n<li>error_count: Records that failed to upsert during the run.</li>\n<li>head_block: Chain head at the end of the run. Rising across runs is the clearest sign the chain itself is alive, as opposed to only the mirror.</li>\n<li>interval_seconds: Expected seconds between runs, from SYNC_INTERVAL_SECONDS. 0 when the cacher was run by hand. Lets a consumer decide what counts as stale without hardcoding the schedule.</li>\n<li>mirrored_types: Which mirrors ran, comma separated. Distinguishes a count of zero meaning \"none found\" from a mirror that was skipped because its contract is not configured.</li>\n<li>parcel_count: Parcel tokens mirrored in this run.</li>\n<li>run_status: \"ok\" when every configured mirror completed with no errors, \"partial\" when the chain was reachable but some records failed to write. A run that cannot reach the chain at all writes nothing, so the previous record simply ages.</li>\n<li>sync_key: Business key: \"chain-&lt;chain_id&gt;\". One record per chain, overwritten each run. A string key so it can be matched with a server-side query filter.</li>\n<li>synced_at: UTC RFC-3339 timestamp of when the run finished. This is the field a heartbeat is actually built on.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"chain_sync_status\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglechain_sync_status_ogcr","parameters":[{"name":"chainsyncstatusid","in":"path","description":"The CHAINSYNCSTATUSID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"chain_sync_status":{"type":"object","properties":{"activity_count":{"type":"integer"},"mirrored_types":{"type":"string"},"error_count":{"type":"integer"},"credit_balance_count":{"type":"integer"},"chain_sync_status_id":{"type":"string"},"sync_key":{"type":"string"},"credit_batch_count":{"type":"integer"},"synced_at":{"type":"string"},"certification_count":{"type":"integer"},"chain_id":{"type":"integer"},"parcel_count":{"type":"integer"},"interval_seconds":{"type":"integer"},"head_block":{"type":"integer"},"run_status":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"chain_sync_status":{"chain_sync_status_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_count":2,"certification_count":2,"chain_id":20253,"credit_balance_count":5,"credit_batch_count":2,"error_count":0,"head_block":12400,"interval_seconds":30,"mirrored_types":"parcel,activity,certification,credit","parcel_count":2,"run_status":"ok","sync_key":"chain-20253","synced_at":"2026-09-08T20:14:03Z"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Chain_sync_status(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update chain_sync_status","description":"<p>Update chain_sync_status.</p>\n<p>Liveness record for OGCR-chain-cache: one record per chain, rewritten at the end of every mirror run. The other *_on_chain entities say what is on the chain; this says when anything last looked. Without it a quiet chain is indistinguishable from a dead mirror, because the newest mint could be old for either reason. Consumers should treat a record older than a few multiples of interval_seconds as stale.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_count: Activity tokens mirrored in this run.</li>\n<li>certification_count: Certification tokens mirrored in this run.</li>\n<li>chain_id: EVM chain id that was read.</li>\n<li>credit_balance_count: Carbon credit holder balances mirrored in this run.</li>\n<li>credit_batch_count: Carbon credit batch tokens mirrored in this run.</li>\n<li>error_count: Records that failed to upsert during the run.</li>\n<li>head_block: Chain head at the end of the run. Rising across runs is the clearest sign the chain itself is alive, as opposed to only the mirror.</li>\n<li>interval_seconds: Expected seconds between runs, from SYNC_INTERVAL_SECONDS. 0 when the cacher was run by hand. Lets a consumer decide what counts as stale without hardcoding the schedule.</li>\n<li>mirrored_types: Which mirrors ran, comma separated. Distinguishes a count of zero meaning \"none found\" from a mirror that was skipped because its contract is not configured.</li>\n<li>parcel_count: Parcel tokens mirrored in this run.</li>\n<li>run_status: \"ok\" when every configured mirror completed with no errors, \"partial\" when the chain was reachable but some records failed to write. A run that cannot reach the chain at all writes nothing, so the previous record simply ages.</li>\n<li>sync_key: Business key: \"chain-&lt;chain_id&gt;\". One record per chain, overwritten each run. A string key so it can be matched with a server-side query filter.</li>\n<li>synced_at: UTC RFC-3339 timestamp of when the run finished. This is the field a heartbeat is actually built on.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"chain_sync_status\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updatechain_sync_status_ogcr","parameters":[{"name":"chainsyncstatusid","in":"path","description":"The CHAINSYNCSTATUSID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"activity_count":{"type":"integer"},"mirrored_types":{"type":"string"},"error_count":{"type":"integer"},"credit_balance_count":{"type":"integer"},"sync_key":{"type":"string"},"credit_batch_count":{"type":"integer"},"synced_at":{"type":"string"},"certification_count":{"type":"integer"},"chain_id":{"type":"integer"},"parcel_count":{"type":"integer"},"interval_seconds":{"type":"integer"},"head_block":{"type":"integer"},"run_status":{"type":"string"}}},"example":{"activity_count":2,"certification_count":2,"chain_id":20253,"credit_balance_count":5,"credit_batch_count":2,"error_count":0,"head_block":12400,"interval_seconds":30,"mirrored_types":"parcel,activity,certification,credit","parcel_count":2,"run_status":"ok","sync_key":"chain-20253","synced_at":"2026-09-08T20:14:03Z"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"chain_sync_status":{"type":"object","properties":{"activity_count":{"type":"integer"},"mirrored_types":{"type":"string"},"error_count":{"type":"integer"},"credit_balance_count":{"type":"integer"},"chain_sync_status_id":{"type":"string"},"sync_key":{"type":"string"},"credit_batch_count":{"type":"integer"},"synced_at":{"type":"string"},"certification_count":{"type":"integer"},"chain_id":{"type":"integer"},"parcel_count":{"type":"integer"},"interval_seconds":{"type":"integer"},"head_block":{"type":"integer"},"run_status":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"chain_sync_status":{"chain_sync_status_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_count":2,"certification_count":2,"chain_id":20253,"credit_balance_count":5,"credit_batch_count":2,"error_count":0,"head_block":12400,"interval_seconds":30,"mirrored_types":"parcel,activity,certification,credit","parcel_count":2,"run_status":"ok","sync_key":"chain-20253","synced_at":"2026-09-08T20:14:03Z"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Chain_sync_status(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete chain_sync_status by id","description":"<p>Delete chain_sync_status by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"chain_sync_status\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletechain_sync_status_ogcr","parameters":[{"name":"chainsyncstatusid","in":"path","description":"The CHAINSYNCSTATUSID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"chain_sync_status":{"type":"object","properties":{"activity_count":{"type":"integer"},"mirrored_types":{"type":"string"},"error_count":{"type":"integer"},"credit_balance_count":{"type":"integer"},"chain_sync_status_id":{"type":"string"},"sync_key":{"type":"string"},"credit_batch_count":{"type":"integer"},"synced_at":{"type":"string"},"certification_count":{"type":"integer"},"chain_id":{"type":"integer"},"parcel_count":{"type":"integer"},"interval_seconds":{"type":"integer"},"head_block":{"type":"integer"},"run_status":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"chain_sync_status":{"chain_sync_status_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_count":2,"certification_count":2,"chain_id":20253,"credit_balance_count":5,"credit_batch_count":2,"error_count":0,"head_block":12400,"interval_seconds":30,"mirrored_types":"parcel,activity,certification,credit","parcel_count":2,"run_status":"ok","sync_key":"chain-20253","synced_at":"2026-09-08T20:14:03Z"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Chain_sync_status(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update chain_sync_status","description":"<p>Partially update chain_sync_status: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Liveness record for OGCR-chain-cache: one record per chain, rewritten at the end of every mirror run. The other *_on_chain entities say what is on the chain; this says when anything last looked. Without it a quiet chain is indistinguishable from a dead mirror, because the newest mint could be old for either reason. Consumers should treat a record older than a few multiples of interval_seconds as stale.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_count: Activity tokens mirrored in this run.</li>\n<li>certification_count: Certification tokens mirrored in this run.</li>\n<li>chain_id: EVM chain id that was read.</li>\n<li>credit_balance_count: Carbon credit holder balances mirrored in this run.</li>\n<li>credit_batch_count: Carbon credit batch tokens mirrored in this run.</li>\n<li>error_count: Records that failed to upsert during the run.</li>\n<li>head_block: Chain head at the end of the run. Rising across runs is the clearest sign the chain itself is alive, as opposed to only the mirror.</li>\n<li>interval_seconds: Expected seconds between runs, from SYNC_INTERVAL_SECONDS. 0 when the cacher was run by hand. Lets a consumer decide what counts as stale without hardcoding the schedule.</li>\n<li>mirrored_types: Which mirrors ran, comma separated. Distinguishes a count of zero meaning \"none found\" from a mirror that was skipped because its contract is not configured.</li>\n<li>parcel_count: Parcel tokens mirrored in this run.</li>\n<li>run_status: \"ok\" when every configured mirror completed with no errors, \"partial\" when the chain was reachable but some records failed to write. A run that cannot reach the chain at all writes nothing, so the previous record simply ages.</li>\n<li>sync_key: Business key: \"chain-&lt;chain_id&gt;\". One record per chain, overwritten each run. A string key so it can be matched with a server-side query filter.</li>\n<li>synced_at: UTC RFC-3339 timestamp of when the run finished. This is the field a heartbeat is actually built on.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"chain_sync_status\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchchain_sync_status_ogcr","parameters":[{"name":"chainsyncstatusid","in":"path","description":"The CHAINSYNCSTATUSID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"activity_count":{"type":"integer"},"mirrored_types":{"type":"string"},"error_count":{"type":"integer"},"credit_balance_count":{"type":"integer"},"sync_key":{"type":"string"},"credit_batch_count":{"type":"integer"},"synced_at":{"type":"string"},"certification_count":{"type":"integer"},"chain_id":{"type":"integer"},"parcel_count":{"type":"integer"},"interval_seconds":{"type":"integer"},"head_block":{"type":"integer"},"run_status":{"type":"string"}}},"example":{"activity_count":2,"certification_count":2,"chain_id":20253,"credit_balance_count":5,"credit_batch_count":2,"error_count":0,"head_block":12400,"interval_seconds":30,"mirrored_types":"parcel,activity,certification,credit","parcel_count":2,"run_status":"ok","sync_key":"chain-20253","synced_at":"2026-09-08T20:14:03Z"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"chain_sync_status":{"type":"object","properties":{"activity_count":{"type":"integer"},"mirrored_types":{"type":"string"},"error_count":{"type":"integer"},"credit_balance_count":{"type":"integer"},"chain_sync_status_id":{"type":"string"},"sync_key":{"type":"string"},"credit_batch_count":{"type":"integer"},"synced_at":{"type":"string"},"certification_count":{"type":"integer"},"chain_id":{"type":"integer"},"parcel_count":{"type":"integer"},"interval_seconds":{"type":"integer"},"head_block":{"type":"integer"},"run_status":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"chain_sync_status":{"chain_sync_status_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_count":2,"certification_count":2,"chain_id":20253,"credit_balance_count":5,"credit_batch_count":2,"error_count":0,"head_block":12400,"interval_seconds":30,"mirrored_types":"parcel,activity,certification,credit","parcel_count":2,"run_status":"ok","sync_key":"chain-20253","synced_at":"2026-09-08T20:14:03Z"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/audit-report/{auditreportid}":{"get":{"tags":["_Audit_report(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get audit_report by id","description":"<p>Get audit_report by id.</p>\n<p>Audit report is the outcome of the audit conducted by certification bodies. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>audit_report_id: (uu)id of the audit report</li>\n<li>audit_report_summary: Short human-readable summary of audit scope, approach, and conclusion.</li>\n<li>operator_id: Operator\u2019s legal name</li>\n<li>group_manager_legal_name: For group certification: group manager name</li>\n<li>group_manager_address: For group certification: group manager address</li>\n<li>group_activity_operator_list: For group certification: list of carbon farming activities under scope (operators\u2019 names and addresses)</li>\n<li>activity_id: Internal identifier for the activity entity</li>\n<li>certification_scope: Scope of certification</li>\n<li>certification_scheme_id: Methodology(ies) the scheme applies (identifier + version).</li>\n<li>certification_methodology_legal_reference: Legal reference for certification methodology</li>\n<li>activity_plan_id: Reference number of the activity plan</li>\n<li>monitoring_plan_id: Reference number of the monitoring plan</li>\n<li>permanent_net_carbon_removal_benefit: Expected/verified amount of permanent net carbon removal benefit (in Co2e Tonnes)</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: Expected/verified amount of temporary net carbon removal benefit (in Co2e Tonnes)</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: Expected/verified amount of net soil emission reduction benefit (in Co2e Tonnes)</li>\n<li>sustainability_co_benefits: Sustainability co-benefits associated with the activity</li>\n<li>certification_body_id: Legal or trading name of the certification body</li>\n<li>audit_team_composition: Composition of the audit team</li>\n<li>national_accreditation_body: National accreditation body and scope/date of accreditation (or recognition authority and scope/date)</li>\n<li>accreditation_scope: Accreditation scope</li>\n<li>accreditation_date: Accreditation date</li>\n<li>national_recognition_authority: National recognition authority</li>\n<li>recognition_scope: Recognition scope</li>\n<li>recognition_date: Recognition date</li>\n<li>audit_date: Date of the audit</li>\n<li>audit_itinerary: Audit itinerary and duration (split onsite/remote where relevant)</li>\n<li>audit_duration_onsite: Duration spent on-site</li>\n<li>audit_duration_remote: Duration spent remotely</li>\n<li>sites_audited: Sites audited</li>\n<li>audit_method_risk_assessment: Audit method, risk assessment</li>\n<li>audit_method_sampling_basis: Audit method, sampling basis</li>\n<li>audit_method_stakeholder_consultation: Audit method, stakeholder consultation</li>\n<li>other_certification_schemes_or_standards_certified: Certification of other certification schemes or standards</li>\n<li>ghg_data_type: GHG data type</li>\n<li>audit_report_issue_location: Place of issuance of the audit report</li>\n<li>audit_report_issue_date: Date of issuance of the audit report</li>\n<li>certificate_valid_from_date: Certificate valid from date</li>\n<li>certificate_valid_to_date: Certificate valid to date</li>\n<li>date_certified: Date certified (if applicable)</li>\n<li>issuing_party_signature_or_stamp: Stamp and/or signature of issuing party</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"audit_report\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleaudit_report_ogcr","parameters":[{"name":"auditreportid","in":"path","description":"The AUDITREPORTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"audit_report":{"type":"object","properties":{"audit_method_stakeholder_consultation":{"type":"string"},"sustainability_co_benefits":{"type":"string"},"audit_method_risk_assessment":{"type":"string"},"accreditation_date":{"type":"string"},"group_manager_address":{"type":"string"},"audit_duration_remote":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"national_accreditation_body":{"type":"string"},"audit_report_issue_date":{"type":"string"},"certification_body_id":{"type":"string"},"group_manager_legal_name":{"type":"string"},"audit_duration_onsite":{"type":"string"},"activity_plan_id":{"type":"string"},"audit_date":{"type":"string"},"certification_scheme_id":{"type":"string"},"certificate_valid_to_date":{"type":"string"},"ghg_data_type":{"type":"string"},"accreditation_scope":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"certification_scope":{"type":"string"},"audit_report_issue_location":{"type":"string"},"certification_methodology_legal_reference":{"type":"string"},"issuing_party_signature_or_stamp":{"type":"string"},"group_activity_operator_list":{"type":"string"},"other_certification_schemes_or_standards_certified":{"type":"string"},"certificate_valid_from_date":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"audit_report_id":{"type":"string"},"national_recognition_authority":{"type":"string"},"sites_audited":{"type":"string"},"monitoring_plan_id":{"type":"string"},"recognition_date":{"type":"string"},"audit_report_summary":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"audit_method_sampling_basis":{"type":"string"},"date_certified":{"type":"string"},"audit_team_composition":{"type":"string"},"recognition_scope":{"type":"string"},"audit_itinerary":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"audit_report":{"audit_report_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","audit_report_id":"string","audit_report_summary":"Audit confirmed conformance to methodology X for monitoring period FY2027; no major non-conformities.","operator_id":"op_05OFWI037022","group_manager_legal_name":"Green Fields Cooperative GmbH","group_manager_address":"Hauptstrasse 12, 15230 Frankfurt (Oder), Germany","group_activity_operator_list":"[{\"operator\": \"Oderbruch Farms GmbH\", \"address\": \"Dorfstrasse 4, 15324 Letschin, Germany\"}]","activity_id":"a_05OFWI037022","certification_scope":"Carbon farming activity a_05OFWI037022, 120 ha across 14 parcels, monitoring period 2027 to 2031","certification_scheme_id":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","certification_methodology_legal_reference":"Methodology crcf_agri_mineral_soils version 1.0, adopted under Article 8 of Regulation (EU) 2024/3012","activity_plan_id":"ap_01HZY3...","monitoring_plan_id":"mp_01HZYW...","permanent_net_carbon_removal_benefit":6.5,"carbon_farming_temporary_net_carbon_removal_benefit":6.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"sustainability_co_benefits":"Biodiversity and soil health (Article 7(1)(f))","certification_body_id":"DNV Business Assurance Germany GmbH","audit_team_composition":"Lead auditor, one soil science expert, one auditor in training","national_accreditation_body":"DAkkS (Germany), accredited for carbon farming certification audits since 1 March 2025","accreditation_scope":"Verification and certification of carbon farming activities under Regulation (EU) 2024/3012","accreditation_date":"2025-03-01","national_recognition_authority":"Not applicable (accredited body)","recognition_scope":"Not applicable (accredited body)","recognition_date":"2026-05-24","audit_date":"2026-12-15","audit_itinerary":"Day 1 on-site: farm and parcels A to C. Day 2 on-site: records review. Day 3 remote: closing meeting","audit_duration_onsite":"2 days","audit_duration_remote":"1 day","sites_audited":"Oderbruch Farms GmbH headquarters and 4 of 14 parcels","audit_method_risk_assessment":"Risk-based: more sampling on parcels with a large claimed benefit","audit_method_sampling_basis":"Random sample of 30% of parcels plus all parcels above 10 ha","audit_method_stakeholder_consultation":"Interviews with the operator, the farm advisor and two neighbouring landowners","other_certification_schemes_or_standards_certified":"string","ghg_data_type":"Measured (soil sampling), with modelled values for unsampled parcels","audit_report_issue_location":"Hamburg, Germany","audit_report_issue_date":"2026-12-20","certificate_valid_from_date":"2027-01-01","certificate_valid_to_date":"2031-12-31","date_certified":"2026-12-25","issuing_party_signature_or_stamp":"Signed and stamped by the lead auditor, DNV Business Assurance Germany GmbH"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Audit_report(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update audit_report","description":"<p>Update audit_report.</p>\n<p>Audit report is the outcome of the audit conducted by certification bodies. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>audit_report_id: (uu)id of the audit report</li>\n<li>audit_report_summary: Short human-readable summary of audit scope, approach, and conclusion.</li>\n<li>operator_id: Operator\u2019s legal name</li>\n<li>group_manager_legal_name: For group certification: group manager name</li>\n<li>group_manager_address: For group certification: group manager address</li>\n<li>group_activity_operator_list: For group certification: list of carbon farming activities under scope (operators\u2019 names and addresses)</li>\n<li>activity_id: Internal identifier for the activity entity</li>\n<li>certification_scope: Scope of certification</li>\n<li>certification_scheme_id: Methodology(ies) the scheme applies (identifier + version).</li>\n<li>certification_methodology_legal_reference: Legal reference for certification methodology</li>\n<li>activity_plan_id: Reference number of the activity plan</li>\n<li>monitoring_plan_id: Reference number of the monitoring plan</li>\n<li>permanent_net_carbon_removal_benefit: Expected/verified amount of permanent net carbon removal benefit (in Co2e Tonnes)</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: Expected/verified amount of temporary net carbon removal benefit (in Co2e Tonnes)</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: Expected/verified amount of net soil emission reduction benefit (in Co2e Tonnes)</li>\n<li>sustainability_co_benefits: Sustainability co-benefits associated with the activity</li>\n<li>certification_body_id: Legal or trading name of the certification body</li>\n<li>audit_team_composition: Composition of the audit team</li>\n<li>national_accreditation_body: National accreditation body and scope/date of accreditation (or recognition authority and scope/date)</li>\n<li>accreditation_scope: Accreditation scope</li>\n<li>accreditation_date: Accreditation date</li>\n<li>national_recognition_authority: National recognition authority</li>\n<li>recognition_scope: Recognition scope</li>\n<li>recognition_date: Recognition date</li>\n<li>audit_date: Date of the audit</li>\n<li>audit_itinerary: Audit itinerary and duration (split onsite/remote where relevant)</li>\n<li>audit_duration_onsite: Duration spent on-site</li>\n<li>audit_duration_remote: Duration spent remotely</li>\n<li>sites_audited: Sites audited</li>\n<li>audit_method_risk_assessment: Audit method, risk assessment</li>\n<li>audit_method_sampling_basis: Audit method, sampling basis</li>\n<li>audit_method_stakeholder_consultation: Audit method, stakeholder consultation</li>\n<li>other_certification_schemes_or_standards_certified: Certification of other certification schemes or standards</li>\n<li>ghg_data_type: GHG data type</li>\n<li>audit_report_issue_location: Place of issuance of the audit report</li>\n<li>audit_report_issue_date: Date of issuance of the audit report</li>\n<li>certificate_valid_from_date: Certificate valid from date</li>\n<li>certificate_valid_to_date: Certificate valid to date</li>\n<li>date_certified: Date certified (if applicable)</li>\n<li>issuing_party_signature_or_stamp: Stamp and/or signature of issuing party</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"audit_report\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateaudit_report_ogcr","parameters":[{"name":"auditreportid","in":"path","description":"The AUDITREPORTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"audit_method_stakeholder_consultation":{"type":"string"},"sustainability_co_benefits":{"type":"string"},"audit_method_risk_assessment":{"type":"string"},"accreditation_date":{"type":"string"},"group_manager_address":{"type":"string"},"audit_duration_remote":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"national_accreditation_body":{"type":"string"},"audit_report_issue_date":{"type":"string"},"certification_body_id":{"type":"string"},"group_manager_legal_name":{"type":"string"},"audit_duration_onsite":{"type":"string"},"activity_plan_id":{"type":"string"},"audit_date":{"type":"string"},"certification_scheme_id":{"type":"string"},"certificate_valid_to_date":{"type":"string"},"ghg_data_type":{"type":"string"},"accreditation_scope":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"certification_scope":{"type":"string"},"audit_report_issue_location":{"type":"string"},"certification_methodology_legal_reference":{"type":"string"},"issuing_party_signature_or_stamp":{"type":"string"},"group_activity_operator_list":{"type":"string"},"other_certification_schemes_or_standards_certified":{"type":"string"},"certificate_valid_from_date":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"audit_report_id":{"type":"string"},"national_recognition_authority":{"type":"string"},"sites_audited":{"type":"string"},"monitoring_plan_id":{"type":"string"},"recognition_date":{"type":"string"},"audit_report_summary":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"audit_method_sampling_basis":{"type":"string"},"date_certified":{"type":"string"},"audit_team_composition":{"type":"string"},"recognition_scope":{"type":"string"},"audit_itinerary":{"type":"string"}}},"example":{"audit_report_id":"string","audit_report_summary":"Audit confirmed conformance to methodology X for monitoring period FY2027; no major non-conformities.","operator_id":"op_05OFWI037022","group_manager_legal_name":"Green Fields Cooperative GmbH","group_manager_address":"Hauptstrasse 12, 15230 Frankfurt (Oder), Germany","group_activity_operator_list":"[{\"operator\": \"Oderbruch Farms GmbH\", \"address\": \"Dorfstrasse 4, 15324 Letschin, Germany\"}]","activity_id":"a_05OFWI037022","certification_scope":"Carbon farming activity a_05OFWI037022, 120 ha across 14 parcels, monitoring period 2027 to 2031","certification_scheme_id":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","certification_methodology_legal_reference":"Methodology crcf_agri_mineral_soils version 1.0, adopted under Article 8 of Regulation (EU) 2024/3012","activity_plan_id":"ap_01HZY3...","monitoring_plan_id":"mp_01HZYW...","permanent_net_carbon_removal_benefit":6.5,"carbon_farming_temporary_net_carbon_removal_benefit":6.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"sustainability_co_benefits":"Biodiversity and soil health (Article 7(1)(f))","certification_body_id":"DNV Business Assurance Germany GmbH","audit_team_composition":"Lead auditor, one soil science expert, one auditor in training","national_accreditation_body":"DAkkS (Germany), accredited for carbon farming certification audits since 1 March 2025","accreditation_scope":"Verification and certification of carbon farming activities under Regulation (EU) 2024/3012","accreditation_date":"2025-03-01","national_recognition_authority":"Not applicable (accredited body)","recognition_scope":"Not applicable (accredited body)","recognition_date":"2026-05-24","audit_date":"2026-12-15","audit_itinerary":"Day 1 on-site: farm and parcels A to C. Day 2 on-site: records review. Day 3 remote: closing meeting","audit_duration_onsite":"2 days","audit_duration_remote":"1 day","sites_audited":"Oderbruch Farms GmbH headquarters and 4 of 14 parcels","audit_method_risk_assessment":"Risk-based: more sampling on parcels with a large claimed benefit","audit_method_sampling_basis":"Random sample of 30% of parcels plus all parcels above 10 ha","audit_method_stakeholder_consultation":"Interviews with the operator, the farm advisor and two neighbouring landowners","other_certification_schemes_or_standards_certified":"string","ghg_data_type":"Measured (soil sampling), with modelled values for unsampled parcels","audit_report_issue_location":"Hamburg, Germany","audit_report_issue_date":"2026-12-20","certificate_valid_from_date":"2027-01-01","certificate_valid_to_date":"2031-12-31","date_certified":"2026-12-25","issuing_party_signature_or_stamp":"Signed and stamped by the lead auditor, DNV Business Assurance Germany GmbH"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"audit_report":{"type":"object","properties":{"audit_method_stakeholder_consultation":{"type":"string"},"sustainability_co_benefits":{"type":"string"},"audit_method_risk_assessment":{"type":"string"},"accreditation_date":{"type":"string"},"group_manager_address":{"type":"string"},"audit_duration_remote":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"national_accreditation_body":{"type":"string"},"audit_report_issue_date":{"type":"string"},"certification_body_id":{"type":"string"},"group_manager_legal_name":{"type":"string"},"audit_duration_onsite":{"type":"string"},"activity_plan_id":{"type":"string"},"audit_date":{"type":"string"},"certification_scheme_id":{"type":"string"},"certificate_valid_to_date":{"type":"string"},"ghg_data_type":{"type":"string"},"accreditation_scope":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"certification_scope":{"type":"string"},"audit_report_issue_location":{"type":"string"},"certification_methodology_legal_reference":{"type":"string"},"issuing_party_signature_or_stamp":{"type":"string"},"group_activity_operator_list":{"type":"string"},"other_certification_schemes_or_standards_certified":{"type":"string"},"certificate_valid_from_date":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"audit_report_id":{"type":"string"},"national_recognition_authority":{"type":"string"},"sites_audited":{"type":"string"},"monitoring_plan_id":{"type":"string"},"recognition_date":{"type":"string"},"audit_report_summary":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"audit_method_sampling_basis":{"type":"string"},"date_certified":{"type":"string"},"audit_team_composition":{"type":"string"},"recognition_scope":{"type":"string"},"audit_itinerary":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"audit_report":{"audit_report_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","audit_report_id":"string","audit_report_summary":"Audit confirmed conformance to methodology X for monitoring period FY2027; no major non-conformities.","operator_id":"op_05OFWI037022","group_manager_legal_name":"Green Fields Cooperative GmbH","group_manager_address":"Hauptstrasse 12, 15230 Frankfurt (Oder), Germany","group_activity_operator_list":"[{\"operator\": \"Oderbruch Farms GmbH\", \"address\": \"Dorfstrasse 4, 15324 Letschin, Germany\"}]","activity_id":"a_05OFWI037022","certification_scope":"Carbon farming activity a_05OFWI037022, 120 ha across 14 parcels, monitoring period 2027 to 2031","certification_scheme_id":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","certification_methodology_legal_reference":"Methodology crcf_agri_mineral_soils version 1.0, adopted under Article 8 of Regulation (EU) 2024/3012","activity_plan_id":"ap_01HZY3...","monitoring_plan_id":"mp_01HZYW...","permanent_net_carbon_removal_benefit":6.5,"carbon_farming_temporary_net_carbon_removal_benefit":6.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"sustainability_co_benefits":"Biodiversity and soil health (Article 7(1)(f))","certification_body_id":"DNV Business Assurance Germany GmbH","audit_team_composition":"Lead auditor, one soil science expert, one auditor in training","national_accreditation_body":"DAkkS (Germany), accredited for carbon farming certification audits since 1 March 2025","accreditation_scope":"Verification and certification of carbon farming activities under Regulation (EU) 2024/3012","accreditation_date":"2025-03-01","national_recognition_authority":"Not applicable (accredited body)","recognition_scope":"Not applicable (accredited body)","recognition_date":"2026-05-24","audit_date":"2026-12-15","audit_itinerary":"Day 1 on-site: farm and parcels A to C. Day 2 on-site: records review. Day 3 remote: closing meeting","audit_duration_onsite":"2 days","audit_duration_remote":"1 day","sites_audited":"Oderbruch Farms GmbH headquarters and 4 of 14 parcels","audit_method_risk_assessment":"Risk-based: more sampling on parcels with a large claimed benefit","audit_method_sampling_basis":"Random sample of 30% of parcels plus all parcels above 10 ha","audit_method_stakeholder_consultation":"Interviews with the operator, the farm advisor and two neighbouring landowners","other_certification_schemes_or_standards_certified":"string","ghg_data_type":"Measured (soil sampling), with modelled values for unsampled parcels","audit_report_issue_location":"Hamburg, Germany","audit_report_issue_date":"2026-12-20","certificate_valid_from_date":"2027-01-01","certificate_valid_to_date":"2031-12-31","date_certified":"2026-12-25","issuing_party_signature_or_stamp":"Signed and stamped by the lead auditor, DNV Business Assurance Germany GmbH"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Audit_report(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete audit_report by id","description":"<p>Delete audit_report by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"audit_report\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteaudit_report_ogcr","parameters":[{"name":"auditreportid","in":"path","description":"The AUDITREPORTID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"audit_report":{"type":"object","properties":{"audit_method_stakeholder_consultation":{"type":"string"},"sustainability_co_benefits":{"type":"string"},"audit_method_risk_assessment":{"type":"string"},"accreditation_date":{"type":"string"},"group_manager_address":{"type":"string"},"audit_duration_remote":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"national_accreditation_body":{"type":"string"},"audit_report_issue_date":{"type":"string"},"certification_body_id":{"type":"string"},"group_manager_legal_name":{"type":"string"},"audit_duration_onsite":{"type":"string"},"activity_plan_id":{"type":"string"},"audit_date":{"type":"string"},"certification_scheme_id":{"type":"string"},"certificate_valid_to_date":{"type":"string"},"ghg_data_type":{"type":"string"},"accreditation_scope":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"certification_scope":{"type":"string"},"audit_report_issue_location":{"type":"string"},"certification_methodology_legal_reference":{"type":"string"},"issuing_party_signature_or_stamp":{"type":"string"},"group_activity_operator_list":{"type":"string"},"other_certification_schemes_or_standards_certified":{"type":"string"},"certificate_valid_from_date":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"audit_report_id":{"type":"string"},"national_recognition_authority":{"type":"string"},"sites_audited":{"type":"string"},"monitoring_plan_id":{"type":"string"},"recognition_date":{"type":"string"},"audit_report_summary":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"audit_method_sampling_basis":{"type":"string"},"date_certified":{"type":"string"},"audit_team_composition":{"type":"string"},"recognition_scope":{"type":"string"},"audit_itinerary":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"audit_report":{"audit_report_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","audit_report_id":"string","audit_report_summary":"Audit confirmed conformance to methodology X for monitoring period FY2027; no major non-conformities.","operator_id":"op_05OFWI037022","group_manager_legal_name":"Green Fields Cooperative GmbH","group_manager_address":"Hauptstrasse 12, 15230 Frankfurt (Oder), Germany","group_activity_operator_list":"[{\"operator\": \"Oderbruch Farms GmbH\", \"address\": \"Dorfstrasse 4, 15324 Letschin, Germany\"}]","activity_id":"a_05OFWI037022","certification_scope":"Carbon farming activity a_05OFWI037022, 120 ha across 14 parcels, monitoring period 2027 to 2031","certification_scheme_id":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","certification_methodology_legal_reference":"Methodology crcf_agri_mineral_soils version 1.0, adopted under Article 8 of Regulation (EU) 2024/3012","activity_plan_id":"ap_01HZY3...","monitoring_plan_id":"mp_01HZYW...","permanent_net_carbon_removal_benefit":6.5,"carbon_farming_temporary_net_carbon_removal_benefit":6.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"sustainability_co_benefits":"Biodiversity and soil health (Article 7(1)(f))","certification_body_id":"DNV Business Assurance Germany GmbH","audit_team_composition":"Lead auditor, one soil science expert, one auditor in training","national_accreditation_body":"DAkkS (Germany), accredited for carbon farming certification audits since 1 March 2025","accreditation_scope":"Verification and certification of carbon farming activities under Regulation (EU) 2024/3012","accreditation_date":"2025-03-01","national_recognition_authority":"Not applicable (accredited body)","recognition_scope":"Not applicable (accredited body)","recognition_date":"2026-05-24","audit_date":"2026-12-15","audit_itinerary":"Day 1 on-site: farm and parcels A to C. Day 2 on-site: records review. Day 3 remote: closing meeting","audit_duration_onsite":"2 days","audit_duration_remote":"1 day","sites_audited":"Oderbruch Farms GmbH headquarters and 4 of 14 parcels","audit_method_risk_assessment":"Risk-based: more sampling on parcels with a large claimed benefit","audit_method_sampling_basis":"Random sample of 30% of parcels plus all parcels above 10 ha","audit_method_stakeholder_consultation":"Interviews with the operator, the farm advisor and two neighbouring landowners","other_certification_schemes_or_standards_certified":"string","ghg_data_type":"Measured (soil sampling), with modelled values for unsampled parcels","audit_report_issue_location":"Hamburg, Germany","audit_report_issue_date":"2026-12-20","certificate_valid_from_date":"2027-01-01","certificate_valid_to_date":"2031-12-31","date_certified":"2026-12-25","issuing_party_signature_or_stamp":"Signed and stamped by the lead auditor, DNV Business Assurance Germany GmbH"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Audit_report(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update audit_report","description":"<p>Partially update audit_report: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>Audit report is the outcome of the audit conducted by certification bodies. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>audit_report_id: (uu)id of the audit report</li>\n<li>audit_report_summary: Short human-readable summary of audit scope, approach, and conclusion.</li>\n<li>operator_id: Operator\u2019s legal name</li>\n<li>group_manager_legal_name: For group certification: group manager name</li>\n<li>group_manager_address: For group certification: group manager address</li>\n<li>group_activity_operator_list: For group certification: list of carbon farming activities under scope (operators\u2019 names and addresses)</li>\n<li>activity_id: Internal identifier for the activity entity</li>\n<li>certification_scope: Scope of certification</li>\n<li>certification_scheme_id: Methodology(ies) the scheme applies (identifier + version).</li>\n<li>certification_methodology_legal_reference: Legal reference for certification methodology</li>\n<li>activity_plan_id: Reference number of the activity plan</li>\n<li>monitoring_plan_id: Reference number of the monitoring plan</li>\n<li>permanent_net_carbon_removal_benefit: Expected/verified amount of permanent net carbon removal benefit (in Co2e Tonnes)</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: Expected/verified amount of temporary net carbon removal benefit (in Co2e Tonnes)</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: Expected/verified amount of net soil emission reduction benefit (in Co2e Tonnes)</li>\n<li>sustainability_co_benefits: Sustainability co-benefits associated with the activity</li>\n<li>certification_body_id: Legal or trading name of the certification body</li>\n<li>audit_team_composition: Composition of the audit team</li>\n<li>national_accreditation_body: National accreditation body and scope/date of accreditation (or recognition authority and scope/date)</li>\n<li>accreditation_scope: Accreditation scope</li>\n<li>accreditation_date: Accreditation date</li>\n<li>national_recognition_authority: National recognition authority</li>\n<li>recognition_scope: Recognition scope</li>\n<li>recognition_date: Recognition date</li>\n<li>audit_date: Date of the audit</li>\n<li>audit_itinerary: Audit itinerary and duration (split onsite/remote where relevant)</li>\n<li>audit_duration_onsite: Duration spent on-site</li>\n<li>audit_duration_remote: Duration spent remotely</li>\n<li>sites_audited: Sites audited</li>\n<li>audit_method_risk_assessment: Audit method, risk assessment</li>\n<li>audit_method_sampling_basis: Audit method, sampling basis</li>\n<li>audit_method_stakeholder_consultation: Audit method, stakeholder consultation</li>\n<li>other_certification_schemes_or_standards_certified: Certification of other certification schemes or standards</li>\n<li>ghg_data_type: GHG data type</li>\n<li>audit_report_issue_location: Place of issuance of the audit report</li>\n<li>audit_report_issue_date: Date of issuance of the audit report</li>\n<li>certificate_valid_from_date: Certificate valid from date</li>\n<li>certificate_valid_to_date: Certificate valid to date</li>\n<li>date_certified: Date certified (if applicable)</li>\n<li>issuing_party_signature_or_stamp: Stamp and/or signature of issuing party</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"audit_report\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchaudit_report_ogcr","parameters":[{"name":"auditreportid","in":"path","description":"The AUDITREPORTID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"audit_method_stakeholder_consultation":{"type":"string"},"sustainability_co_benefits":{"type":"string"},"audit_method_risk_assessment":{"type":"string"},"accreditation_date":{"type":"string"},"group_manager_address":{"type":"string"},"audit_duration_remote":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"national_accreditation_body":{"type":"string"},"audit_report_issue_date":{"type":"string"},"certification_body_id":{"type":"string"},"group_manager_legal_name":{"type":"string"},"audit_duration_onsite":{"type":"string"},"activity_plan_id":{"type":"string"},"audit_date":{"type":"string"},"certification_scheme_id":{"type":"string"},"certificate_valid_to_date":{"type":"string"},"ghg_data_type":{"type":"string"},"accreditation_scope":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"certification_scope":{"type":"string"},"audit_report_issue_location":{"type":"string"},"certification_methodology_legal_reference":{"type":"string"},"issuing_party_signature_or_stamp":{"type":"string"},"group_activity_operator_list":{"type":"string"},"other_certification_schemes_or_standards_certified":{"type":"string"},"certificate_valid_from_date":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"audit_report_id":{"type":"string"},"national_recognition_authority":{"type":"string"},"sites_audited":{"type":"string"},"monitoring_plan_id":{"type":"string"},"recognition_date":{"type":"string"},"audit_report_summary":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"audit_method_sampling_basis":{"type":"string"},"date_certified":{"type":"string"},"audit_team_composition":{"type":"string"},"recognition_scope":{"type":"string"},"audit_itinerary":{"type":"string"}}},"example":{"audit_report_id":"string","audit_report_summary":"Audit confirmed conformance to methodology X for monitoring period FY2027; no major non-conformities.","operator_id":"op_05OFWI037022","group_manager_legal_name":"Green Fields Cooperative GmbH","group_manager_address":"Hauptstrasse 12, 15230 Frankfurt (Oder), Germany","group_activity_operator_list":"[{\"operator\": \"Oderbruch Farms GmbH\", \"address\": \"Dorfstrasse 4, 15324 Letschin, Germany\"}]","activity_id":"a_05OFWI037022","certification_scope":"Carbon farming activity a_05OFWI037022, 120 ha across 14 parcels, monitoring period 2027 to 2031","certification_scheme_id":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","certification_methodology_legal_reference":"Methodology crcf_agri_mineral_soils version 1.0, adopted under Article 8 of Regulation (EU) 2024/3012","activity_plan_id":"ap_01HZY3...","monitoring_plan_id":"mp_01HZYW...","permanent_net_carbon_removal_benefit":6.5,"carbon_farming_temporary_net_carbon_removal_benefit":6.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"sustainability_co_benefits":"Biodiversity and soil health (Article 7(1)(f))","certification_body_id":"DNV Business Assurance Germany GmbH","audit_team_composition":"Lead auditor, one soil science expert, one auditor in training","national_accreditation_body":"DAkkS (Germany), accredited for carbon farming certification audits since 1 March 2025","accreditation_scope":"Verification and certification of carbon farming activities under Regulation (EU) 2024/3012","accreditation_date":"2025-03-01","national_recognition_authority":"Not applicable (accredited body)","recognition_scope":"Not applicable (accredited body)","recognition_date":"2026-05-24","audit_date":"2026-12-15","audit_itinerary":"Day 1 on-site: farm and parcels A to C. Day 2 on-site: records review. Day 3 remote: closing meeting","audit_duration_onsite":"2 days","audit_duration_remote":"1 day","sites_audited":"Oderbruch Farms GmbH headquarters and 4 of 14 parcels","audit_method_risk_assessment":"Risk-based: more sampling on parcels with a large claimed benefit","audit_method_sampling_basis":"Random sample of 30% of parcels plus all parcels above 10 ha","audit_method_stakeholder_consultation":"Interviews with the operator, the farm advisor and two neighbouring landowners","other_certification_schemes_or_standards_certified":"string","ghg_data_type":"Measured (soil sampling), with modelled values for unsampled parcels","audit_report_issue_location":"Hamburg, Germany","audit_report_issue_date":"2026-12-20","certificate_valid_from_date":"2027-01-01","certificate_valid_to_date":"2031-12-31","date_certified":"2026-12-25","issuing_party_signature_or_stamp":"Signed and stamped by the lead auditor, DNV Business Assurance Germany GmbH"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"audit_report":{"type":"object","properties":{"audit_method_stakeholder_consultation":{"type":"string"},"sustainability_co_benefits":{"type":"string"},"audit_method_risk_assessment":{"type":"string"},"accreditation_date":{"type":"string"},"group_manager_address":{"type":"string"},"audit_duration_remote":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"national_accreditation_body":{"type":"string"},"audit_report_issue_date":{"type":"string"},"certification_body_id":{"type":"string"},"group_manager_legal_name":{"type":"string"},"audit_duration_onsite":{"type":"string"},"activity_plan_id":{"type":"string"},"audit_date":{"type":"string"},"certification_scheme_id":{"type":"string"},"certificate_valid_to_date":{"type":"string"},"ghg_data_type":{"type":"string"},"accreditation_scope":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"certification_scope":{"type":"string"},"audit_report_issue_location":{"type":"string"},"certification_methodology_legal_reference":{"type":"string"},"issuing_party_signature_or_stamp":{"type":"string"},"group_activity_operator_list":{"type":"string"},"other_certification_schemes_or_standards_certified":{"type":"string"},"certificate_valid_from_date":{"type":"string"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"audit_report_id":{"type":"string"},"national_recognition_authority":{"type":"string"},"sites_audited":{"type":"string"},"monitoring_plan_id":{"type":"string"},"recognition_date":{"type":"string"},"audit_report_summary":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"audit_method_sampling_basis":{"type":"string"},"date_certified":{"type":"string"},"audit_team_composition":{"type":"string"},"recognition_scope":{"type":"string"},"audit_itinerary":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"audit_report":{"audit_report_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","audit_report_id":"string","audit_report_summary":"Audit confirmed conformance to methodology X for monitoring period FY2027; no major non-conformities.","operator_id":"op_05OFWI037022","group_manager_legal_name":"Green Fields Cooperative GmbH","group_manager_address":"Hauptstrasse 12, 15230 Frankfurt (Oder), Germany","group_activity_operator_list":"[{\"operator\": \"Oderbruch Farms GmbH\", \"address\": \"Dorfstrasse 4, 15324 Letschin, Germany\"}]","activity_id":"a_05OFWI037022","certification_scope":"Carbon farming activity a_05OFWI037022, 120 ha across 14 parcels, monitoring period 2027 to 2031","certification_scheme_id":"{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}","certification_methodology_legal_reference":"Methodology crcf_agri_mineral_soils version 1.0, adopted under Article 8 of Regulation (EU) 2024/3012","activity_plan_id":"ap_01HZY3...","monitoring_plan_id":"mp_01HZYW...","permanent_net_carbon_removal_benefit":6.5,"carbon_farming_temporary_net_carbon_removal_benefit":6.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"sustainability_co_benefits":"Biodiversity and soil health (Article 7(1)(f))","certification_body_id":"DNV Business Assurance Germany GmbH","audit_team_composition":"Lead auditor, one soil science expert, one auditor in training","national_accreditation_body":"DAkkS (Germany), accredited for carbon farming certification audits since 1 March 2025","accreditation_scope":"Verification and certification of carbon farming activities under Regulation (EU) 2024/3012","accreditation_date":"2025-03-01","national_recognition_authority":"Not applicable (accredited body)","recognition_scope":"Not applicable (accredited body)","recognition_date":"2026-05-24","audit_date":"2026-12-15","audit_itinerary":"Day 1 on-site: farm and parcels A to C. Day 2 on-site: records review. Day 3 remote: closing meeting","audit_duration_onsite":"2 days","audit_duration_remote":"1 day","sites_audited":"Oderbruch Farms GmbH headquarters and 4 of 14 parcels","audit_method_risk_assessment":"Risk-based: more sampling on parcels with a large claimed benefit","audit_method_sampling_basis":"Random sample of 30% of parcels plus all parcels above 10 ha","audit_method_stakeholder_consultation":"Interviews with the operator, the farm advisor and two neighbouring landowners","other_certification_schemes_or_standards_certified":"string","ghg_data_type":"Measured (soil sampling), with modelled values for unsampled parcels","audit_report_issue_location":"Hamburg, Germany","audit_report_issue_date":"2026-12-20","certificate_valid_from_date":"2027-01-01","certificate_valid_to_date":"2031-12-31","date_certified":"2026-12-25","issuing_party_signature_or_stamp":"Signed and stamped by the lead auditor, DNV Business Assurance Germany GmbH"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/activity-media/{activitymediaid}":{"get":{"tags":["_Activity_media(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public activity_media by id","description":"<p>Get Public activity_media by id.</p>\n<p>Parsed entity activity_media. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_media\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePublicactivity_media_ogcr","parameters":[{"name":"activitymediaid","in":"path","description":"The ACTIVITYMEDIAID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_media":{"type":"object","properties":{"author":{"type":"string"},"activity_media_type":{"type":"string"},"image":{"type":"string"},"activity_media_id":{"type":"string"},"published_date":{"type":"string"},"activity_id":{"type":"string"},"link":{"type":"string"},"title":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"activity_media":{"activity_media_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","activity_media_id":"string","activity_media_type":"string","title":"string","published_date":"2020-01-01","image":"string","author":"string","link":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/carbon-credit-balance-on-chain":{"get":{"tags":["_Carbon_credit_balance_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get carbon_credit_balance_on_chain List","description":"<p>Get carbon_credit_balance_on_chain List.</p>\n<p>Cache of CarbonCredit (ERC-20) balances on the OGCR chain (chain id 20253). One record per holding address, covering both operator wallets and the ERC-6551 token-bound accounts of credit batches. Populated by OGCR-chain-cache, which derives the holder set from Transfer events and then reads each balance at the current head. Balances are current-state, not historical: each record is only true as of block_number.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>balance: CarbonCredit balance in smallest units, as read at block_number. Decimal string because a uint256 does not fit an integer field. Divide by 10^decimals for tonnes CO2e.</li>\n<li>batch_token_id: When holder_type is token_bound_account, the CarbonCreditBatchNFT token id this account belongs to. 0 otherwise. Join to <code>carbon_credit_batch_on_chain</code>.token_id.</li>\n<li>block_number: Block height the balance was read at.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: CarbonCredit ERC-20 contract address the balance was read from.</li>\n<li>decimals: Decimals of the CarbonCredit ERC-20, for rendering balance.</li>\n<li>holder_type: Whether this address is a plain wallet or the ERC-6551 token-bound account of a credit batch. One of: wallet, token_bound_account. A token_bound_account balance is credits still held inside their batch; a wallet balance is credits withdrawn from a batch and now pooled.</li>\n<li>owner_address: Address holding the balance, lowercase-insensitive checksum form. The business key for this record. Match against operator.ogcr_wallet_address or land_manager.ogcr_wallet_address to find a party's holdings.</li>\n<li>symbol: Symbol of the CarbonCredit ERC-20.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"carbon_credit_balance_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p><em>(no fields on this entity are declared <code>indexed</code>, so only the legacy bare-parameter filter below is available.)</em></p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getcarbon_credit_balance_on_chainList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"carbon_credit_balance_on_chain_list":{"type":"array","items":{"type":"object","properties":{"carbon_credit_balance_on_chain":{"type":"object","properties":{"balance":{"type":"string"},"owner_address":{"type":"string"},"symbol":{"type":"string"},"carbon_credit_balance_on_chain_id":{"type":"string"},"holder_type":{"type":"string"},"batch_token_id":{"type":"integer"},"block_number":{"type":"integer"},"chain_id":{"type":"integer"},"contract_address":{"type":"string"},"decimals":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"carbon_credit_balance_on_chain_list":[{"carbon_credit_balance_on_chain":{"carbon_credit_balance_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","balance":"1000000000000000000","batch_token_id":1,"block_number":12400,"chain_id":20253,"contract_address":"0x1B4bC0dE8b6A1A2b3C4d5E6f7A8b9C0d1E2f3A4b","decimals":18,"holder_type":"token_bound_account","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","symbol":"CC"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Carbon_credit_balance_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new carbon_credit_balance_on_chain","description":"<p>Create new carbon_credit_balance_on_chain.</p>\n<p>Cache of CarbonCredit (ERC-20) balances on the OGCR chain (chain id 20253). One record per holding address, covering both operator wallets and the ERC-6551 token-bound accounts of credit batches. Populated by OGCR-chain-cache, which derives the holder set from Transfer events and then reads each balance at the current head. Balances are current-state, not historical: each record is only true as of block_number.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>balance: CarbonCredit balance in smallest units, as read at block_number. Decimal string because a uint256 does not fit an integer field. Divide by 10^decimals for tonnes CO2e.</li>\n<li>batch_token_id: When holder_type is token_bound_account, the CarbonCreditBatchNFT token id this account belongs to. 0 otherwise. Join to <code>carbon_credit_batch_on_chain</code>.token_id.</li>\n<li>block_number: Block height the balance was read at.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: CarbonCredit ERC-20 contract address the balance was read from.</li>\n<li>decimals: Decimals of the CarbonCredit ERC-20, for rendering balance.</li>\n<li>holder_type: Whether this address is a plain wallet or the ERC-6551 token-bound account of a credit batch. One of: wallet, token_bound_account. A token_bound_account balance is credits still held inside their batch; a wallet balance is credits withdrawn from a batch and now pooled.</li>\n<li>owner_address: Address holding the balance, lowercase-insensitive checksum form. The business key for this record. Match against operator.ogcr_wallet_address or land_manager.ogcr_wallet_address to find a party's holdings.</li>\n<li>symbol: Symbol of the CarbonCredit ERC-20.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"carbon_credit_balance_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createcarbon_credit_balance_on_chain_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"balance":{"type":"string"},"owner_address":{"type":"string"},"symbol":{"type":"string"},"holder_type":{"type":"string"},"batch_token_id":{"type":"integer"},"block_number":{"type":"integer"},"chain_id":{"type":"integer"},"contract_address":{"type":"string"},"decimals":{"type":"integer"}}},"example":{"balance":"1000000000000000000","batch_token_id":1,"block_number":12400,"chain_id":20253,"contract_address":"0x1B4bC0dE8b6A1A2b3C4d5E6f7A8b9C0d1E2f3A4b","decimals":18,"holder_type":"token_bound_account","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","symbol":"CC"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"carbon_credit_balance_on_chain":{"type":"object","properties":{"balance":{"type":"string"},"owner_address":{"type":"string"},"symbol":{"type":"string"},"carbon_credit_balance_on_chain_id":{"type":"string"},"holder_type":{"type":"string"},"batch_token_id":{"type":"integer"},"block_number":{"type":"integer"},"chain_id":{"type":"integer"},"contract_address":{"type":"string"},"decimals":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"carbon_credit_balance_on_chain":{"carbon_credit_balance_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","balance":"1000000000000000000","batch_token_id":1,"block_number":12400,"chain_id":20253,"contract_address":"0x1B4bC0dE8b6A1A2b3C4d5E6f7A8b9C0d1E2f3A4b","decimals":18,"holder_type":"token_bound_account","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","symbol":"CC"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/parcel-on-chain":{"get":{"tags":["_Parcel_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public parcel_on_chain List","description":"<p>Get Public parcel_on_chain List.</p>\n<p>Cache of ParcelNFT data minted on the OGCR chain (chain id 20253). One record per parcel_id, populated by OGCR-chain-cache reading the chain. Does not mutate the source <code>parcel</code> entity.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>block_number: Block number the mint was included in.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: ParcelNFT contract address the token was read from.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>parcel_hash: parcel_hash stored on-chain: keccak256 of the raw parcel entity body.</li>\n<li>parcel_id: Links to the <code>parcel</code> dynamic entity. The on-chain ParcelNFT is keyed by this id.</li>\n<li>parcel_uri: parcel_uri stored on-chain: link back to the OBP parcel entity.</li>\n<li>token_id: ParcelNFT token id minted for this parcel.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>tx_hash: Mint transaction hash (from the ParcelMinted event).</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p><em>(no fields on this entity are declared <code>indexed</code>, so only the legacy bare-parameter filter below is available.)</em></p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPublicparcel_on_chainList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_on_chain_list":{"type":"array","items":{"type":"object","properties":{"parcel_on_chain":{"type":"object","properties":{"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"token_id":{"type":"integer"},"parcel_id":{"type":"string"},"block_number":{"type":"integer"},"parcel_uri":{"type":"string"},"chain_id":{"type":"integer"},"parcel_on_chain_id":{"type":"string"},"owner_address":{"type":"string"},"contract_address":{"type":"string"},"parcel_hash":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"parcel_on_chain_list":[{"parcel_on_chain":{"parcel_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","block_number":12345,"chain_id":20253,"contract_address":"0x62227531b82259561CC9ad4413188F08E536598a","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","parcel_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","parcel_id":"parcel_AB12CD34EF","parcel_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/parcel/parcel_AB12CD34EF","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiUGFyY2VsIn0=","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/public/certificate-of-compliance":{"get":{"tags":["_Certificate_of_compliance(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public certificate_of_compliance List","description":"<p>Get Public certificate_of_compliance List.</p>\n<p>\u2018certificate of compliance\u2019 means a conformity statement issued by a certification body certifying that an activity complies with this Regulation;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certificate_of_compliance_id: ID of the certificate of compliance</li>\n<li>certification_scheme_id: ID of the certification scheme</li>\n<li>certification_body_id: ID of the certification body</li>\n<li>activity_id: ID of the activity being certified.</li>\n<li>country_id: Country of issuance</li>\n<li>issue_date: Issuance data</li>\n<li>expiry_date: Expiry date</li>\n<li>carbon_removals_under_baseline: Carbon removals that would have occurred under the baseline, without the activity (CO2e tonnes)</li>\n<li>soil_emissions_under_baseline: Soil emissions that would have occurred under the baseline (CO2e tonnes)</li>\n<li>permanent_net_carbon_removal_benefit: Permanent net carbon removal benefit certified for the activity (CO2e tonnes)</li>\n<li>carbon_farming_temporary_net_carbon_removal_benefit: Temporary net carbon removal benefit from carbon farming certified for the activity (CO2e tonnes)</li>\n<li>carbon_farming_net_soil_emission_reduction_benefit: Net soil emission reduction benefit from carbon farming certified for the activity (CO2e tonnes)</li>\n<li>carbon_storage_temporary_net_carbon_removal_benefit: Temporary net carbon removal benefit from carbon storage in products certified for the activity (CO2e tonnes)</li>\n<li>unit_type: Unit category produced during this activity. (Permanent Removal,<br />\nCarbon Farming Sequestration, Soil Emission Reduction, Carbon Storage in Product)</li>\n<li>certification_status: The status of a certificate. Either \"Certified\" or \"Expired\"</li>\n<li>certification_scheme_rules_and_procedures: Reference to the rules and procedures of the certification scheme under which the certificate was issued</li>\n<li>certification_annual_reports: Reference to the annual reports of the certification scheme</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certificate_of_compliance\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>audit_report_id</code>, <code>certificate_of_compliance_id</code>, <code>certification_body_id</code>, <code>certification_scheme_id</code>, <code>country_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPubliccertificate_of_complianceList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certificate_of_compliance_list":{"type":"array","items":{"type":"object","properties":{"certificate_of_compliance":{"type":"object","properties":{"certification_annual_reports":{"type":"string"},"carbon_storage_temporary_net_carbon_removal_benefit":{"type":"number"},"carbon_removals_under_baseline":{"type":"number"},"certification_scheme_rules_and_procedures":{"type":"string"},"activity_id":{"type":"string"},"soil_emissions_under_baseline":{"type":"number"},"carbon_farming_temporary_net_carbon_removal_benefit":{"type":"number"},"certification_body_id":{"type":"string"},"audit_report_id":{"type":"string"},"expiry_date":{"type":"string"},"unit_type":{"type":"string"},"certification_scheme_id":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"issue_date":{"type":"string"},"certification_status":{"type":"string"},"carbon_farming_net_soil_emission_reduction_benefit":{"type":"number"},"permanent_net_carbon_removal_benefit":{"type":"number"},"country_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"certificate_of_compliance_list":[{"certificate_of_compliance":{"certificate_of_compliance_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certificate_of_compliance_id":"3dece208-c95c-11f0-9041-54e1adfac5b3","certification_scheme_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","certification_body_id":"3dece208-c95c-11f0-9041-54e1adfac5b2","activity_id":"a_05OFWI037022","audit_report_id":"string","country_id":"DE","issue_date":"2026-12-25","expiry_date":"2031-12-25","carbon_removals_under_baseline":6.5,"soil_emissions_under_baseline":6.5,"permanent_net_carbon_removal_benefit":6.5,"carbon_farming_temporary_net_carbon_removal_benefit":6.5,"carbon_farming_net_soil_emission_reduction_benefit":6.5,"carbon_storage_temporary_net_carbon_removal_benefit":6.5,"unit_type":"Carbon Farming Sequestration","certification_status":"Verified","certification_scheme_rules_and_procedures":"https://scheme.example.org/rules-and-procedures-v2.1.pdf","certification_annual_reports":"https://scheme.example.org/annual-report-2026.pdf"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/public/operator":{"get":{"tags":["_Operator(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public operator List","description":"<p>Get Public operator List.</p>\n<p>\u2018operator\u2019 means any natural or legal person or public entity that operates or controls an activity, or to whom or to which decisive economic power over the technical functioning of the activity has been delegated;. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>operator_id: Internal identifier for the operator entity</li>\n<li>legal_name: Legal name of the Operator.</li>\n<li>email: Operator email address.</li>\n<li>phone: Operator contact phone in international format.</li>\n<li>address_line_1: Operator primary street address (street name, building number, P.O. Box if applicable)</li>\n<li>address_line_2: Operator secondary, optional details like apartment, suite, unit, floor, or building name</li>\n<li>postcode: Operator postcode</li>\n<li>country_id: ISO 3166-1 alpha-2 country code for operator address.</li>\n<li>ogcr_wallet_address: Wallet address to send NFTs and carbon credits to after evaluation period</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"operator\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>country_id</code>, <code>operator_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPublicoperatorList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"operator_list":{"type":"array","items":{"type":"object","properties":{"operator":{"type":"object","properties":{"email":{"type":"string"},"postcode":{"type":"string"},"operator_id":{"type":"string"},"ogcr_wallet_address":{"type":"string"},"address_line_2":{"type":"string"},"legal_name":{"type":"string"},"country_id":{"type":"string"},"address_line_1":{"type":"string"},"phone":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"operator_list":[{"operator":{"operator_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","operator_id":"op_01JS0347FKH","legal_name":"Agreena","email":"contact@example.com","phone":"+49 123 456 789","address_line_1":"Green Street, 20","address_line_2":"Suite 400","postcode":"10115\" or \"W1K 3JP","country_id":"DE","ogcr_wallet_address":"0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/public/activity-on-chain/{activityonchainid}":{"get":{"tags":["_Activity_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public activity_on_chain by id","description":"<p>Get Public activity_on_chain by id.</p>\n<p>Cache of ActivityNFT data minted on the OGCR chain (chain id 20253). One record per activity_id, populated by OGCR-chain-cache reading the chain.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_hash: activity_hash stored on-chain: keccak256 of the raw activity entity body.</li>\n<li>activity_id: The <code>activity</code> this NFT was minted for (a reference, so OBP joins activity -&gt; activity_on_chain, e.g. in the registry query). OBP refuses a record whose activity is not in this space.</li>\n<li>activity_type: Activity type as stored on-chain.</li>\n<li>activity_url: activity_url stored on-chain: link back to the OBP activity entity.</li>\n<li>block_number: Block number the mint was included in.</li>\n<li>certification_scheme_id: certification_scheme_id as stored on-chain.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>city: City as stored on-chain.</li>\n<li>contract_address: ActivityNFT contract address the token was read from.</li>\n<li>country_id: Country id as stored on-chain.</li>\n<li>end_date: Activity end date as stored on-chain.</li>\n<li>minted_at: Unix time (seconds) of the block the mint was included in.</li>\n<li>name: Activity name as stored on-chain.</li>\n<li>operator_id: operator_id stored on-chain (owning operator).</li>\n<li>operator_name: Operator legal name (operator.legal_name) as stored on-chain.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>parcel_ids: Parcels linked to the activity at mint time: the contract's parcel_ids[] joined with commas, as tokenURI renders it.</li>\n<li>start_date: Activity start date as stored on-chain.</li>\n<li>summary: Activity summary as stored on-chain.</li>\n<li>token_id: ActivityNFT token id minted for this activity.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>tx_hash: Mint transaction hash (from the ActivityMinted event).</li>\n<li>unit_types: Unit types of the activity as stored on-chain.</li>\n<li>website: Activity website as stored on-chain.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePublicactivity_on_chain_ogcr","parameters":[{"name":"activityonchainid","in":"path","description":"The ACTIVITYONCHAINID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_on_chain":{"type":"object","properties":{"name":{"type":"string"},"token_uri":{"type":"string"},"activity_on_chain_id":{"type":"string"},"tx_hash":{"type":"string"},"activity_type":{"type":"string"},"owner_address":{"type":"string"},"activity_url":{"type":"string"},"operator_id":{"type":"string"},"activity_id":{"type":"string"},"token_id":{"type":"integer"},"block_number":{"type":"integer"},"contract_address":{"type":"string"},"country_id":{"type":"string"},"summary":{"type":"string"},"chain_id":{"type":"integer"},"website":{"type":"string"},"city":{"type":"string"},"operator_name":{"type":"string"},"start_date":{"type":"string"},"minted_at":{"type":"integer"},"certification_scheme_id":{"type":"string"},"parcel_ids":{"type":"string"},"end_date":{"type":"string"},"unit_types":{"type":"string"},"activity_hash":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"activity_on_chain":{"activity_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","activity_id":"activity_AB12CD34EF","activity_type":"carbon_farming","activity_url":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/activity/activity_AB12CD34EF","block_number":12345,"certification_scheme_id":"scheme_SALUS","chain_id":20253,"city":"Viborg","contract_address":"0x5034F49b27353CeDc562b49eA91C7438Ea351d36","country_id":"DK","end_date":"2024-12-31","minted_at":1779280448,"name":"Reforestation 2024","operator_id":"operator_9XYZ","operator_name":"Example Operator GmbH","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","parcel_ids":"parcel_01,parcel_02","start_date":"2024-01-01","summary":"Rewetting of drained peat soils.","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiQWN0aXZpdHkifQ==","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","unit_types":"Permanent Removal","website":"https://example.org"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/crop":{"get":{"tags":["_Crop(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get crop List","description":"<p>Get crop List.</p>\n<p>A reference table of agricultural crop types. Each record defines a crop category with its commodity classification. growing_season records (below) reference this entity for each instance of a crop grown on a parcel. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>crop_id: Unique internal identifier automatically assigned to each crop type entry.</li>\n<li>crop_type: The specific type of crop, drawn from a controlled vocabulary to ensure consistency across the registry. Used to classify and filter parcels by crop in the supply shed view.</li>\n<li>local_name: The local or vernacular name for the crop as used by the farmer or in the national context. Optional, for display and farmer-facing interfaces only.</li>\n<li>commodity_category: The broad commodity group this crop belongs to, used to aggregate parcels into supply sheds for Scope 3 reporting. Examples: cereals, oilseeds, legumes, forage, vegetables.</li>\n<li>lca_emission_factor: The lifecycle assessment (LCA) emission factor for this crop type, expressed in kilograms of CO2 equivalent per tonne of harvested product. Sourced from IPCC, JRC or Ecoinvent reference datasets \u2014 not entered by farmers. Used by the Scope 3 marketplace to compute emission intensity per sourced tonne.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"crop\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>crop_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getcropList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"crop_list":{"type":"array","items":{"type":"object","properties":{"crop":{"type":"object","properties":{"crop_id":{"type":"string"},"lca_emission_factor":{"type":"number"},"commodity_category":{"type":"string"},"local_name":{"type":"string"},"crop_type":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"crop_list":[{"crop":{"crop_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","crop_id":"crop_01JS0347FKH","crop_type":"winter_wheat","local_name":"Winterweizen","commodity_category":"cereals","lca_emission_factor":0.52},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Crop(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new crop","description":"<p>Create new crop.</p>\n<p>A reference table of agricultural crop types. Each record defines a crop category with its commodity classification. growing_season records (below) reference this entity for each instance of a crop grown on a parcel. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>crop_id: Unique internal identifier automatically assigned to each crop type entry.</li>\n<li>crop_type: The specific type of crop, drawn from a controlled vocabulary to ensure consistency across the registry. Used to classify and filter parcels by crop in the supply shed view.</li>\n<li>local_name: The local or vernacular name for the crop as used by the farmer or in the national context. Optional, for display and farmer-facing interfaces only.</li>\n<li>commodity_category: The broad commodity group this crop belongs to, used to aggregate parcels into supply sheds for Scope 3 reporting. Examples: cereals, oilseeds, legumes, forage, vegetables.</li>\n<li>lca_emission_factor: The lifecycle assessment (LCA) emission factor for this crop type, expressed in kilograms of CO2 equivalent per tonne of harvested product. Sourced from IPCC, JRC or Ecoinvent reference datasets \u2014 not entered by farmers. Used by the Scope 3 marketplace to compute emission intensity per sourced tonne.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"crop\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createcrop_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"crop_id":{"type":"string"},"lca_emission_factor":{"type":"number"},"commodity_category":{"type":"string"},"local_name":{"type":"string"},"crop_type":{"type":"string"}}},"example":{"crop_id":"crop_01JS0347FKH","crop_type":"winter_wheat","local_name":"Winterweizen","commodity_category":"cereals","lca_emission_factor":0.52}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"crop":{"type":"object","properties":{"crop_id":{"type":"string"},"lca_emission_factor":{"type":"number"},"commodity_category":{"type":"string"},"local_name":{"type":"string"},"crop_type":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"crop":{"crop_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","crop_id":"crop_01JS0347FKH","crop_type":"winter_wheat","local_name":"Winterweizen","commodity_category":"cereals","lca_emission_factor":0.52},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/livestock":{"get":{"tags":["_Livestock(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get livestock List","description":"<p>Get livestock List.</p>\n<p>Records a group of animals of the same species kept by an operator, either grazing on a parcel or housed on a farm. Livestock data is not currently within CRCF scope (enteric fermentation 3.A and manure management 3.B are under Commission review until July 2026) but is included here as a v2 entity to support future certification methodologies and Scope 3 supply chain reporting. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>livestock_id: Unique internal identifier automatically assigned to this livestock herd record.</li>\n<li>parcel_id: The parcel where this herd grazes, if applicable. Null for housed animals (pigs, poultry). When populated, links the herd to parcel geometry so that grazing impacts on soil carbon (compaction, manure deposition) can be spatially attributed.</li>\n<li>species: The animal species. Controlled vocabulary aligned with IPCC 3.A/3.B emission factor categories. Determines which emission factors apply for enteric fermentation and manure management.</li>\n<li>breed: The breed of the animals in this herd. Breed affects feed conversion efficiency and methane emission rates, and may be required by future certification methodologies.</li>\n<li>head_count: The number of individual animals in this herd at the time of recording. Used to calculate total livestock units (LU) for the holding and to scale emission estimates.</li>\n<li>head_count_date: The date on which the head count was recorded. Herd size can change over the year (births, sales, slaughter), so the date is required to interpret the figure correctly.</li>\n<li>livestock_unit: Standardised livestock unit (LU) value for this herd, calculated from head count and species. One LU equals one adult dairy cow (500 kg). Used for cross-species comparisons and regulatory thresholds (e.g., nitrates directive).</li>\n<li>production_system: The management system under which these animals are kept. Affects both emission factors and carbon farming practice eligibility. Controlled vocabulary: grazing (animals outdoors year-round), mixed (indoor/outdoor), housed (indoor year-round), feedlot.</li>\n<li>manure_management_system: How animal manure is collected, stored, and applied. This is the primary factor driving methane and N2O emissions under IPCC category 3.B. Controlled vocabulary: slurry_tank, solid_storage, anaerobic_digester, pasture_range, biogas_with_flaring.</li>\n<li>feed_type: The primary feed source for this herd. Feed composition is the main determinant of enteric fermentation rates (IPCC 3.A). High-quality pasture produces less methane per unit of output than low-quality roughage or concentrate-heavy rations.</li>\n<li>avg_daily_weight_gain_kg: Average daily live weight gain per animal, in kilograms. Recorded for beef cattle only. Used with feed conversion ratios to estimate feed intake (this is for enteric fermentation emissions.)</li>\n<li>milk_yield_litres_per_day: Average daily milk production per cow, in litres. Recorded for dairy cattle only. Higher-yielding cows tend to have lower emission intensity per litre of milk, which is relevant for Scope 3 intensity-based reporting.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"livestock\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>livestock_id</code>, <code>parcel_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>parcel_id</code> → <code>parcel</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getlivestockList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"livestock_list":{"type":"array","items":{"type":"object","properties":{"livestock":{"type":"object","properties":{"milk_yield_litres_per_day":{"type":"number"},"production_system":{"type":"string"},"avg_daily_weight_gain_kg":{"type":"number"},"head_count_date":{"type":"string"},"breed":{"type":"string"},"livestock_unit":{"type":"number"},"head_count":{"type":"integer"},"manure_management_system":{"type":"string"},"livestock_id":{"type":"string"},"species":{"type":"string"},"feed_type":{"type":"string"},"parcel_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"livestock_list":[{"livestock":{"livestock_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","livestock_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","species":"cattle_dairy","breed":"Holstein Friesian","head_count":85,"head_count_date":"2026-01-01","livestock_unit":85.0,"production_system":"grazing","manure_management_system":"slurry_tank","feed_type":"pasture","avg_daily_weight_gain_kg":1.1,"milk_yield_litres_per_day":28.5},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Livestock(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new livestock","description":"<p>Create new livestock.</p>\n<p>Records a group of animals of the same species kept by an operator, either grazing on a parcel or housed on a farm. Livestock data is not currently within CRCF scope (enteric fermentation 3.A and manure management 3.B are under Commission review until July 2026) but is included here as a v2 entity to support future certification methodologies and Scope 3 supply chain reporting. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>livestock_id: Unique internal identifier automatically assigned to this livestock herd record.</li>\n<li>parcel_id: The parcel where this herd grazes, if applicable. Null for housed animals (pigs, poultry). When populated, links the herd to parcel geometry so that grazing impacts on soil carbon (compaction, manure deposition) can be spatially attributed.</li>\n<li>species: The animal species. Controlled vocabulary aligned with IPCC 3.A/3.B emission factor categories. Determines which emission factors apply for enteric fermentation and manure management.</li>\n<li>breed: The breed of the animals in this herd. Breed affects feed conversion efficiency and methane emission rates, and may be required by future certification methodologies.</li>\n<li>head_count: The number of individual animals in this herd at the time of recording. Used to calculate total livestock units (LU) for the holding and to scale emission estimates.</li>\n<li>head_count_date: The date on which the head count was recorded. Herd size can change over the year (births, sales, slaughter), so the date is required to interpret the figure correctly.</li>\n<li>livestock_unit: Standardised livestock unit (LU) value for this herd, calculated from head count and species. One LU equals one adult dairy cow (500 kg). Used for cross-species comparisons and regulatory thresholds (e.g., nitrates directive).</li>\n<li>production_system: The management system under which these animals are kept. Affects both emission factors and carbon farming practice eligibility. Controlled vocabulary: grazing (animals outdoors year-round), mixed (indoor/outdoor), housed (indoor year-round), feedlot.</li>\n<li>manure_management_system: How animal manure is collected, stored, and applied. This is the primary factor driving methane and N2O emissions under IPCC category 3.B. Controlled vocabulary: slurry_tank, solid_storage, anaerobic_digester, pasture_range, biogas_with_flaring.</li>\n<li>feed_type: The primary feed source for this herd. Feed composition is the main determinant of enteric fermentation rates (IPCC 3.A). High-quality pasture produces less methane per unit of output than low-quality roughage or concentrate-heavy rations.</li>\n<li>avg_daily_weight_gain_kg: Average daily live weight gain per animal, in kilograms. Recorded for beef cattle only. Used with feed conversion ratios to estimate feed intake (this is for enteric fermentation emissions.)</li>\n<li>milk_yield_litres_per_day: Average daily milk production per cow, in litres. Recorded for dairy cattle only. Higher-yielding cows tend to have lower emission intensity per litre of milk, which is relevant for Scope 3 intensity-based reporting.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"livestock\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createlivestock_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"milk_yield_litres_per_day":{"type":"number"},"production_system":{"type":"string"},"avg_daily_weight_gain_kg":{"type":"number"},"head_count_date":{"type":"string"},"breed":{"type":"string"},"livestock_unit":{"type":"number"},"head_count":{"type":"integer"},"manure_management_system":{"type":"string"},"livestock_id":{"type":"string"},"species":{"type":"string"},"feed_type":{"type":"string"},"parcel_id":{"type":"string"}}},"example":{"livestock_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","species":"cattle_dairy","breed":"Holstein Friesian","head_count":85,"head_count_date":"2026-01-01","livestock_unit":85.0,"production_system":"grazing","manure_management_system":"slurry_tank","feed_type":"pasture","avg_daily_weight_gain_kg":1.1,"milk_yield_litres_per_day":28.5}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"livestock":{"type":"object","properties":{"milk_yield_litres_per_day":{"type":"number"},"production_system":{"type":"string"},"avg_daily_weight_gain_kg":{"type":"number"},"head_count_date":{"type":"string"},"breed":{"type":"string"},"livestock_unit":{"type":"number"},"head_count":{"type":"integer"},"manure_management_system":{"type":"string"},"livestock_id":{"type":"string"},"species":{"type":"string"},"feed_type":{"type":"string"},"parcel_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"livestock":{"livestock_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","livestock_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","species":"cattle_dairy","breed":"Holstein Friesian","head_count":85,"head_count_date":"2026-01-01","livestock_unit":85.0,"production_system":"grazing","manure_management_system":"slurry_tank","feed_type":"pasture","avg_daily_weight_gain_kg":1.1,"milk_yield_litres_per_day":28.5},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/activity-media":{"get":{"tags":["_Activity_media(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get activity_media List","description":"<p>Get activity_media List.</p>\n<p>Parsed entity activity_media. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_media\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>activity_media_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>activity_id</code> → <code>activity</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getactivity_mediaList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_media_list":{"type":"array","items":{"type":"object","properties":{"activity_media":{"type":"object","properties":{"author":{"type":"string"},"activity_media_type":{"type":"string"},"image":{"type":"string"},"activity_media_id":{"type":"string"},"published_date":{"type":"string"},"activity_id":{"type":"string"},"link":{"type":"string"},"title":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"activity_media_list":[{"activity_media":{"activity_media_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","activity_media_id":"string","activity_media_type":"string","title":"string","published_date":"2020-01-01","image":"string","author":"string","link":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Activity_media(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new activity_media","description":"<p>Create new activity_media.</p>\n<p>Parsed entity activity_media. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_media\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createactivity_media_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"author":{"type":"string"},"activity_media_type":{"type":"string"},"image":{"type":"string"},"activity_media_id":{"type":"string"},"published_date":{"type":"string"},"activity_id":{"type":"string"},"link":{"type":"string"},"title":{"type":"string"}}},"example":{"activity_id":"string","activity_media_id":"string","activity_media_type":"string","title":"string","published_date":"2020-01-01","image":"string","author":"string","link":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_media":{"type":"object","properties":{"author":{"type":"string"},"activity_media_type":{"type":"string"},"image":{"type":"string"},"activity_media_id":{"type":"string"},"published_date":{"type":"string"},"activity_id":{"type":"string"},"link":{"type":"string"},"title":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_media":{"activity_media_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","activity_media_id":"string","activity_media_type":"string","title":"string","published_date":"2020-01-01","image":"string","author":"string","link":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/certification-body-authority":{"get":{"tags":["_Certification_body_authority(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get certification_body_authority List","description":"<p>Get certification_body_authority List.</p>\n<p>A many-to-many junction between certification bodies and authorities. It covers what Art. 11(4) requires schemes to publish per body: who accredited or recognised it, and who monitors it. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certification_body_authority_id: Internal identifier for the link.</li>\n<li>certification_body_id: he certification body.</li>\n<li>authority_id: The authority.</li>\n<li>relationship_to_authority: Controlled vocabulary: accredited_by, recognised_by, monitored_by.</li>\n<li>scope: Scope of the accreditation or recognition. Replaces accreditation_scope and recognition_scope.</li>\n<li>start_date: Date the accreditation, recognition or monitoring began. Replaces accreditation_date and recognition_date.</li>\n<li>end_date: Expiry or end date, if any.</li>\n<li>reference: The authority's own certificate or decision number.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_body_authority\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>authority_id</code>, <code>certification_body_authority_id</code>, <code>certification_body_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>authority_id</code> → <code>authority</code>, <code>certification_body_id</code> → <code>certification_body</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getcertification_body_authorityList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_body_authority_list":{"type":"array","items":{"type":"object","properties":{"certification_body_authority":{"type":"object","properties":{"reference":{"type":"string"},"start_date":{"type":"string"},"certification_body_authority_id":{"type":"string"},"scope":{"type":"string"},"relationship_to_authority":{"type":"string"},"end_date":{"type":"string"},"certification_body_id":{"type":"string"},"authority_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"certification_body_authority_list":[{"certification_body_authority":{"certification_body_authority_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certification_body_authority_id":"cba_01HZZ5N8R3P","certification_body_id":"cb_01HZZ1M2A3B4C","authority_id":"auth_01HZZ4K7Q2M","relationship_to_authority":"accredited_by","scope":"Carbon farming, mineral soils","start_date":"2026-05-24","end_date":"2031-05-24","reference":"D-ZE-12345-01-00"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Certification_body_authority(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new certification_body_authority","description":"<p>Create new certification_body_authority.</p>\n<p>A many-to-many junction between certification bodies and authorities. It covers what Art. 11(4) requires schemes to publish per body: who accredited or recognised it, and who monitors it. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>certification_body_authority_id: Internal identifier for the link.</li>\n<li>certification_body_id: he certification body.</li>\n<li>authority_id: The authority.</li>\n<li>relationship_to_authority: Controlled vocabulary: accredited_by, recognised_by, monitored_by.</li>\n<li>scope: Scope of the accreditation or recognition. Replaces accreditation_scope and recognition_scope.</li>\n<li>start_date: Date the accreditation, recognition or monitoring began. Replaces accreditation_date and recognition_date.</li>\n<li>end_date: Expiry or end date, if any.</li>\n<li>reference: The authority's own certificate or decision number.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"certification_body_authority\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createcertification_body_authority_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"reference":{"type":"string"},"start_date":{"type":"string"},"certification_body_authority_id":{"type":"string"},"scope":{"type":"string"},"relationship_to_authority":{"type":"string"},"end_date":{"type":"string"},"certification_body_id":{"type":"string"},"authority_id":{"type":"string"}}},"example":{"certification_body_authority_id":"cba_01HZZ5N8R3P","certification_body_id":"cb_01HZZ1M2A3B4C","authority_id":"auth_01HZZ4K7Q2M","relationship_to_authority":"accredited_by","scope":"Carbon farming, mineral soils","start_date":"2026-05-24","end_date":"2031-05-24","reference":"D-ZE-12345-01-00"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"certification_body_authority":{"type":"object","properties":{"reference":{"type":"string"},"start_date":{"type":"string"},"certification_body_authority_id":{"type":"string"},"scope":{"type":"string"},"relationship_to_authority":{"type":"string"},"end_date":{"type":"string"},"certification_body_id":{"type":"string"},"authority_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"certification_body_authority":{"certification_body_authority_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","certification_body_authority_id":"cba_01HZZ5N8R3P","certification_body_id":"cb_01HZZ1M2A3B4C","authority_id":"auth_01HZZ4K7Q2M","relationship_to_authority":"accredited_by","scope":"Carbon farming, mineral soils","start_date":"2026-05-24","end_date":"2031-05-24","reference":"D-ZE-12345-01-00"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/activity-plan":{"get":{"tags":["_Activity_plan(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get activity_plan List","description":"<p>Get activity_plan List.</p>\n<p>Parsed entity activity_plan. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_plan_id: Internal identifier for the activity plan entity. This is set by the operator platform.</li>\n<li>activity_id: Internal identifier for the activity entity</li>\n<li>date_submitted: Date the activity plan is submitted</li>\n<li>activity_eligibility: Eligibility for certification under Regulation (EU) 2024/3012</li>\n<li>legal_parcel_ownership: Legal ownership</li>\n<li>coordinate_reference_system: Coordinate Reference System (CRS) identifier that defines how to interpret the geometry coordinates (e.g., EPSG:4326 for WGS84).</li>\n<li>iacs_codes: Array of identifiers referencing the parcel in the Member State\u2019s IACS (Integrated Administration and Control System). Only if applicable.</li>\n<li>lpis_codes: Identifiers from the Land Parcel Identification System (LPIS) that reference official \u201creference parcels\u201d/land blocks.  Only if applicable.</li>\n<li>article_8_1_information: Information listed in Article 8(1) of Regulation (EU) 2024/3012</li>\n<li>methodology_quantification_baseline: Quantification, incl. calculation of activity baseline (if applicable)</li>\n<li>methodology_additionality_funding_sources: Additionality, incl. funding sources</li>\n<li>methodology_long_term_storage: Long-term storage</li>\n<li>methodology_sustainability: Sustainability</li>\n<li>expected_total_carbon_removals: Expected total carbon removals associated to the activity (in CO2e Tonnes)</li>\n<li>expected_total_soil_emissions: Expected total total soil emissions associated to the activity (in CO2e Tonnes)</li>\n<li>expected_total_ghg_emissions_associated: Expected total GHG emissions associated to the activity (in CO2e Tonnes)</li>\n<li>expected_net_benefit: Expected net carbon removal benefit or expected net soil emission reduction benefit (in CO2e Tonnes)</li>\n<li>group_advisory_services_description: For group of operators: how advisory services are provided</li>\n<li>group_internal_control_system_description: For group carbon farming: internal control system description</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_plan\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>activity_plan_id</code>, <code>legal_parcel_ownership</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>activity_id</code> → <code>activity</code>, <code>legal_parcel_ownership</code> → <code>parcel_owner_verification</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getactivity_planList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_plan_list":{"type":"array","items":{"type":"object","properties":{"activity_plan":{"type":"object","properties":{"expected_total_carbon_removals":{"type":"integer"},"activity_plan_id":{"type":"string"},"iacs_codes":{"type":"string"},"expected_total_soil_emissions":{"type":"integer"},"methodology_long_term_storage":{"type":"string"},"article_8_1_information":{"type":"string"},"coordinate_reference_system":{"type":"string"},"methodology_sustainability":{"type":"string"},"expected_net_benefit":{"type":"integer"},"activity_id":{"type":"string"},"methodology_quantification_baseline":{"type":"string"},"group_advisory_services_description":{"type":"string"},"lpis_codes":{"type":"string"},"activity_eligibility":{"type":"string"},"methodology_additionality_funding_sources":{"type":"string"},"group_internal_control_system_description":{"type":"string"},"date_submitted":{"type":"string"},"legal_parcel_ownership":{"type":"string"},"expected_total_ghg_emissions_associated":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"activity_plan_list":[{"activity_plan":{"activity_plan_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_plan_id":"ap-1037502-192zf129r3","activity_id":"a_05OFWI037022","date_submitted":"2026-11-20","activity_eligibility":"Eligible: carbon farming activity on mineral agricultural soils, meets Articles 4 to 7 of Regulation (EU) 2024/3012","legal_parcel_ownership":"pov_01HZZ2M4N8Q1R5S7T9V3","coordinate_reference_system":"EPSG:4326","iacs_codes":"DE-BB-IACS-2026-0012345678","lpis_codes":"DE-BB-LPIS-REFPARCEL-0098765432","article_8_1_information":"Delegated act applied: certification methodology adopted under Article 8","methodology_quantification_baseline":"Standardised baseline for mineral soils; total removals calculated per methodology, uncertainties accounted for conservatively","methodology_additionality_funding_sources":"Standardised baseline used, so additionality is deemed met. Funding: own funds and a national agri-environment scheme","methodology_long_term_storage":"Carbon stored in soil organic matter over a 5-year monitoring period; reversal risk covered by a collective buffer","methodology_sustainability":"Do no significant harm assessment passed; co-benefits for biodiversity and soil health","expected_total_carbon_removals":6,"expected_total_soil_emissions":6,"expected_total_ghg_emissions_associated":6,"expected_net_benefit":6,"group_advisory_services_description":"Regional farm advisory service advises small-scale members, 2 visits per year","group_internal_control_system_description":"Group manager audits a 10% sample of members each year and keeps a central register of practices"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Activity_plan(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new activity_plan","description":"<p>Create new activity_plan.</p>\n<p>Parsed entity activity_plan. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>activity_plan_id: Internal identifier for the activity plan entity. This is set by the operator platform.</li>\n<li>activity_id: Internal identifier for the activity entity</li>\n<li>date_submitted: Date the activity plan is submitted</li>\n<li>activity_eligibility: Eligibility for certification under Regulation (EU) 2024/3012</li>\n<li>legal_parcel_ownership: Legal ownership</li>\n<li>coordinate_reference_system: Coordinate Reference System (CRS) identifier that defines how to interpret the geometry coordinates (e.g., EPSG:4326 for WGS84).</li>\n<li>iacs_codes: Array of identifiers referencing the parcel in the Member State\u2019s IACS (Integrated Administration and Control System). Only if applicable.</li>\n<li>lpis_codes: Identifiers from the Land Parcel Identification System (LPIS) that reference official \u201creference parcels\u201d/land blocks.  Only if applicable.</li>\n<li>article_8_1_information: Information listed in Article 8(1) of Regulation (EU) 2024/3012</li>\n<li>methodology_quantification_baseline: Quantification, incl. calculation of activity baseline (if applicable)</li>\n<li>methodology_additionality_funding_sources: Additionality, incl. funding sources</li>\n<li>methodology_long_term_storage: Long-term storage</li>\n<li>methodology_sustainability: Sustainability</li>\n<li>expected_total_carbon_removals: Expected total carbon removals associated to the activity (in CO2e Tonnes)</li>\n<li>expected_total_soil_emissions: Expected total total soil emissions associated to the activity (in CO2e Tonnes)</li>\n<li>expected_total_ghg_emissions_associated: Expected total GHG emissions associated to the activity (in CO2e Tonnes)</li>\n<li>expected_net_benefit: Expected net carbon removal benefit or expected net soil emission reduction benefit (in CO2e Tonnes)</li>\n<li>group_advisory_services_description: For group of operators: how advisory services are provided</li>\n<li>group_internal_control_system_description: For group carbon farming: internal control system description</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_plan\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createactivity_plan_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"expected_total_carbon_removals":{"type":"integer"},"activity_plan_id":{"type":"string"},"iacs_codes":{"type":"string"},"expected_total_soil_emissions":{"type":"integer"},"methodology_long_term_storage":{"type":"string"},"article_8_1_information":{"type":"string"},"coordinate_reference_system":{"type":"string"},"methodology_sustainability":{"type":"string"},"expected_net_benefit":{"type":"integer"},"activity_id":{"type":"string"},"methodology_quantification_baseline":{"type":"string"},"group_advisory_services_description":{"type":"string"},"lpis_codes":{"type":"string"},"activity_eligibility":{"type":"string"},"methodology_additionality_funding_sources":{"type":"string"},"group_internal_control_system_description":{"type":"string"},"date_submitted":{"type":"string"},"legal_parcel_ownership":{"type":"string"},"expected_total_ghg_emissions_associated":{"type":"integer"}}},"example":{"activity_plan_id":"ap-1037502-192zf129r3","activity_id":"a_05OFWI037022","date_submitted":"2026-11-20","activity_eligibility":"Eligible: carbon farming activity on mineral agricultural soils, meets Articles 4 to 7 of Regulation (EU) 2024/3012","legal_parcel_ownership":"pov_01HZZ2M4N8Q1R5S7T9V3","coordinate_reference_system":"EPSG:4326","iacs_codes":"DE-BB-IACS-2026-0012345678","lpis_codes":"DE-BB-LPIS-REFPARCEL-0098765432","article_8_1_information":"Delegated act applied: certification methodology adopted under Article 8","methodology_quantification_baseline":"Standardised baseline for mineral soils; total removals calculated per methodology, uncertainties accounted for conservatively","methodology_additionality_funding_sources":"Standardised baseline used, so additionality is deemed met. Funding: own funds and a national agri-environment scheme","methodology_long_term_storage":"Carbon stored in soil organic matter over a 5-year monitoring period; reversal risk covered by a collective buffer","methodology_sustainability":"Do no significant harm assessment passed; co-benefits for biodiversity and soil health","expected_total_carbon_removals":6,"expected_total_soil_emissions":6,"expected_total_ghg_emissions_associated":6,"expected_net_benefit":6,"group_advisory_services_description":"Regional farm advisory service advises small-scale members, 2 visits per year","group_internal_control_system_description":"Group manager audits a 10% sample of members each year and keeps a central register of practices"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_plan":{"type":"object","properties":{"expected_total_carbon_removals":{"type":"integer"},"activity_plan_id":{"type":"string"},"iacs_codes":{"type":"string"},"expected_total_soil_emissions":{"type":"integer"},"methodology_long_term_storage":{"type":"string"},"article_8_1_information":{"type":"string"},"coordinate_reference_system":{"type":"string"},"methodology_sustainability":{"type":"string"},"expected_net_benefit":{"type":"integer"},"activity_id":{"type":"string"},"methodology_quantification_baseline":{"type":"string"},"group_advisory_services_description":{"type":"string"},"lpis_codes":{"type":"string"},"activity_eligibility":{"type":"string"},"methodology_additionality_funding_sources":{"type":"string"},"group_internal_control_system_description":{"type":"string"},"date_submitted":{"type":"string"},"legal_parcel_ownership":{"type":"string"},"expected_total_ghg_emissions_associated":{"type":"integer"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_plan":{"activity_plan_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_plan_id":"ap-1037502-192zf129r3","activity_id":"a_05OFWI037022","date_submitted":"2026-11-20","activity_eligibility":"Eligible: carbon farming activity on mineral agricultural soils, meets Articles 4 to 7 of Regulation (EU) 2024/3012","legal_parcel_ownership":"pov_01HZZ2M4N8Q1R5S7T9V3","coordinate_reference_system":"EPSG:4326","iacs_codes":"DE-BB-IACS-2026-0012345678","lpis_codes":"DE-BB-LPIS-REFPARCEL-0098765432","article_8_1_information":"Delegated act applied: certification methodology adopted under Article 8","methodology_quantification_baseline":"Standardised baseline for mineral soils; total removals calculated per methodology, uncertainties accounted for conservatively","methodology_additionality_funding_sources":"Standardised baseline used, so additionality is deemed met. Funding: own funds and a national agri-environment scheme","methodology_long_term_storage":"Carbon stored in soil organic matter over a 5-year monitoring period; reversal risk covered by a collective buffer","methodology_sustainability":"Do no significant harm assessment passed; co-benefits for biodiversity and soil health","expected_total_carbon_removals":6,"expected_total_soil_emissions":6,"expected_total_ghg_emissions_associated":6,"expected_net_benefit":6,"group_advisory_services_description":"Regional farm advisory service advises small-scale members, 2 visits per year","group_internal_control_system_description":"Group manager audits a 10% sample of members each year and keeps a central register of practices"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/co-benefit":{"get":{"tags":["_Co_benefit(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get co_benefit List","description":"<p>Get co_benefit List.</p>\n<p>Parsed entity co_benefit. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"co_benefit\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>co_benefit_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getco_benefitList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"co_benefit_list":{"type":"array","items":{"type":"object","properties":{"co_benefit":{"type":"object","properties":{"co_benefit_id":{"type":"string"},"co_benefit_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"co_benefit_list":[{"co_benefit":{"co_benefit_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","co_benefit_id":"string","co_benefit_name":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Co_benefit(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new co_benefit","description":"<p>Create new co_benefit.</p>\n<p>Parsed entity co_benefit. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"co_benefit\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createco_benefit_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"co_benefit_id":{"type":"string"},"co_benefit_name":{"type":"string"}}},"example":{"co_benefit_id":"string","co_benefit_name":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"co_benefit":{"type":"object","properties":{"co_benefit_id":{"type":"string"},"co_benefit_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"co_benefit":{"co_benefit_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","co_benefit_id":"string","co_benefit_name":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/co-benefit":{"get":{"tags":["_Co_benefit(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public co_benefit List","description":"<p>Get Public co_benefit List.</p>\n<p>Parsed entity co_benefit. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"co_benefit\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>co_benefit_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPublicco_benefitList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"co_benefit_list":{"type":"array","items":{"type":"object","properties":{"co_benefit":{"type":"object","properties":{"co_benefit_id":{"type":"string"},"co_benefit_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"co_benefit_list":[{"co_benefit":{"co_benefit_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","co_benefit_id":"string","co_benefit_name":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/public/technologies-practices-processes":{"get":{"tags":["_Technologies_practices_processes(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public technologies_practices_processes List","description":"<p>Get Public technologies_practices_processes List.</p>\n<p>This is the lookup table for technologies, practices and processes. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"technologies_practices_processes\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>technologies_practices_processes_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPublictechnologies_practices_processesList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"technologies_practices_processes_list":{"type":"array","items":{"type":"object","properties":{"technologies_practices_processes":{"type":"object","properties":{"technologies_practices_processes_id":{"type":"string"},"practice_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"technologies_practices_processes_list":[{"technologies_practices_processes":{"technologies_practices_processes_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","technologies_practices_processes_id":"string","practice_name":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/country":{"get":{"tags":["_Country(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get country List","description":"<p>Get country List.</p>\n<p>Parsed entity country. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>country_id: ISO 3166-1 alpha-2 country code for where the activity occurs.</li>\n<li>country_name: Name of the country</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"country\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>country_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getcountryList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"country_list":{"type":"array","items":{"type":"object","properties":{"country":{"type":"object","properties":{"country_id":{"type":"string"},"country_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"country_list":[{"country":{"country_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","country_id":"DE","country_name":"Germany"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Country(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new country","description":"<p>Create new country.</p>\n<p>Parsed entity country. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>country_id: ISO 3166-1 alpha-2 country code for where the activity occurs.</li>\n<li>country_name: Name of the country</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"country\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createcountry_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"country_id":{"type":"string"},"country_name":{"type":"string"}}},"example":{"country_id":"DE","country_name":"Germany"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"country":{"type":"object","properties":{"country_id":{"type":"string"},"country_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"country":{"country_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","country_id":"DE","country_name":"Germany"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/carbon-credit-batch":{"get":{"tags":["_Carbon_credit_batch(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public carbon_credit_batch List","description":"<p>Get Public carbon_credit_batch List.</p>\n<p>One batch of certified carbon credit units issued for an activity over one monitoring period after certification or re-certification. Represented by a Batch NFT. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>carbon_credit_batch_id: Internal identifier for the batch</li>\n<li>activity_id: Activity that generated the units</li>\n<li>certificate_of_compliance_id: Certificate (or updated certificate after re-certification) the units were issued from</li>\n<li>unit_type: Permanent Removal, Carbon Farming Sequestration, Soil Emission Reduction or Carbon Storage in Product</li>\n<li>status_code: Unit status: issued, retired, expired, cancelled</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"carbon_credit_batch\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>carbon_credit_batch_id</code>, <code>certificate_of_compliance_id</code>, <code>status_code</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p>One-hop join queries (<code>obp_exists</code> / <code>obp_not_exists</code>) are not available on this endpoint.</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getPubliccarbon_credit_batchList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"carbon_credit_batch_list":{"type":"array","items":{"type":"object","properties":{"carbon_credit_batch":{"type":"object","properties":{"unit_type":{"type":"string"},"status_code":{"type":"string"},"activity_id":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"carbon_credit_batch_id":{"type":"string"},"expiry_date":{"type":"string"},"monitoring_period_end_date":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}}}}},"example":{"carbon_credit_batch_list":[{"carbon_credit_batch":{"carbon_credit_batch_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","carbon_credit_batch_id":"string","activity_id":"string","certificate_of_compliance_id":"string","unit_type":"Soil Emission Reduction","monitoring_period_start_date":"2020-01-01","monitoring_period_end_date":"2020-01-01","amount":1.0,"status_code":"string","issue_date":"2020-01-01","expiry_date":"2020-01-01"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}]}}}},"500":{"description":"Internal Server Error"}}}},"/activity-non-conformity/{activitynonconformityid}":{"get":{"tags":["_Activity_non_conformity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get activity_non_conformity by id","description":"<p>Get activity_non_conformity by id.</p>\n<p>\u2018non-conformity\u2019 means a failure by an operator or a certification body to comply with the rules and procedures, established by the certification scheme, of which they are members or under which they operate. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>category: critical, major and minor</li>\n<li>remediation_timeline: Timeline for remediation of non-conformities</li>\n<li>sanction: Sanction imposed for the non-conformity, e.g. warning, suspension or withdrawal of certification</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_non_conformity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingleactivity_non_conformity_ogcr","parameters":[{"name":"activitynonconformityid","in":"path","description":"The ACTIVITYNONCONFORMITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_non_conformity":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"non_conformity_id":{"type":"string"},"sanction":{"type":"string"},"audit_report_id":{"type":"string"},"remediation_timeline":{"type":"string"},"activity_non_conformity_id":{"type":"string"},"certification_body_id":{"type":"string"},"category":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_non_conformity":{"activity_non_conformity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","non_conformity_id":"string","audit_report_id":"string","category":"string","remediation_timeline":"string","sanction":"warning","certification_scheme_id":"string","certification_body_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Activity_non_conformity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update activity_non_conformity","description":"<p>Update activity_non_conformity.</p>\n<p>\u2018non-conformity\u2019 means a failure by an operator or a certification body to comply with the rules and procedures, established by the certification scheme, of which they are members or under which they operate. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>category: critical, major and minor</li>\n<li>remediation_timeline: Timeline for remediation of non-conformities</li>\n<li>sanction: Sanction imposed for the non-conformity, e.g. warning, suspension or withdrawal of certification</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_non_conformity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updateactivity_non_conformity_ogcr","parameters":[{"name":"activitynonconformityid","in":"path","description":"The ACTIVITYNONCONFORMITYID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"non_conformity_id":{"type":"string"},"sanction":{"type":"string"},"audit_report_id":{"type":"string"},"remediation_timeline":{"type":"string"},"certification_body_id":{"type":"string"},"category":{"type":"string"}}},"example":{"non_conformity_id":"string","audit_report_id":"string","category":"string","remediation_timeline":"string","sanction":"warning","certification_scheme_id":"string","certification_body_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_non_conformity":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"non_conformity_id":{"type":"string"},"sanction":{"type":"string"},"audit_report_id":{"type":"string"},"remediation_timeline":{"type":"string"},"activity_non_conformity_id":{"type":"string"},"certification_body_id":{"type":"string"},"category":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_non_conformity":{"activity_non_conformity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","non_conformity_id":"string","audit_report_id":"string","category":"string","remediation_timeline":"string","sanction":"warning","certification_scheme_id":"string","certification_body_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Activity_non_conformity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete activity_non_conformity by id","description":"<p>Delete activity_non_conformity by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_non_conformity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deleteactivity_non_conformity_ogcr","parameters":[{"name":"activitynonconformityid","in":"path","description":"The ACTIVITYNONCONFORMITYID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_non_conformity":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"non_conformity_id":{"type":"string"},"sanction":{"type":"string"},"audit_report_id":{"type":"string"},"remediation_timeline":{"type":"string"},"activity_non_conformity_id":{"type":"string"},"certification_body_id":{"type":"string"},"category":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_non_conformity":{"activity_non_conformity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","non_conformity_id":"string","audit_report_id":"string","category":"string","remediation_timeline":"string","sanction":"warning","certification_scheme_id":"string","certification_body_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Activity_non_conformity(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update activity_non_conformity","description":"<p>Partially update activity_non_conformity: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>\u2018non-conformity\u2019 means a failure by an operator or a certification body to comply with the rules and procedures, established by the certification scheme, of which they are members or under which they operate. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>category: critical, major and minor</li>\n<li>remediation_timeline: Timeline for remediation of non-conformities</li>\n<li>sanction: Sanction imposed for the non-conformity, e.g. warning, suspension or withdrawal of certification</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_non_conformity\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchactivity_non_conformity_ogcr","parameters":[{"name":"activitynonconformityid","in":"path","description":"The ACTIVITYNONCONFORMITYID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"non_conformity_id":{"type":"string"},"sanction":{"type":"string"},"audit_report_id":{"type":"string"},"remediation_timeline":{"type":"string"},"certification_body_id":{"type":"string"},"category":{"type":"string"}}},"example":{"non_conformity_id":"string","audit_report_id":"string","category":"string","remediation_timeline":"string","sanction":"warning","certification_scheme_id":"string","certification_body_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_non_conformity":{"type":"object","properties":{"certification_scheme_id":{"type":"string"},"non_conformity_id":{"type":"string"},"sanction":{"type":"string"},"audit_report_id":{"type":"string"},"remediation_timeline":{"type":"string"},"activity_non_conformity_id":{"type":"string"},"certification_body_id":{"type":"string"},"category":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_non_conformity":{"activity_non_conformity_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","non_conformity_id":"string","audit_report_id":"string","category":"string","remediation_timeline":"string","sanction":"warning","certification_scheme_id":"string","certification_body_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/public/co-benefits/{cobenefitsid}":{"get":{"tags":["_Co_benefits(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get Public co_benefits by id","description":"<p>Get Public co_benefits by id.</p>\n<p>Parsed entity co_benefits. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"co_benefits\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>Authentication is Optional</p>\n<p>User Authentication is Optional. The User need not be logged in.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSinglePublicco_benefits_ogcr","parameters":[{"name":"cobenefitsid","in":"path","description":"The COBENEFITSID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"co_benefits":{"type":"object","properties":{"co_benefits_id":{"type":"string"},"co_benefit_id":{"type":"string"},"co_benefit_name":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"}}}}}}},"example":{"co_benefits":{"co_benefits_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","co_benefit_id":"string","co_benefit_name":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z"},"updated":{"at":"2026-09-30T11:40:00Z"}}}}}},"500":{"description":"Internal Server Error"}}}},"/carbon-credit-batch":{"get":{"tags":["_Carbon_credit_batch(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get carbon_credit_batch List","description":"<p>Get carbon_credit_batch List.</p>\n<p>One batch of certified carbon credit units issued for an activity over one monitoring period after certification or re-certification. Represented by a Batch NFT. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>carbon_credit_batch_id: Internal identifier for the batch</li>\n<li>activity_id: Activity that generated the units</li>\n<li>certificate_of_compliance_id: Certificate (or updated certificate after re-certification) the units were issued from</li>\n<li>unit_type: Permanent Removal, Carbon Farming Sequestration, Soil Emission Reduction or Carbon Storage in Product</li>\n<li>status_code: Unit status: issued, retired, expired, cancelled</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"carbon_credit_batch\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>carbon_credit_batch_id</code>, <code>certificate_of_compliance_id</code>, <code>status_code</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>activity_id</code> → <code>activity</code>, <code>certificate_of_compliance_id</code> → <code>certificate_of_compliance</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getcarbon_credit_batchList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"carbon_credit_batch_list":{"type":"array","items":{"type":"object","properties":{"carbon_credit_batch":{"type":"object","properties":{"unit_type":{"type":"string"},"status_code":{"type":"string"},"activity_id":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"carbon_credit_batch_id":{"type":"string"},"expiry_date":{"type":"string"},"monitoring_period_end_date":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"carbon_credit_batch_list":[{"carbon_credit_batch":{"carbon_credit_batch_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","carbon_credit_batch_id":"string","activity_id":"string","certificate_of_compliance_id":"string","unit_type":"Soil Emission Reduction","monitoring_period_start_date":"2020-01-01","monitoring_period_end_date":"2020-01-01","amount":1.0,"status_code":"string","issue_date":"2020-01-01","expiry_date":"2020-01-01"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Carbon_credit_batch(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new carbon_credit_batch","description":"<p>Create new carbon_credit_batch.</p>\n<p>One batch of certified carbon credit units issued for an activity over one monitoring period after certification or re-certification. Represented by a Batch NFT. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>carbon_credit_batch_id: Internal identifier for the batch</li>\n<li>activity_id: Activity that generated the units</li>\n<li>certificate_of_compliance_id: Certificate (or updated certificate after re-certification) the units were issued from</li>\n<li>unit_type: Permanent Removal, Carbon Farming Sequestration, Soil Emission Reduction or Carbon Storage in Product</li>\n<li>status_code: Unit status: issued, retired, expired, cancelled</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"carbon_credit_batch\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createcarbon_credit_batch_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"unit_type":{"type":"string"},"status_code":{"type":"string"},"activity_id":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"carbon_credit_batch_id":{"type":"string"},"expiry_date":{"type":"string"},"monitoring_period_end_date":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"}}},"example":{"carbon_credit_batch_id":"string","activity_id":"string","certificate_of_compliance_id":"string","unit_type":"Soil Emission Reduction","monitoring_period_start_date":"2020-01-01","monitoring_period_end_date":"2020-01-01","amount":1.0,"status_code":"string","issue_date":"2020-01-01","expiry_date":"2020-01-01"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"carbon_credit_batch":{"type":"object","properties":{"unit_type":{"type":"string"},"status_code":{"type":"string"},"activity_id":{"type":"string"},"monitoring_period_start_date":{"type":"string"},"carbon_credit_batch_id":{"type":"string"},"expiry_date":{"type":"string"},"monitoring_period_end_date":{"type":"string"},"certificate_of_compliance_id":{"type":"string"},"amount":{"type":"number"},"issue_date":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"carbon_credit_batch":{"carbon_credit_batch_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","carbon_credit_batch_id":"string","activity_id":"string","certificate_of_compliance_id":"string","unit_type":"Soil Emission Reduction","monitoring_period_start_date":"2020-01-01","monitoring_period_end_date":"2020-01-01","amount":1.0,"status_code":"string","issue_date":"2020-01-01","expiry_date":"2020-01-01"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/digital-mrv-observation/{digitalmrvobservationid}":{"get":{"tags":["_Digital_mrv_observation(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get digital_mrv_observation by id","description":"<p>Get digital_mrv_observation by id.</p>\n<p>A single digital MRV (Monitoring, Reporting and Verification) output record for a parcel, covering a defined monitoring period. dMRV uses satellite imagery, geospatial data, and modelling (from WP3) to quantify soil organic carbon (SOC) and biomass changes continuously and at scale, without requiring a formal CRCF audit for each period. These records feed into Batch NFT issuance at the CRCF registry layer and into Scope 3 marketplace pricing and filtering. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>digital_mrv_observation_id: Unique internal identifier automatically assigned to this dMRV observation record.</li>\n<li>parcel_id: The parcel this observation covers. Links the dMRV result to the parcel geometry, ownership record, and any associated CRCF activity.</li>\n<li>growing_season_id: Optional link to the specific crop season this observation is associated with. Useful when dMRV data is available at crop-season resolution, allowing the carbon signal to be attributed to a particular practice change (e.g., cover cropping in winter 2026).</li>\n<li>observation_date_start: Start date of the monitoring window covered by this dMRV observation. Defines the period over which carbon stock changes are measured. Must align with the activity or reporting period for CRCF or Scope 3 use.</li>\n<li>observation_date_end: End date of the monitoring window. Together with observation_date_start, this defines the observation period. Corporate buyers need this to confirm the period overlaps their reporting year.</li>\n<li>digital_mrv_protocol: The name and version of the dMRV methodology used to produce this estimate. Generated by WP3. Required for audit trails, marketplace filtering, and CSRD methodology disclosure.</li>\n<li>data_source: The primary remote sensing or modelling data source used to generate this observation. Controlled vocabulary: sentinel2, planetscope, modelled (no imagery), combined (imagery + model ensemble).</li>\n<li>lulc_classification: The Land Use / Land Cover (LULC) class assigned to this parcel during the observation period, using the LUCAS classification standard. Used to confirm the parcel is in active agricultural use and to flag land use change events that would affect carbon accounting.</li>\n<li>soc_estimate_t_per_ha: The soil organic carbon (SOC) stock on this parcel under the counterfactual baseline scenario (what would have happened without the activity), expressed in tonnes of carbon per hectare. Derived from the GCDC standardised baseline for the parcel's pedoclimatic zone.</li>\n<li>soc_baseline_t_per_ha: The measured or modelled soil organic carbon stock on this parcel at the end of the observation period, in tonnes of carbon per hectare. Compared against soc_baseline_t_ha to determine the net carbon removal signal.</li>\n<li>soc_delta_t_per_ha: The change in soil organic carbon stock between the baseline and the end of the observation period, in tonnes of carbon per hectare. A positive value indicates carbon sequestration. This is the primary carbon removal signal used for the Parcel Snapshot.</li>\n<li>biomass_estimate_t_per_ha: Above-ground biomass carbon stock estimated for this parcel at the end of the observation period, in tonnes of carbon per hectare. Relevant for agroforestry or perennial cropping activities where above-ground woody biomass contributes to the carbon removal claim.</li>\n<li>uncertainty_pct: The percentage uncertainty band around the SOC or biomass estimate, reflecting model error, spatial heterogeneity, and data quality. Required by CRCF methodology rules and used by the Scope 3 marketplace to apply conservative discounting to credit quantities and pricing.</li>\n<li>data_quality_indicator: A tiered quality rating for this dMRV observation, reflecting cloud cover, image resolution, model confidence, and validation against ground-truth samples. Controlled vocabulary: high, medium, low. Used by certifiers and marketplace buyers to assess reliability.</li>\n<li>risk_score: A score between 0 and 1 representing the probability of carbon reversal on this parcel over the monitoring period, produced by the WP4 risk assessment model. A higher score means higher reversal risk. Used by the registry to apply buffer pool deductions and by the marketplace to adjust pricing.</li>\n<li>verification_method: Indicates whether this observation was verified through automated dMRV only, a traditional CRCF third-party audit, or a combination of both. Determines the applicable  pathway.</li>\n<li>generated_by: The name and version of the WP3 processing pipeline or algorithm that produced this observation. Needed for reproducibility, audit trails, and methodology version tracking.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"digital_mrv_observation\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getSingledigital_mrv_observation_ogcr","parameters":[{"name":"digitalmrvobservationid","in":"path","description":"The DIGITALMRVOBSERVATIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"digital_mrv_observation":{"type":"object","properties":{"growing_season_id":{"type":"string"},"observation_date_start":{"type":"string"},"lulc_classification":{"type":"string"},"verification_method":{"type":"string"},"risk_score":{"type":"number"},"data_quality_indicator":{"type":"string"},"uncertainty_pct":{"type":"number"},"soc_baseline_t_per_ha":{"type":"number"},"biomass_estimate_t_per_ha":{"type":"number"},"digital_mrv_protocol":{"type":"string"},"generated_by":{"type":"string"},"observation_date_end":{"type":"string"},"parcel_id":{"type":"string"},"soc_estimate_t_per_ha":{"type":"number"},"data_source":{"type":"string"},"digital_mrv_observation_id":{"type":"string"},"soc_delta_t_per_ha":{"type":"number"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"digital_mrv_observation":{"digital_mrv_observation_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","digital_mrv_observation_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","growing_season_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","observation_date_start":"2026-01-01","observation_date_end":"2026-12-31","digital_mrv_protocol":"WP3-SOC-Sentinel2-v1.2","data_source":"sentinel2","lulc_classification":"cropland_annual","soc_estimate_t_per_ha":42.3,"soc_baseline_t_per_ha":44.1,"soc_delta_t_per_ha":1.8,"biomass_estimate_t_per_ha":3.2,"uncertainty_pct":12.5,"data_quality_indicator":"medium","risk_score":0.08,"verification_method":"dMRV","generated_by":"WP3-pipeline-v2.0.1"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"put":{"tags":["_Digital_mrv_observation(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Update digital_mrv_observation","description":"<p>Update digital_mrv_observation.</p>\n<p>A single digital MRV (Monitoring, Reporting and Verification) output record for a parcel, covering a defined monitoring period. dMRV uses satellite imagery, geospatial data, and modelling (from WP3) to quantify soil organic carbon (SOC) and biomass changes continuously and at scale, without requiring a formal CRCF audit for each period. These records feed into Batch NFT issuance at the CRCF registry layer and into Scope 3 marketplace pricing and filtering. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>digital_mrv_observation_id: Unique internal identifier automatically assigned to this dMRV observation record.</li>\n<li>parcel_id: The parcel this observation covers. Links the dMRV result to the parcel geometry, ownership record, and any associated CRCF activity.</li>\n<li>growing_season_id: Optional link to the specific crop season this observation is associated with. Useful when dMRV data is available at crop-season resolution, allowing the carbon signal to be attributed to a particular practice change (e.g., cover cropping in winter 2026).</li>\n<li>observation_date_start: Start date of the monitoring window covered by this dMRV observation. Defines the period over which carbon stock changes are measured. Must align with the activity or reporting period for CRCF or Scope 3 use.</li>\n<li>observation_date_end: End date of the monitoring window. Together with observation_date_start, this defines the observation period. Corporate buyers need this to confirm the period overlaps their reporting year.</li>\n<li>digital_mrv_protocol: The name and version of the dMRV methodology used to produce this estimate. Generated by WP3. Required for audit trails, marketplace filtering, and CSRD methodology disclosure.</li>\n<li>data_source: The primary remote sensing or modelling data source used to generate this observation. Controlled vocabulary: sentinel2, planetscope, modelled (no imagery), combined (imagery + model ensemble).</li>\n<li>lulc_classification: The Land Use / Land Cover (LULC) class assigned to this parcel during the observation period, using the LUCAS classification standard. Used to confirm the parcel is in active agricultural use and to flag land use change events that would affect carbon accounting.</li>\n<li>soc_estimate_t_per_ha: The soil organic carbon (SOC) stock on this parcel under the counterfactual baseline scenario (what would have happened without the activity), expressed in tonnes of carbon per hectare. Derived from the GCDC standardised baseline for the parcel's pedoclimatic zone.</li>\n<li>soc_baseline_t_per_ha: The measured or modelled soil organic carbon stock on this parcel at the end of the observation period, in tonnes of carbon per hectare. Compared against soc_baseline_t_ha to determine the net carbon removal signal.</li>\n<li>soc_delta_t_per_ha: The change in soil organic carbon stock between the baseline and the end of the observation period, in tonnes of carbon per hectare. A positive value indicates carbon sequestration. This is the primary carbon removal signal used for the Parcel Snapshot.</li>\n<li>biomass_estimate_t_per_ha: Above-ground biomass carbon stock estimated for this parcel at the end of the observation period, in tonnes of carbon per hectare. Relevant for agroforestry or perennial cropping activities where above-ground woody biomass contributes to the carbon removal claim.</li>\n<li>uncertainty_pct: The percentage uncertainty band around the SOC or biomass estimate, reflecting model error, spatial heterogeneity, and data quality. Required by CRCF methodology rules and used by the Scope 3 marketplace to apply conservative discounting to credit quantities and pricing.</li>\n<li>data_quality_indicator: A tiered quality rating for this dMRV observation, reflecting cloud cover, image resolution, model confidence, and validation against ground-truth samples. Controlled vocabulary: high, medium, low. Used by certifiers and marketplace buyers to assess reliability.</li>\n<li>risk_score: A score between 0 and 1 representing the probability of carbon reversal on this parcel over the monitoring period, produced by the WP4 risk assessment model. A higher score means higher reversal risk. Used by the registry to apply buffer pool deductions and by the marketplace to adjust pricing.</li>\n<li>verification_method: Indicates whether this observation was verified through automated dMRV only, a traditional CRCF third-party audit, or a combination of both. Determines the applicable  pathway.</li>\n<li>generated_by: The name and version of the WP3 processing pipeline or algorithm that produced this observation. Needed for reproducibility, audit trails, and methodology version tracking.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"digital_mrv_observation\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_updatedigital_mrv_observation_ogcr","parameters":[{"name":"digitalmrvobservationid","in":"path","description":"The DIGITALMRVOBSERVATIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"growing_season_id":{"type":"string"},"observation_date_start":{"type":"string"},"lulc_classification":{"type":"string"},"verification_method":{"type":"string"},"risk_score":{"type":"number"},"data_quality_indicator":{"type":"string"},"uncertainty_pct":{"type":"number"},"soc_baseline_t_per_ha":{"type":"number"},"biomass_estimate_t_per_ha":{"type":"number"},"digital_mrv_protocol":{"type":"string"},"generated_by":{"type":"string"},"observation_date_end":{"type":"string"},"parcel_id":{"type":"string"},"soc_estimate_t_per_ha":{"type":"number"},"data_source":{"type":"string"},"digital_mrv_observation_id":{"type":"string"},"soc_delta_t_per_ha":{"type":"number"}}},"example":{"digital_mrv_observation_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","growing_season_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","observation_date_start":"2026-01-01","observation_date_end":"2026-12-31","digital_mrv_protocol":"WP3-SOC-Sentinel2-v1.2","data_source":"sentinel2","lulc_classification":"cropland_annual","soc_estimate_t_per_ha":42.3,"soc_baseline_t_per_ha":44.1,"soc_delta_t_per_ha":1.8,"biomass_estimate_t_per_ha":3.2,"uncertainty_pct":12.5,"data_quality_indicator":"medium","risk_score":0.08,"verification_method":"dMRV","generated_by":"WP3-pipeline-v2.0.1"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"digital_mrv_observation":{"type":"object","properties":{"growing_season_id":{"type":"string"},"observation_date_start":{"type":"string"},"lulc_classification":{"type":"string"},"verification_method":{"type":"string"},"risk_score":{"type":"number"},"data_quality_indicator":{"type":"string"},"uncertainty_pct":{"type":"number"},"soc_baseline_t_per_ha":{"type":"number"},"biomass_estimate_t_per_ha":{"type":"number"},"digital_mrv_protocol":{"type":"string"},"generated_by":{"type":"string"},"observation_date_end":{"type":"string"},"parcel_id":{"type":"string"},"soc_estimate_t_per_ha":{"type":"number"},"data_source":{"type":"string"},"digital_mrv_observation_id":{"type":"string"},"soc_delta_t_per_ha":{"type":"number"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"digital_mrv_observation":{"digital_mrv_observation_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","digital_mrv_observation_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","growing_season_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","observation_date_start":"2026-01-01","observation_date_end":"2026-12-31","digital_mrv_protocol":"WP3-SOC-Sentinel2-v1.2","data_source":"sentinel2","lulc_classification":"cropland_annual","soc_estimate_t_per_ha":42.3,"soc_baseline_t_per_ha":44.1,"soc_delta_t_per_ha":1.8,"biomass_estimate_t_per_ha":3.2,"uncertainty_pct":12.5,"data_quality_indicator":"medium","risk_score":0.08,"verification_method":"dMRV","generated_by":"WP3-pipeline-v2.0.1"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"delete":{"tags":["_Digital_mrv_observation(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Delete digital_mrv_observation by id","description":"<p>Delete digital_mrv_observation by id</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"digital_mrv_observation\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_deletedigital_mrv_observation_ogcr","parameters":[{"name":"digitalmrvobservationid","in":"path","description":"The DIGITALMRVOBSERVATIONID identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"digital_mrv_observation":{"type":"object","properties":{"growing_season_id":{"type":"string"},"observation_date_start":{"type":"string"},"lulc_classification":{"type":"string"},"verification_method":{"type":"string"},"risk_score":{"type":"number"},"data_quality_indicator":{"type":"string"},"uncertainty_pct":{"type":"number"},"soc_baseline_t_per_ha":{"type":"number"},"biomass_estimate_t_per_ha":{"type":"number"},"digital_mrv_protocol":{"type":"string"},"generated_by":{"type":"string"},"observation_date_end":{"type":"string"},"parcel_id":{"type":"string"},"soc_estimate_t_per_ha":{"type":"number"},"data_source":{"type":"string"},"digital_mrv_observation_id":{"type":"string"},"soc_delta_t_per_ha":{"type":"number"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"digital_mrv_observation":{"digital_mrv_observation_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","digital_mrv_observation_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","growing_season_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","observation_date_start":"2026-01-01","observation_date_end":"2026-12-31","digital_mrv_protocol":"WP3-SOC-Sentinel2-v1.2","data_source":"sentinel2","lulc_classification":"cropland_annual","soc_estimate_t_per_ha":42.3,"soc_baseline_t_per_ha":44.1,"soc_delta_t_per_ha":1.8,"biomass_estimate_t_per_ha":3.2,"uncertainty_pct":12.5,"data_quality_indicator":"medium","risk_score":0.08,"verification_method":"dMRV","generated_by":"WP3-pipeline-v2.0.1"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"patch":{"tags":["_Digital_mrv_observation(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Partially update digital_mrv_observation","description":"<p>Partially update digital_mrv_observation: only the fields supplied in the body are changed; others are preserved.</p>\n<p>This is also the write path for <strong>field-level write-restricted</strong> fields (those declared with<br />\n<code>write_role_required</code> or an explicit <code>write_role</code>). Authorisation is <strong>per field present in the body</strong>:<br />\na write-restricted field requires that field's write role, and an unrestricted field requires the entity<br />\nupdate role. You may change a field if (and only if) you hold the role that governs it; the request is<br />\nrejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update<br />\nprecondition \u2014 holding only a field's write role is sufficient to PATCH that field alone.</p>\n<p>A single digital MRV (Monitoring, Reporting and Verification) output record for a parcel, covering a defined monitoring period. dMRV uses satellite imagery, geospatial data, and modelling (from WP3) to quantify soil organic carbon (SOC) and biomass changes continuously and at scale, without requiring a formal CRCF audit for each period. These records feed into Batch NFT issuance at the CRCF registry layer and into Scope 3 marketplace pricing and filtering. This Dynamic Entity is part of OGCR.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>digital_mrv_observation_id: Unique internal identifier automatically assigned to this dMRV observation record.</li>\n<li>parcel_id: The parcel this observation covers. Links the dMRV result to the parcel geometry, ownership record, and any associated CRCF activity.</li>\n<li>growing_season_id: Optional link to the specific crop season this observation is associated with. Useful when dMRV data is available at crop-season resolution, allowing the carbon signal to be attributed to a particular practice change (e.g., cover cropping in winter 2026).</li>\n<li>observation_date_start: Start date of the monitoring window covered by this dMRV observation. Defines the period over which carbon stock changes are measured. Must align with the activity or reporting period for CRCF or Scope 3 use.</li>\n<li>observation_date_end: End date of the monitoring window. Together with observation_date_start, this defines the observation period. Corporate buyers need this to confirm the period overlaps their reporting year.</li>\n<li>digital_mrv_protocol: The name and version of the dMRV methodology used to produce this estimate. Generated by WP3. Required for audit trails, marketplace filtering, and CSRD methodology disclosure.</li>\n<li>data_source: The primary remote sensing or modelling data source used to generate this observation. Controlled vocabulary: sentinel2, planetscope, modelled (no imagery), combined (imagery + model ensemble).</li>\n<li>lulc_classification: The Land Use / Land Cover (LULC) class assigned to this parcel during the observation period, using the LUCAS classification standard. Used to confirm the parcel is in active agricultural use and to flag land use change events that would affect carbon accounting.</li>\n<li>soc_estimate_t_per_ha: The soil organic carbon (SOC) stock on this parcel under the counterfactual baseline scenario (what would have happened without the activity), expressed in tonnes of carbon per hectare. Derived from the GCDC standardised baseline for the parcel's pedoclimatic zone.</li>\n<li>soc_baseline_t_per_ha: The measured or modelled soil organic carbon stock on this parcel at the end of the observation period, in tonnes of carbon per hectare. Compared against soc_baseline_t_ha to determine the net carbon removal signal.</li>\n<li>soc_delta_t_per_ha: The change in soil organic carbon stock between the baseline and the end of the observation period, in tonnes of carbon per hectare. A positive value indicates carbon sequestration. This is the primary carbon removal signal used for the Parcel Snapshot.</li>\n<li>biomass_estimate_t_per_ha: Above-ground biomass carbon stock estimated for this parcel at the end of the observation period, in tonnes of carbon per hectare. Relevant for agroforestry or perennial cropping activities where above-ground woody biomass contributes to the carbon removal claim.</li>\n<li>uncertainty_pct: The percentage uncertainty band around the SOC or biomass estimate, reflecting model error, spatial heterogeneity, and data quality. Required by CRCF methodology rules and used by the Scope 3 marketplace to apply conservative discounting to credit quantities and pricing.</li>\n<li>data_quality_indicator: A tiered quality rating for this dMRV observation, reflecting cloud cover, image resolution, model confidence, and validation against ground-truth samples. Controlled vocabulary: high, medium, low. Used by certifiers and marketplace buyers to assess reliability.</li>\n<li>risk_score: A score between 0 and 1 representing the probability of carbon reversal on this parcel over the monitoring period, produced by the WP4 risk assessment model. A higher score means higher reversal risk. Used by the registry to apply buffer pool deductions and by the marketplace to adjust pricing.</li>\n<li>verification_method: Indicates whether this observation was verified through automated dMRV only, a traditional CRCF third-party audit, or a combination of both. Determines the applicable  pathway.</li>\n<li>generated_by: The name and version of the WP3 processing pipeline or algorithm that produced this observation. Needed for reproducibility, audit trails, and methodology version tracking.</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"digital_mrv_observation\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_patchdigital_mrv_observation_ogcr","parameters":[{"name":"digitalmrvobservationid","in":"path","description":"The DIGITALMRVOBSERVATIONID identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"growing_season_id":{"type":"string"},"observation_date_start":{"type":"string"},"lulc_classification":{"type":"string"},"verification_method":{"type":"string"},"risk_score":{"type":"number"},"data_quality_indicator":{"type":"string"},"uncertainty_pct":{"type":"number"},"soc_baseline_t_per_ha":{"type":"number"},"biomass_estimate_t_per_ha":{"type":"number"},"digital_mrv_protocol":{"type":"string"},"generated_by":{"type":"string"},"observation_date_end":{"type":"string"},"parcel_id":{"type":"string"},"soc_estimate_t_per_ha":{"type":"number"},"data_source":{"type":"string"},"digital_mrv_observation_id":{"type":"string"},"soc_delta_t_per_ha":{"type":"number"}}},"example":{"digital_mrv_observation_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","growing_season_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","observation_date_start":"2026-01-01","observation_date_end":"2026-12-31","digital_mrv_protocol":"WP3-SOC-Sentinel2-v1.2","data_source":"sentinel2","lulc_classification":"cropland_annual","soc_estimate_t_per_ha":42.3,"soc_baseline_t_per_ha":44.1,"soc_delta_t_per_ha":1.8,"biomass_estimate_t_per_ha":3.2,"uncertainty_pct":12.5,"data_quality_indicator":"medium","risk_score":0.08,"verification_method":"dMRV","generated_by":"WP3-pipeline-v2.0.1"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"digital_mrv_observation":{"type":"object","properties":{"growing_season_id":{"type":"string"},"observation_date_start":{"type":"string"},"lulc_classification":{"type":"string"},"verification_method":{"type":"string"},"risk_score":{"type":"number"},"data_quality_indicator":{"type":"string"},"uncertainty_pct":{"type":"number"},"soc_baseline_t_per_ha":{"type":"number"},"biomass_estimate_t_per_ha":{"type":"number"},"digital_mrv_protocol":{"type":"string"},"generated_by":{"type":"string"},"observation_date_end":{"type":"string"},"parcel_id":{"type":"string"},"soc_estimate_t_per_ha":{"type":"number"},"data_source":{"type":"string"},"digital_mrv_observation_id":{"type":"string"},"soc_delta_t_per_ha":{"type":"number"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"digital_mrv_observation":{"digital_mrv_observation_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","digital_mrv_observation_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","parcel_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","growing_season_id":"3dece208-c95c-11f0-9041-54e1adfac5b1","observation_date_start":"2026-01-01","observation_date_end":"2026-12-31","digital_mrv_protocol":"WP3-SOC-Sentinel2-v1.2","data_source":"sentinel2","lulc_classification":"cropland_annual","soc_estimate_t_per_ha":42.3,"soc_baseline_t_per_ha":44.1,"soc_delta_t_per_ha":1.8,"biomass_estimate_t_per_ha":3.2,"uncertainty_pct":12.5,"data_quality_indicator":"medium","risk_score":0.08,"verification_method":"dMRV","generated_by":"WP3-pipeline-v2.0.1"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/parcel-on-chain":{"get":{"tags":["_Parcel_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get parcel_on_chain List","description":"<p>Get parcel_on_chain List.</p>\n<p>Cache of ParcelNFT data minted on the OGCR chain (chain id 20253). One record per parcel_id, populated by OGCR-chain-cache reading the chain. Does not mutate the source <code>parcel</code> entity.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>block_number: Block number the mint was included in.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: ParcelNFT contract address the token was read from.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>parcel_hash: parcel_hash stored on-chain: keccak256 of the raw parcel entity body.</li>\n<li>parcel_id: Links to the <code>parcel</code> dynamic entity. The on-chain ParcelNFT is keyed by this id.</li>\n<li>parcel_uri: parcel_uri stored on-chain: link back to the OBP parcel entity.</li>\n<li>token_id: ParcelNFT token id minted for this parcel.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>tx_hash: Mint transaction hash (from the ParcelMinted event).</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p><em>(no fields on this entity are declared <code>indexed</code>, so only the legacy bare-parameter filter below is available.)</em></p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getparcel_on_chainList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_on_chain_list":{"type":"array","items":{"type":"object","properties":{"parcel_on_chain":{"type":"object","properties":{"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"token_id":{"type":"integer"},"parcel_id":{"type":"string"},"block_number":{"type":"integer"},"parcel_uri":{"type":"string"},"chain_id":{"type":"integer"},"parcel_on_chain_id":{"type":"string"},"owner_address":{"type":"string"},"contract_address":{"type":"string"},"parcel_hash":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"parcel_on_chain_list":[{"parcel_on_chain":{"parcel_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","block_number":12345,"chain_id":20253,"contract_address":"0x62227531b82259561CC9ad4413188F08E536598a","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","parcel_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","parcel_id":"parcel_AB12CD34EF","parcel_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/parcel/parcel_AB12CD34EF","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiUGFyY2VsIn0=","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Parcel_on_chain(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new parcel_on_chain","description":"<p>Create new parcel_on_chain.</p>\n<p>Cache of ParcelNFT data minted on the OGCR chain (chain id 20253). One record per parcel_id, populated by OGCR-chain-cache reading the chain. Does not mutate the source <code>parcel</code> entity.</p>\n<p><strong>Property List:</strong></p>\n<ul>\n<li>block_number: Block number the mint was included in.</li>\n<li>chain_id: EVM chain id (OGCR chain = 20253).</li>\n<li>contract_address: ParcelNFT contract address the token was read from.</li>\n<li>owner_address: Current owner of the NFT (operator OGCR wallet address).</li>\n<li>parcel_hash: parcel_hash stored on-chain: keccak256 of the raw parcel entity body.</li>\n<li>parcel_id: Links to the <code>parcel</code> dynamic entity. The on-chain ParcelNFT is keyed by this id.</li>\n<li>parcel_uri: parcel_uri stored on-chain: link back to the OBP parcel entity.</li>\n<li>token_id: ParcelNFT token id minted for this parcel.</li>\n<li>token_uri: tokenURI of the NFT (ERC721 metadata data-URI).</li>\n<li>tx_hash: Mint transaction hash (from the ParcelMinted event).</li>\n</ul>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"parcel_on_chain\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createparcel_on_chain_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"owner_address":{"type":"string"},"token_id":{"type":"integer"},"parcel_id":{"type":"string"},"block_number":{"type":"integer"},"parcel_uri":{"type":"string"},"chain_id":{"type":"integer"},"contract_address":{"type":"string"},"parcel_hash":{"type":"string"}}},"example":{"block_number":12345,"chain_id":20253,"contract_address":"0x62227531b82259561CC9ad4413188F08E536598a","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","parcel_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","parcel_id":"parcel_AB12CD34EF","parcel_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/parcel/parcel_AB12CD34EF","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiUGFyY2VsIn0=","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"parcel_on_chain":{"type":"object","properties":{"token_uri":{"type":"string"},"tx_hash":{"type":"string"},"token_id":{"type":"integer"},"parcel_id":{"type":"string"},"block_number":{"type":"integer"},"parcel_uri":{"type":"string"},"chain_id":{"type":"integer"},"parcel_on_chain_id":{"type":"string"},"owner_address":{"type":"string"},"contract_address":{"type":"string"},"parcel_hash":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"parcel_on_chain":{"parcel_on_chain_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","block_number":12345,"chain_id":20253,"contract_address":"0x62227531b82259561CC9ad4413188F08E536598a","owner_address":"0x30753E4A8aad7F8597332E813735Def5dD395028","parcel_hash":"0x0000000000000000000000000000000000000000000000000000000000000000","parcel_id":"parcel_AB12CD34EF","parcel_uri":"https://dcr.ogcr.tesobe.com/obp/dynamic-entity/parcel/parcel_AB12CD34EF","token_id":1,"token_uri":"data:application/json;base64,eyJuYW1lIjoiUGFyY2VsIn0=","tx_hash":"0x0000000000000000000000000000000000000000000000000000000000000000"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}},"/activity-co-benefit":{"get":{"tags":["_Activity_co_benefit(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Get activity_co_benefit List","description":"<p>Get activity_co_benefit List.</p>\n<p>Parsed entity activity_co_benefit. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_co_benefit\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n<p><strong>Filtering, sorting and pagination</strong> on the list endpoint:</p>\n<p>Queryable (declared <code>indexed</code>) fields: <code>activity_id</code>, <code>co_benefit_id</code>.</p>\n<ul>\n<li><strong>Filter</strong>: <code>?obp_filter[FIELD]=OP:VALUE</code>. Operators: <code>eq</code>, <code>ne</code>, <code>in</code>, <code>lt</code>, <code>gt</code>, <code>le</code>, <code>ge</code>, <code>between</code>, <code>like</code>, <code>is_null</code>, <code>not_set</code>. <code>in</code> / <code>between</code> take comma-separated values; <code>is_null</code> / <code>not_set</code> take no value. Repeat the same key to AND several constraints on one field.<br />\ne.g. <code>?obp_filter[status]=eq:active&amp;obp_filter[amount]=between:10,100</code> or <code>?obp_filter[closed_date]=not_set</code></li>\n<li><strong>Legacy filter</strong> (still supported): bare field parameters, e.g. <code>?name=James%20Brown&amp;number=123.456&amp;number=11.11</code> filters by <code>name == \"James Brown\" &amp;&amp; (number == 123.456 || number == 11.11)</code>.</li>\n<li><strong>Sort</strong>: <code>?obp_sort_by=FIELD[,FIELD2]&amp;obp_sort_direction=ASC|DESC</code>.</li>\n<li><strong>Paginate</strong>: <code>?obp_limit=20&amp;obp_offset=40</code>.</li>\n</ul>\n<p>Filtering, sorting, pagination and <code>is_null</code> / <code>not_set</code> work on every deployment (no special backend required).</p>\n<p><strong>One-hop joins (EXISTS / NOT EXISTS)</strong> \u2014 filter this entity by a condition on a <em>related</em> entity linked through a declared <code>reference:</code> field:</p>\n<ul>\n<li><code>?obp_exists[RelatedEntity]</code> \u2014 keep rows that have at least one related RelatedEntity.</li>\n<li><code>?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...that have at least one matching the predicate.</li>\n<li><code>?obp_not_exists[RelatedEntity]</code> \u2014 keep rows with NO related RelatedEntity at all.</li>\n<li><code>?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE</code> \u2014 ...with no related RelatedEntity matching the predicate (this <strong>includes</strong> rows that have no related RelatedEntity).</li>\n<li>If two entities are linked by more than one reference, disambiguate the edge with <code>via:</code>, e.g. <code>?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed</code>.</li>\n</ul>\n<p>The nested <code>filter[...]</code> reuses the operator grammar above. Mind the distinction: <code>obp_not_exists[X]=filter[flag]=eq:true</code> (no related X with flag=true \u2014 includes rows with no X) is <strong>not</strong> the same as <code>obp_exists[X]=filter[flag]=ne:true</code> (has a related X with flag≠true \u2014 excludes rows with no X).</p>\n<p>Only a field typed <code>reference:&lt;Entity&gt;</code> <strong>and</strong> declared <code>indexed: true</code> forms a join edge; a plain string field holding ids is not joinable.</p>\n<p>This entity's reference fields (each usable as a one-hop join edge to its target entity): <code>activity_id</code> → <code>activity</code>, <code>co_benefit_id</code> → <code>co_benefit</code>.</p>\n<p><strong>Joins require the SQL projection backend</strong> (<code>dynamic_entity.indexing.backend=auto</code> on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns <code>400 (OBP-09022)</code>; while an index is still building it returns <code>409</code>. The plain filter / sort / paginate / <code>is_null</code> / <code>not_set</code> features above do <strong>not</strong> need the projection backend.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_getactivity_co_benefitList_ogcr","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_co_benefit_list":{"type":"array","items":{"type":"object","properties":{"activity_co_benefit":{"type":"object","properties":{"activity_co_benefit_id":{"type":"string"},"activity_id":{"type":"string"},"co_benefit_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}}}}},"example":{"activity_co_benefit_list":[{"activity_co_benefit":{"activity_co_benefit_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","co_benefit_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}]}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]},"post":{"tags":["_Activity_co_benefit(ogcr)","Dynamic-Entity","Dynamic"],"summary":"Create new activity_co_benefit","description":"<p>Create new activity_co_benefit.</p>\n<p>Parsed entity activity_co_benefit. This Dynamic Entity is part of OGCR.</p>\n<p>MethodRouting settings example:</p>\n<details>\n<pre><code>{\n  \"is_bank_id_exact_match\":false,\n  \"method_name\":\"dynamicEntityProcess\",\n  \"connector_name\":\"rest_vMar2019\",\n  \"bank_id_pattern\":\".*\",\n  \"parameters\":[\n    {\n        \"key\":\"entityName\",\n        \"value\":\"activity_co_benefit\"\n    }\n    {\n        \"key\":\"url\",\n        \"value\":\"http://mydomain.com/xxx\"\n    }\n  ]\n}\n</code></pre>\n</details>\n<p>User Authentication is Required. The User must be logged in. The Application must also be authenticated.</p>\n","operationId":"OBPv7.0.0-dynamicEntity_createactivity_co_benefit_ogcr","requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"activity_id":{"type":"string"},"co_benefit_id":{"type":"string"}}},"example":{"activity_id":"string","co_benefit_id":"string"}}},"required":true},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"activity_co_benefit":{"type":"object","properties":{"activity_co_benefit_id":{"type":"string"},"activity_id":{"type":"string"},"co_benefit_id":{"type":"string"}}},"metadata":{"type":"object","properties":{"created":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}},"updated":{"type":"object","properties":{"at":{"type":"string"},"user_id":{"type":"string"},"on_behalf_of_user_id":{"type":"string"}}}}}}},"example":{"activity_co_benefit":{"activity_co_benefit_id":"d8839721-ad8f-45dd-9f78-2080414b93f9","activity_id":"string","co_benefit_id":"string"},"metadata":{"created":{"at":"2026-09-30T10:12:00Z","user_id":"a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"},"updated":{"at":"2026-09-30T11:40:00Z","user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1","on_behalf_of_user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"}}}}}},"500":{"description":"Internal Server Error"}},"security":[{"DirectLogin":[]},{"GatewayLogin":[]},{"OAuth2":[]}]}}},"components":{"securitySchemes":{"DirectLogin":{"type":"apiKey","description":"Direct Login is a simple authentication process for trusted environments and testing.\n\n### Step 1: Get your Consumer Key\n\nRead the registration instructions at https://portal.dcr.ogcr.tesobe.com/developers/consumer-creation, log in and proceed to https://portal.dcr.ogcr.tesobe.com/consumers/register to register your application and obtain a consumer_key.\n\n### Step 2: Obtain a token\n\nSend a POST request with your credentials in the DirectLogin header:\n\n    POST https://dcr.ogcr.tesobe.com/obp/v6.0.0/my/logins/direct\n    Content-Type: application/json\n    DirectLogin: username=YOUR_USERNAME, password=YOUR_PASSWORD, consumer_key=YOUR_CONSUMER_KEY\n\nThe body should be left empty.\n\nA successful response returns a JSON object containing a token:\n\n    {\"token\": \"your-token-string\"}\n\n### Step 3: Use the token in subsequent API calls\n\nInclude the token in the DirectLogin header on all subsequent requests:\n\n    GET https://dcr.ogcr.tesobe.com/obp/v7.0.0/my/banks\n    DirectLogin: token=your-token-string\n\n### Parameters\n\nParameter names and values are case sensitive. Each parameter must appear only once per request.\n\n- **username** - The name of the user to authenticate.\n- **password** - The password of the user.\n- **consumer_key** - The application identifier obtained during registration.\n\n### Notes\n\n- The header name is **DirectLogin** (case insensitive for HTTP/1.1, must be lower case for HTTP/2).\n- Direct Login is intended for hackathons, testing, and trusted environments.\n- For production use with third-party applications, use OAuth2 / OIDC instead.","name":"DirectLogin","in":"header"},"GatewayLogin":{"type":"apiKey","description":"Gateway Login allows a gateway (e.g. API Gateway) to authenticate on behalf of a user.\n\nThe gateway sends a JWT in the Authorization header. The JWT is signed with a shared secret\nbetween the gateway and OBP. This method does not require a separate token-obtaining step \u2014\nthe JWT is sent directly with each API request.\n\n    GET https://dcr.ogcr.tesobe.com/obp/v7.0.0/my/banks\n    Authorization: GatewayLogin token=\"your-jwt-token\"\n\n### Notes\n\n- Gateway Login is intended for trusted infrastructure, not end-user applications.\n- The JWT must be signed with the pre-shared secret configured on the OBP instance.\n- Contact your OBP administrator for gateway integration details.","name":"Authorization","in":"header"},"OAuth2":{"type":"http","description":"OAuth2 / OpenID Connect (OIDC) is the recommended authentication method for production use.\n\nOBP supports the OAuth2 Authorization Code flow for user-facing applications and the\nClient Credentials flow for application-only (machine-to-machine) access.\n\n### Authorization Code Flow (3-legged)\n\nUse this flow when your application needs to act on behalf of a user.\n\n1. Read the registration instructions at https://portal.dcr.ogcr.tesobe.com/developers/consumer-creation, log in and proceed to https://portal.dcr.ogcr.tesobe.com/consumers/register to register your application and obtain a client_id and client_secret.\n2. Redirect the user to the authorization URL with your client_id and redirect_uri.\n3. After the user authenticates and consents, they are redirected back with an authorization code.\n4. Exchange the authorization code for an access token at the token endpoint.\n5. Use the access token as a Bearer token in the Authorization header:\n\n       GET https://dcr.ogcr.tesobe.com/obp/v7.0.0/my/banks\n       Authorization: Bearer your-access-token\n\n### Client Credentials Flow (2-legged / Application Only)\n\nUse this flow when the application acts as itself. Its Consumer must be a Platform App, and the Roles it\nneeds must be granted to the Consumer as Scopes.\nThe application authenticates itself using its client_id and client_secret without a user login.\n\n    POST https://oidc.dcr.ogcr.tesobe.com/obp-oidc/token\n    Content-Type: application/x-www-form-urlencoded\n\n    grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET\n\nThe response contains a Bearer token to use in subsequent API calls.\n\n### Notes\n\n- The authorization and token endpoint URLs depend on the OIDC provider configured for this OBP instance.\n- OIDC discovery endpoint: https://oidc.dcr.ogcr.tesobe.com/obp-oidc/.well-known/openid-configuration (contains token_endpoint, authorization_endpoint, and jwks_uri).\n- All configured discovery URIs can be queried via: GET https://dcr.ogcr.tesobe.com/obp/v5.1.0/well-known\n- Token expiry and refresh behaviour depend on the OIDC provider configuration.\n- OAuth2 / OIDC is the recommended method for production deployments.","scheme":"bearer","bearerFormat":"JWT"}}},"tags":[{"name":"_Co_benefits(ogcr)","description":"Operations related to _Co_benefits(ogcr)"},{"name":"Dynamic-Entity","description":"Operations related to Dynamic-Entity"},{"name":"Dynamic","description":"Operations related to Dynamic"},{"name":"_Certification_scheme(ogcr)","description":"Operations related to _Certification_scheme(ogcr)"},{"name":"_Parcel_owner_verification_supporting_document(ogcr)","description":"Operations related to _Parcel_owner_verification_supporting_document(ogcr)"},{"name":"_Parcel_owner(ogcr)","description":"Operations related to _Parcel_owner(ogcr)"},{"name":"_Technologies_practices_processes(ogcr)","description":"Operations related to _Technologies_practices_processes(ogcr)"},{"name":"_Activity_verification_supporting_document(ogcr)","description":"Operations related to _Activity_verification_supporting_document(ogcr)"},{"name":"_Parcel(ogcr)","description":"Operations related to _Parcel(ogcr)"},{"name":"_Certification_on_chain(ogcr)","description":"Operations related to _Certification_on_chain(ogcr)"},{"name":"_Retirement_certificate(ogcr)","description":"Operations related to _Retirement_certificate(ogcr)"},{"name":"_Reversal_event(ogcr)","description":"Operations related to _Reversal_event(ogcr)"},{"name":"_Carbon_credit_batch(ogcr)","description":"Operations related to _Carbon_credit_batch(ogcr)"},{"name":"_Digital_mrv_observation(ogcr)","description":"Operations related to _Digital_mrv_observation(ogcr)"},{"name":"_Activity(ogcr)","description":"Operations related to _Activity(ogcr)"},{"name":"_User_certification_body_relationship(ogcr)","description":"Operations related to _User_certification_body_relationship(ogcr)"},{"name":"_Growing_season(ogcr)","description":"Operations related to _Growing_season(ogcr)"},{"name":"_Buffer_pool(ogcr)","description":"Operations related to _Buffer_pool(ogcr)"},{"name":"_Co_benefit(ogcr)","description":"Operations related to _Co_benefit(ogcr)"},{"name":"_Certificate_of_compliance(ogcr)","description":"Operations related to _Certificate_of_compliance(ogcr)"},{"name":"_Supporting_document(ogcr)","description":"Operations related to _Supporting_document(ogcr)"},{"name":"_Operator(ogcr)","description":"Operations related to _Operator(ogcr)"},{"name":"_Livestock(ogcr)","description":"Operations related to _Livestock(ogcr)"},{"name":"_Authority(ogcr)","description":"Operations related to _Authority(ogcr)"},{"name":"_User_operator_relationship(ogcr)","description":"Operations related to _User_operator_relationship(ogcr)"},{"name":"_Sustainable_development_goals(ogcr)","description":"Operations related to _Sustainable_development_goals(ogcr)"},{"name":"_User_certification_scheme_relationship(ogcr)","description":"Operations related to _User_certification_scheme_relationship(ogcr)"},{"name":"_Audit_report(ogcr)","description":"Operations related to _Audit_report(ogcr)"},{"name":"_Parcel_snapshot(ogcr)","description":"Operations related to _Parcel_snapshot(ogcr)"},{"name":"_Test_1(ogcr)","description":"Operations related to _Test_1(ogcr)"},{"name":"_Parcel_on_chain(ogcr)","description":"Operations related to _Parcel_on_chain(ogcr)"},{"name":"_Chain_sync_status(ogcr)","description":"Operations related to _Chain_sync_status(ogcr)"},{"name":"_Carbon_credit_batch_on_chain(ogcr)","description":"Operations related to _Carbon_credit_batch_on_chain(ogcr)"},{"name":"_Certificate_of_compliance_on_chain(ogcr)","description":"Operations related to _Certificate_of_compliance_on_chain(ogcr)"},{"name":"_Land_manager(ogcr)","description":"Operations related to _Land_manager(ogcr)"},{"name":"_Country(ogcr)","description":"Operations related to _Country(ogcr)"},{"name":"_Retirement_certificate_on_chain(ogcr)","description":"Operations related to _Retirement_certificate_on_chain(ogcr)"},{"name":"_Activity_on_chain(ogcr)","description":"Operations related to _Activity_on_chain(ogcr)"},{"name":"_Retirement_event(ogcr)","description":"Operations related to _Retirement_event(ogcr)"},{"name":"_Activity_non_conformity(ogcr)","description":"Operations related to _Activity_non_conformity(ogcr)"},{"name":"_Activity_verification(ogcr)","description":"Operations related to _Activity_verification(ogcr)"},{"name":"_Parcel_owner_verification(ogcr)","description":"Operations related to _Parcel_owner_verification(ogcr)"},{"name":"_Activity_monitoring_period_verification(ogcr)","description":"Operations related to _Activity_monitoring_period_verification(ogcr)"},{"name":"_Certification_body(ogcr)","description":"Operations related to _Certification_body(ogcr)"},{"name":"_Activity_technologies_practices_processes(ogcr)","description":"Operations related to _Activity_technologies_practices_processes(ogcr)"},{"name":"_Activity_plan(ogcr)","description":"Operations related to _Activity_plan(ogcr)"},{"name":"_Supervisory_non_conformity(ogcr)","description":"Operations related to _Supervisory_non_conformity(ogcr)"},{"name":"_Liability_choice(ogcr)","description":"Operations related to _Liability_choice(ogcr)"},{"name":"_Sustainable_development_goal(ogcr)","description":"Operations related to _Sustainable_development_goal(ogcr)"},{"name":"_Certification_body_authority(ogcr)","description":"Operations related to _Certification_body_authority(ogcr)"},{"name":"_Activity_media(ogcr)","description":"Operations related to _Activity_media(ogcr)"},{"name":"_Parcel_activity(ogcr)","description":"Operations related to _Parcel_activity(ogcr)"},{"name":"_Crop(ogcr)","description":"Operations related to _Crop(ogcr)"},{"name":"_Retirement_event_on_chain(ogcr)","description":"Operations related to _Retirement_event_on_chain(ogcr)"},{"name":"_Ogcr_dynamicentities_log(ogcr)","description":"Operations related to _Ogcr_dynamicentities_log(ogcr)"},{"name":"_Activity_co_benefit(ogcr)","description":"Operations related to _Activity_co_benefit(ogcr)"},{"name":"_User_authority_relationship(ogcr)","description":"Operations related to _User_authority_relationship(ogcr)"},{"name":"_Activity_sustainable_development_goal(ogcr)","description":"Operations related to _Activity_sustainable_development_goal(ogcr)"},{"name":"_Carbon_credit_balance_on_chain(ogcr)","description":"Operations related to _Carbon_credit_balance_on_chain(ogcr)"},{"name":"_Monitoring_plan(ogcr)","description":"Operations related to _Monitoring_plan(ogcr)"},{"name":"_Supervisory_finding(ogcr)","description":"Operations related to _Supervisory_finding(ogcr)"},{"name":"OGCR-Registry","description":"Operations related to OGCR-Registry"}]}