API Explorer 5 endpoints

Get activity_on_chain List

GET /obp/dynamic-entity/banks/ogcr/activity_on_chain

OBPv4.0.0-dynamicEntity_getactivity_on_chainList_ogcr Roles: CanGetDynamicEntityRecord_activity_on_chain(per bank) _Activity_on_chain(ogcr)Dynamic-EntityDynamic

Get activity_on_chain List.

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.

Property List:

  • activity_hash: activity_hash stored on-chain: keccak256 of the raw activity entity body.
  • activity_id: The activity this NFT was minted for (a reference, so OBP joins activity -> activity_on_chain, e.g. in the registry query). OBP refuses a record whose activity is not in this space.
  • activity_type: Activity type as stored on-chain.
  • activity_url: activity_url stored on-chain: link back to the OBP activity entity.
  • block_number: Block number the mint was included in.
  • certification_scheme_id: certification_scheme_id as stored on-chain.
  • chain_id: EVM chain id (OGCR chain = 20253).
  • city: City as stored on-chain.
  • contract_address: ActivityNFT contract address the token was read from.
  • country_id: Country id as stored on-chain.
  • end_date: Activity end date as stored on-chain.
  • minted_at: Unix time (seconds) of the block the mint was included in.
  • name: Activity name as stored on-chain.
  • operator_id: operator_id stored on-chain (owning operator).
  • operator_name: Operator legal name (operator.legal_name) as stored on-chain.
  • owner_address: Current owner of the NFT (operator OGCR wallet address).
  • parcel_ids: Parcels linked to the activity at mint time: the contract's parcel_ids[] joined with commas, as tokenURI renders it.
  • start_date: Activity start date as stored on-chain.
  • summary: Activity summary as stored on-chain.
  • token_id: ActivityNFT token id minted for this activity.
  • token_uri: tokenURI of the NFT (ERC721 metadata data-URI).
  • tx_hash: Mint transaction hash (from the ActivityMinted event).
  • unit_types: Unit types of the activity as stored on-chain.
  • website: Activity website 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":"activity_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:

Queryable (declared indexed) fields: activity_id, minted_at.

  • Filter: ?obp_filter[FIELD]=OP:VALUE. Operators: eq, ne, in, lt, gt, le, ge, between, like, is_null, not_set. in / between take comma-separated values; is_null / not_set take 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,100 or ?obp_filter[closed_date]=not_set
  • Legacy filter (still supported): bare field parameters, e.g. ?name=James%20Brown&number=123.456&number=11.11 filters by name == "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.

This entity's reference fields (each usable as a one-hop join edge to its target entity): activity_id → activity.

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",
  "activity_on_chain_list": [
    {
      "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"
    }
  ]
}
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.
Implemented by OBPv4.0.0 dynamicEntity_getactivity_on_chainList_ogcr Originally /banks/ogcr/activity_on_chain