API Explorer 896 endpoints

Create new activity_on_chain

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

OBPv4.0.0-dynamicEntity_createactivity_on_chain_ogcr Roles: CanCreateDynamicEntityRecord_activity_on_chain(per bank) _Activity_on_chain(ogcr)Dynamic-EntityDynamic

Create new activity_on_chain.

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.

Example request body
{
  "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"
}
Example success response
{
  "bank_id": "ogcr",
  "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"
  }
}
Possible errors (4)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Implemented by OBPv4.0.0 dynamicEntity_createactivity_on_chain_ogcr Originally /banks/ogcr/activity_on_chain