API Explorer 891 endpoints

Create new monitoring_plan

POST /obp/v7.0.0/banks/SYS/dynamic-entities/monitoring_plan

OBPv7.0.0-dynamicEntity_createmonitoring_plan_ Roles: CanCreateDynamicEntityRecord_monitoring_plan(per bank) _Monitoring_planDynamic-EntityDynamic

Create new monitoring_plan.

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.

Example request body
{
  "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"
}
Example success response
{
  "bank_id": "SYS",
  "monitoring_plan": {
    "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"
  },
  "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_createmonitoring_plan_ Originally /banks/SYS/dynamic-entities/monitoring_plan