API Explorer 5 endpoints

Get monitoring_plan List

GET /obp/dynamic-entity/monitoring_plan

OBPv4.0.0-dynamicEntity_getmonitoring_planList_ Roles: CanGetDynamicEntityRecord_monitoring_plan(per bank) _Monitoring_planDynamic-EntityDynamic

Get monitoring_plan List.

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

Property List:

  • monitoring_plan_id: Unique identifier for monitoring plan entity
  • date_submitted: Date/time the monitoring plan was submitted. Created by system.
  • monitored_data_parameters: List of parameters to be collected/computed during monitoring (should be structured, each with name, unit, and scope).
  • monitoring_frequency: How often each parameter is monitored (months)
  • emission_sources_and_sinks: Emission sources and sinks
  • data_source: Where the monitored data comes from (field sampling, remote sensing, farm management system, invoices, IoT).
  • measurement_methods_procedures_accuracy_calibration: Measurement methods and procedures (accuracy and calibration)
  • quality_assessment_or_quality_control_procedures: Quality assessment or quality control procedures
  • responsibility_for_collection_and_archiving: Responsibility for collection and archiving

MethodRouting settings example:

<details>

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"monitoring_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
{
  "monitoring_plan_list": [
    {
      "monitoring_plan_id": "mp_01HZYW8C9R7P4D2A6K1TQ3",
      "date_submitted": "2026-11-20",
      "monitored_data_parameters": "[{\"name\": \"soc_percent\", \"unit\": \"%\", \"scope\": \"soil_0_30cm\"}, {\"name\": \"bulk_density\", \"unit\": \"g/cm3\", \"scope\": \"soil_0_30cm\"}, {\"name\": \"yield\", \"unit\": \"t/ha\", \"scope\": \"crop_wheat\"}]",
      "monitoring_frequency": 12,
      "emission_sources_and_sinks": "TBD",
      "data_source": "TBD",
      "measurement_methods_procedures_accuracy_calibration": "TBD",
      "quality_assessment_or_quality_control_procedures": "TBD",
      "responsibility_for_collection_and_archiving": "TBD"
    }
  ]
}
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_getmonitoring_planList_ Originally /monitoring_plan