Schema
The Static and Dynamic Entities and Dynamic Resource Docs of space ogcr.
Static Entities (17)
OBP-API's own records that the registry relies on (summary). They are built into OBP-API, not defined in the space.
Users and access (8)
Who may call the API, and what each person or app may do.
SpaceThe registry's own space (a Bank in OBP). Its Dynamic Entities, Role Groups and Roles all belong to it.
GlossaryUserA person with an account. Users are linked to operators through user_operator_relationship.
GlossaryEntitlementA Role granted to a User, in the space or system wide. Each operation on each entity needs one.
GlossaryRole GroupA named set of Roles granted to Users together, such as everything an operator needs.
Glossary Used in Group entitlementsConsumerAn app registered to call the API, with its own credentials. OGCR-App, the Operator and Certification Platforms and the chain cache are each a Consumer.
GlossaryScopeA Role granted to a Consumer. It applies when a Platform App, such as the chain cache, calls the API as itself.
GlossaryMetricA record of each API call: which app and person called which endpoint, when, and how long it took.
Glossary
API documentation (3)
How the endpoints and terms are described.
Resource DocThe description of one endpoint: its path, Roles, example bodies and errors. API Explorer II and the OpenAPI documents are built from them.
GlossaryDynamic Resource DocAn endpoint defined in the space while OBP-API is running, such as a Dynamic Query. The space's own are listed below.
GlossaryGlossary ItemAn explanation of an OBP term. The Glossary links on this page open them in API Explorer II.
Glossary
Accounts and payments (6)
Balances, and the payments that move them.
AssetA unit that amounts are held in, such as EUR or a token. Its code is the currency of an account, a transaction or a product fee.
GlossaryProductA kind of account the space offers, with its fees and rules. Each Account is opened on a Product.
GlossaryAccountHolds a balance in one Asset, in the space. Its Views decide who may see it and pay from it.
GlossaryViewWhat a User or Consumer may see and do on an Account, such as see its balance or make payments. An Account Access record gives a User a View on an Account, and a User needs one to use the Account at all.
Glossary: ViewGlossary: Account AccessTransaction RequestA request to pay from an Account. Once it is approved, and any challenge is answered, OBP-API makes the Transaction.
Glossary
Dynamic Entities
The registry's own record types, such as activity and parcel. A Dynamic Entity is defined while OBP-API is running, without changing its code, and OBP-API then provides its endpoints and the Roles that guard them. OGCR-DynamicEntities defines them in the space from the schema spreadsheet.
Dynamic Entities in API Manager Glossary: Dynamic-EntitiesGlossary: Dynamic-Entity-Access-Model
Main tables (34)
The registry and marketplace records.
- 23 columns
activityDetails in API Manager Used in Activities - 8 columns
activity_mediaDetails in API Manager - 14 columns
activity_monitoring_period_verificationDetails in API Manager Used in Activities - 7 columns
activity_non_conformityDetails in API Manager - 19 columns
activity_planDetails in API Manager - 10 columns
activity_verificationDetails in API Manager Used in Activities - 41 columns
audit_reportDetails in API Manager - 7 columns
authorityDetails in API Manager - 6 columns
buffer_poolDetails in API Manager - 10 columns
carbon_credit_batchDetails in API Manager - 18 columns
certificate_of_complianceDetails in API Manager Used in Registry - 12 columns
certification_bodyDetails in API Manager - 8 columns
certification_body_authorityDetails in API Manager - 7 columns
certification_schemeDetails in API Manager - 13 columns
chain_sync_statusDetails in API Manager Used in Chain - 5 columns
- 17 columns
digital_mrv_observationDetails in API Manager - 14 columns
growing_seasonDetails in API Manager - 5 columns
land_managerDetails in API Manager - 6 columns
liability_choiceDetails in API Manager - 12 columns
livestockDetails in API Manager - 10 columns
monitoring_planDetails in API Manager - 7 columns
ogcr_dynamicentities_logDetails in API Manager - 9 columns
operatorDetails in API Manager Used in Operators - 6 columns
- 6 columns
parcel_ownerDetails in API Manager - 6 columns
parcel_owner_verificationDetails in API Manager Used in Activities - 8 columns
parcel_snapshotDetails in API Manager - 13 columns
retirement_certificateDetails in API Manager - 12 columns
retirement_eventDetails in API Manager - 22 columns
reversal_eventDetails in API Manager - 9 columns
supervisory_findingDetails in API Manager - 8 columns
supervisory_non_conformityDetails in API Manager - 4 columns
supporting_documentDetails in API Manager
On-chain tables (8)
Mirrors of chain state, named *_on_chain.
- 24 columns
activity_on_chainDetails in API Manager Used in Chain - 9 columns
carbon_credit_balance_on_chainDetails in API Manager Used in Chain - 35 columns
carbon_credit_batch_on_chainDetails in API Manager Used in Chain - 24 columns
certificate_of_compliance_on_chainDetails in API Manager - 34 columns
certification_on_chainDetails in API Manager Used in Chain - 10 columns
parcel_on_chainDetails in API Manager Used in Chain - 19 columns
retirement_certificate_on_chainDetails in API Manager - 16 columns
retirement_event_on_chainDetails in API Manager
Link tables (7)
Only *_id columns: they join other entities.
- 2 columns
activity_co_benefitDetails in API Manager - 2 columns
activity_sustainable_development_goalDetails in API Manager - 2 columns
activity_technologies_practices_processesDetails in API Manager - 3 columns
activity_verification_supporting_documentDetails in API Manager - 2 columns
parcel_activityDetails in API Manager Used in Activities - 2 columns
parcel_owner_verification_supporting_documentDetails in API Manager - 2 columns
sustainable_development_goalsDetails in API Manager
Lookup tables (10)
Fewer than 4 columns, e.g. a code and its name.
- 2 columns
co_benefitDetails in API Manager - 2 columns
co_benefitsDetails in API Manager - 2 columns
- 3 columns
sustainable_development_goalDetails in API Manager - 2 columns
technologies_practices_processesDetails in API Manager - 1 column
test_1Details in API Manager - 3 columns
user_authority_relationshipDetails in API Manager - 3 columns
user_certification_body_relationshipDetails in API Manager - 3 columns
user_certification_scheme_relationshipDetails in API Manager - 3 columns
user_operator_relationshipDetails in API Manager Used in Operators
Dynamic Resource Docs (5)
Endpoints defined in the space while OBP-API is running, such as the Dynamic Queries behind the public registry pages. A Dynamic Query reads one Dynamic Entity and joins in related records. One that needs no Role can be called without logging in.
Dynamic Resource Docs in API Manager Glossary: Dynamic Resource DocGlossary: Dynamic Query
GET /registry/activities-queryNo Role neededGET /registry/activity-certificates-queryNo Role neededGET /registry/activity-practices-queryNo Role neededGET /registry/activity-queryNo Role neededGET /registry/activity-sdgs-queryNo Role needed