Get certification_on_chain List
GET /obp/dynamic-entity/banks/ogcr/certification_on_chain
OBPv4.0.0-dynamicEntity_getcertification_on_chainList_ogcr Roles: CanGetDynamicEntityRecord_certification_on_chain(per bank) _Certification_on_chain(ogcr)Dynamic-EntityDynamic
Get certification_on_chain List.
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.
Property List:
- activity_hash: activity_hash stored on-chain: keccak256 of the raw activity entity body.
- activity_id: activity_id of the certified activity as stored on-chain.
- activity_name: Activity name as stored on-chain.
- activity_nft_id: ActivityNFT token id this certification references (stored on-chain).
- activity_uri: activity_uri stored on-chain: link back to the OBP activity entity.
- audit_report_hash: audit_report_hash stored on-chain: keccak256 of the raw audit_report entity body.
- audit_report_uri: audit_report_uri stored on-chain: link back to the OBP audit_report entity.
- block_number: Block number the mint was included in.
- 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.
- 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.
- 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.
- 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.
- certificate_of_compliance_hash: certificate_of_compliance_hash stored on-chain: keccak256 of the raw certificate_of_compliance entity body.
- certificate_of_compliance_id: Links to the
certificate_of_compliancedynamic entity. The on-chain CertificationNFT is keyed by this id. - certificate_of_compliance_uri: certificate_of_compliance_uri stored on-chain: link back to the OBP certificate_of_compliance entity.
- certification_body_hash: certification_body_hash stored on-chain: keccak256 of the raw certification_body entity body.
- certification_body_name: Certification body name as stored on-chain.
- certification_body_uri: certification_body_uri stored on-chain: link back to the OBP certification_body entity.
- certification_scheme_hash: certification_scheme_hash stored on-chain: keccak256 of the raw certification_scheme entity body.
- certification_scheme_name: Certification scheme name as stored on-chain.
- certification_scheme_uri: certification_scheme_uri stored on-chain: link back to the OBP certification_scheme entity.
- certification_status: Certification status as stored on-chain.
- chain_id: EVM chain id (OGCR chain = 20253).
- contract_address: CertificationNFT contract address the token was read from.
- country_id: Country id as stored on-chain.
- expiry_date: Certification expiry date as stored on-chain.
- issue_date: Certification issue date as stored on-chain.
- owner_address: Current owner of the NFT (operator OGCR wallet address).
- 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.
- 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.
- token_id: CertificationNFT token id minted for this certificate.
- token_uri: tokenURI of the NFT (ERC721 metadata data-URI).
- tx_hash: Mint transaction hash (from the CertificationMinted event).
- unit_types: Unit types of the certificate as stored on-chain.
MethodRouting settings example:
<details>
{
"is_bank_id_exact_match":false,
"method_name":"dynamicEntityProcess",
"connector_name":"rest_vMar2019",
"bank_id_pattern":".*",
"parameters":[
{
"key":"entityName",
"value":"certification_on_chain"
}
{
"key":"url",
"value":"http://mydomain.com/xxx"
}
]
}
</details>
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
Filtering, sorting and pagination on the list endpoint:
(no fields on this entity are declared indexed, so only the legacy bare-parameter filter below is available.)
- Filter:
?obp_filter[FIELD]=OP:VALUE. Operators:eq,ne,in,lt,gt,le,ge,between,like,is_null,not_set.in/betweentake comma-separated values;is_null/not_settake no value. Repeat the same key to AND several constraints on one field. e.g.?obp_filter[status]=eq:active&obp_filter[amount]=between:10,100or?obp_filter[closed_date]=not_set - Legacy filter (still supported): bare field parameters, e.g.
?name=James%20Brown&number=123.456&number=11.11filters byname == "James Brown" && (number == 123.456 || number == 11.11). - Sort:
?obp_sort_by=FIELD[,FIELD2]&obp_sort_direction=ASC|DESC. - Paginate:
?obp_limit=20&obp_offset=40.
Filtering, sorting, pagination and is_null / not_set work on every deployment (no special backend required).
One-hop joins (EXISTS / NOT EXISTS) — filter this entity by a condition on a related entity linked through a declared reference: field:
?obp_exists[RelatedEntity]— keep rows that have at least one related RelatedEntity.?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE— ...that have at least one matching the predicate.?obp_not_exists[RelatedEntity]— keep rows with NO related RelatedEntity at all.?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE— ...with no related RelatedEntity matching the predicate (this includes rows that have no related RelatedEntity).- If two entities are linked by more than one reference, disambiguate the edge with
via:, e.g.?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed.
The nested filter[...] reuses the operator grammar above. Mind the distinction: obp_not_exists[X]=filter[flag]=eq:true (no related X with flag=true — includes rows with no X) is not the same as obp_exists[X]=filter[flag]=ne:true (has a related X with flag≠true — excludes rows with no X).
Only a field typed reference:<Entity> and declared indexed: true forms a join edge; a plain string field holding ids is not joinable.
Joins require the SQL projection backend (dynamic_entity.indexing.backend=auto on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns 400 (OBP-09022); while an index is still building it returns 409. The plain filter / sort / paginate / is_null / not_set features above do not need the projection backend.
Example success response
{
"bank_id": "ogcr",
"certification_on_chain_list": [
{
"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"
}
]
}Possible errors (3)
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.