API Explorer 1884 endpoints

Partially update activity

PATCH /obp/v7.0.0/banks/SYS/dynamic-entities/activity/ACTIVITY_ID

OBPv7.0.0-dynamicEntity_patchactivity_ Roles: CanUpdateDynamicEntityRecord_activity(per bank) _ActivityDynamic-EntityDynamic

Partially update activity: only the fields supplied in the body are changed; others are preserved.

This is also the write path for field-level write-restricted fields (those declared with write_role_required or an explicit write_role). Authorisation is per field present in the body: a write-restricted field requires that field's write role, and an unrestricted field requires the entity update role. You may change a field if (and only if) you hold the role that governs it; the request is rejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update precondition — holding only a field's write role is sufficient to PATCH that field alone.

‘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
  • image: Primary image URL or asset reference for UI cards.
  • media_links: Array of related URLs (reports, press, docs).
  • operator_id: Internal identifier for the operator entity
  • technologies_practices_processes: List of practices/processes used in the activity (structured or strings).
  • type: Activity category, assigned by system automatically 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_code: ISO 3166-1 alpha-2 country code for where the activity occurs.
  • multipolygon_coordinates: GeoJSON MultiPolygon boundary of the activity area.
  • activity_plan_id: Reference to the Activity Plan resource created for this Activity
  • 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: Name 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 request body
{
  "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",
  "image": "https://cdn.example.org/activity-images/activity_123.png",
  "media_links": "https://example.org/docs/activity_123_overview.pdf,\nhttps://example.org/blog/regen-wheat",
  "operator_id": "op_01JS0347FKH",
  "technologies_practices_processes": "cover_cropping\",\"reduced_tillage\",\"precision_fertilization",
  "type": "CARBON_FARMING",
  "unit_types": "Soil Emission Reduction",
  "city": "Seelow",
  "country_code": "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
          ]
        ]
      ]
    ]
  },
  "activity_plan_id": "TBD",
  "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": "CRCF Scheme"
}
Example success response
{
  "bank_id": "SYS",
  "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",
    "image": "https://cdn.example.org/activity-images/activity_123.png",
    "media_links": "https://example.org/docs/activity_123_overview.pdf,\nhttps://example.org/blog/regen-wheat",
    "operator_id": "op_01JS0347FKH",
    "technologies_practices_processes": "cover_cropping\",\"reduced_tillage\",\"precision_fertilization",
    "type": "CARBON_FARMING",
    "unit_types": "Soil Emission Reduction",
    "city": "Seelow",
    "country_code": "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
            ]
          ]
        ]
      ]
    },
    "activity_plan_id": "TBD",
    "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": "CRCF Scheme"
  },
  "metadata": {
    "created": {
      "at": "2026-09-30T10:12:00Z",
      "user_id": "a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f",
      "on_behalf_of_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"
    },
    "updated": {
      "at": "2026-09-30T11:40:00Z",
      "user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "on_behalf_of_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"
    }
  }
}
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 OBPv7.0.0 dynamicEntity_patchactivity_ Originally /banks/SYS/dynamic-entities/activity/ACTIVITY_ID