OGCR Schema
Login

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.

  • Space

    The registry's own space (a Bank in OBP). Its Dynamic Entities, Role Groups and Roles all belong to it.

    Glossary
  • User

    A person with an account. Users are linked to operators through user_operator_relationship.

    Glossary
  • Entitlement

    A Role granted to a User, in the space or system wide. Each operation on each entity needs one.

    Glossary
  • Role Group

    A named set of Roles granted to Users together, such as everything an operator needs.

    Glossary Used in Group entitlements
  • Consumer

    An 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.

    Glossary
  • Scope

    A Role granted to a Consumer. It applies when a Platform App, such as the chain cache, calls the API as itself.

    Glossary
  • Organisation

    A team that owns Consumers, so more than one person can manage an app.

    Glossary
  • Metric

    A 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 Doc

    The description of one endpoint: its path, Roles, example bodies and errors. API Explorer II and the OpenAPI documents are built from them.

    Glossary
  • Dynamic Resource Doc

    An endpoint defined in the space while OBP-API is running, such as a Dynamic Query. The space's own are listed below.

    Glossary
  • Glossary Item

    An 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.

  • Asset

    A 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.

    Glossary
  • Product

    A kind of account the space offers, with its fees and rules. Each Account is opened on a Product.

    Glossary
  • Account

    Holds a balance in one Asset, in the space. Its Views decide who may see it and pay from it.

    Glossary
  • View

    What 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 Access
  • Transaction

    An amount moved into or out of an Account.

    Glossary
  • Transaction Request

    A 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.

Main tables (34)

The registry and marketplace records.

On-chain tables (8)

Mirrors of chain state, named *_on_chain.

Link tables (7)

Only *_id columns: they join other entities.

Lookup tables (10)

Fewer than 4 columns, e.g. a code and its name.

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.

  • GET /registry/activities-query No Role needed
  • GET /registry/activity-certificates-query No Role needed
  • GET /registry/activity-practices-query No Role needed
  • GET /registry/activity-query No Role needed
  • GET /registry/activity-sdgs-query No Role needed