API Explorer 891 endpoints

Get activity_plan List

GET /obp/dynamic-entity/activity_plan

OBPv4.0.0-dynamicEntity_getactivity_planList_ Roles: CanGetDynamicEntityRecord_activity_plan(per bank) _Activity_planDynamic-EntityDynamic

Get activity_plan List.

Parsed entity activity_plan. This Dynamic Entity is part of OGCR.

Property List:

  • activity_plan_id: Internal identifier for the activity plan entity. This is set by the operator platform.
  • activity_id: Internal identifier for the activity entity
  • date_submitted: Date the activity plan is submitted
  • legal_parcel_ownership: Legal ownership
  • coordinate_reference_system: Coordinate Reference System (CRS) identifier that defines how to interpret the geometry coordinates (e.g., EPSG:4326 for WGS84).
  • iacs_codes: Array of identifiers referencing the parcel in the Member State’s IACS (Integrated Administration and Control System). Only if applicable.
  • lpis_codes: Identifiers from the Land Parcel Identification System (LPIS) that reference official “reference parcels”/land blocks. Only if applicable.
  • methodology_quantification_baseline: Quantification, incl. calculation of activity baseline (if applicable)
  • expected_total_carbon_removals: Expected total carbon removals associated to the activity (in CO2e Tonnes)
  • expected_total_soil_emissions: Expected total total soil emissions associated to the activity (in CO2e Tonnes)
  • expected_total_ghg_emissions_associated: Expected total GHG emissions associated to the activity (in CO2e Tonnes)
  • expected_net_benefit: Expected net carbon removal benefit or expected net soil emission reduction benefit (in CO2e Tonnes)

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_plan"
    }
    {
        "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:

(no fields on this entity are declared indexed, so only the legacy bare-parameter filter below is available.)

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

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
{
  "activity_plan_list": [
    {
      "activity_plan_id": "ap-1037502-192zf129r3",
      "activity_id": "a_05OFWI037022",
      "date_submitted": "2026-11-20",
      "legal_parcel_ownership": "TBD",
      "coordinate_reference_system": "EPSG:4326",
      "iacs_codes": "DE-BB-IACS-2026-0012345678",
      "lpis_codes": "DE-BB-LPIS-REFPARCEL-0098765432",
      "methodology_quantification_baseline": "TBD",
      "expected_total_carbon_removals": 6,
      "expected_total_soil_emissions": 6,
      "expected_total_ghg_emissions_associated": 6,
      "expected_net_benefit": 6
    }
  ]
}
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_planList_ Originally /activity_plan