API Explorer 891 endpoints

Get activity by id

GET /obp/dynamic-entity/banks/dylan-bank/activity/ACTIVITY_ID

OBPv4.0.0-dynamicEntity_getSingleactivity_dylan-bank Roles: CanGetDynamicEntityRecord_activity(per bank) _Activity(dylan-bank)Dynamic-EntityDynamic

Get activity by id.

‘activity’ means one or more practices or processes carried out by an operator, or a group of operators, resulting in a permanent/temporary carbon removal through carbon farming or carbon storage in products, or soil emission reductions. This Dynamic Entity is part of OGCR.

Property List:

  • activity_id: Internal identifier for the activity
  • name: Human-readable activity name shown in UI and exports.
  • summary: 1–2 sentence public summary, used in Activity listing.
  • description: Longer narrative description (scope, intent, participants, context).
  • website: Public URL with activity/operator details
  • hero_image: Primary image URL for hero image
  • image: Primary image URL or asset reference for UI cards.
  • operator_id: Internal identifier for the operator entity
  • activity_type: Activity category, based on technologies, practices and processes. (CARBON_FARMING, PERMANENT_REMOVAL, CARBON_STORAGE_IN_PRODUCTS)
  • unit_types: Unit category that will be produced during this activity. (Permanent Removal, Carbon Farming Sequestration, Soil Emission Reduction, Carbon Storage in Product)
  • city: Primary city/municipality associated with the activity
  • country_id: ISO 3166-1 alpha-2 country code for where the activity occurs.
  • multipolygon_coordinates: GeoJSON MultiPolygon boundary of the activity area.
  • start_date: Start date of the activity implementation period (when practices/process begin).
  • end_date: End date of the activity implementation period.
  • term_commitment: Commitment/contract duration for maintaining practices.
  • cobenefits: Declared co-benefits
  • methodologies: Methodology IDs/names and versions used to quantify outcomes
  • monitoring_period_years: Planned monitoring duration in years
  • monitoring_period_start_date: Start date of the monitoring window used for MRV/accounting
  • monitoring_period_end_date: End date of the monitoring window
  • certification_scheme_id: ID of the certification scheme chosen by the operator.

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"
    }
    {
        "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 success response
{
  "bank_id": "dylan-bank",
  "activity": {
    "activity_id": "a_05OFWI037022",
    "name": "Brandenburg Regenerative Wheat",
    "summary": "Wheat rotation adopting cover crops and reduced tillage across enrolled parcels.",
    "description": "This activity aggregates multiple parcels under a single operator to monitor practice changes and estimate carbon stock change over the monitoring period.",
    "website": "https://example.org/activities/brandenburg-wheat",
    "hero_image": "https://cdn.example.org/activity-images/activity_123.png",
    "image": "https://cdn.example.org/activity-images/activity_123.png",
    "operator_id": "op_01JS0347FKH",
    "activity_type": "CARBON_FARMING",
    "unit_types": "Soil Emission Reduction",
    "city": "Seelow",
    "country_id": "DE",
    "multipolygon_coordinates": {
      "type": "MultiPolygon",
      "coordinates": [
        [
          [
            [
              14.3801,
              52.5201
            ],
            [
              14.3901,
              52.5201
            ],
            [
              14.3901,
              52.5301
            ],
            [
              14.3801,
              52.5301
            ],
            [
              14.3801,
              52.5201
            ]
          ]
        ]
      ]
    },
    "start_date": "2027-01-01",
    "end_date": "2031-12-31",
    "term_commitment": 5,
    "cobenefits": "[\"biodiversity\", \"water_quality\", \"soil_health\"]",
    "methodologies": "TBD",
    "monitoring_period_years": 5,
    "monitoring_period_start_date": "2027-01-01",
    "monitoring_period_end_date": "2031-12-31",
    "certification_scheme_id": "CRCF Scheme"
  }
}
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_getSingleactivity_dylan-bank Originally /banks/dylan-bank/activity/ACTIVITY_ID