API Explorer 891 endpoints

Get crop by id

GET /obp/v7.0.0/banks/SYS/dynamic-entities/crop/CROP_ID

OBPv7.0.0-dynamicEntity_getSinglecrop_ Roles: CanGetDynamicEntityRecord_crop(per bank) _CropDynamic-EntityDynamic

Get crop by id.

A reference table of agricultural crop types. Each record defines a crop category with its commodity classification. growing_season records (below) reference this entity for each instance of a crop grown on a parcel. This Dynamic Entity is part of OGCR.

Property List:

  • crop_id: Unique internal identifier automatically assigned to each crop type entry.
  • crop_type: The specific type of crop, drawn from a controlled vocabulary to ensure consistency across the registry. Used to classify and filter parcels by crop in the supply shed view.
  • local_name: The local or vernacular name for the crop as used by the farmer or in the national context. Optional, for display and farmer-facing interfaces only.
  • commodity_category: The broad commodity group this crop belongs to, used to aggregate parcels into supply sheds for Scope 3 reporting. Examples: cereals, oilseeds, legumes, forage, vegetables.
  • lca_emission_factor: The lifecycle assessment (LCA) emission factor for this crop type, expressed in kilograms of CO2 equivalent per tonne of harvested product. Sourced from IPCC, JRC or Ecoinvent reference datasets — not entered by farmers. Used by the Scope 3 marketplace to compute emission intensity per sourced tonne.

MethodRouting settings example:

<details>

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"crop"
    }
    {
        "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": "SYS",
  "crop": {
    "crop_id": "crop_01JS0347FKH",
    "crop_type": "winter_wheat",
    "local_name": "Winterweizen",
    "commodity_category": "cereals",
    "lca_emission_factor": 0.52
  },
  "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 (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 OBPv7.0.0 dynamicEntity_getSinglecrop_ Originally /banks/SYS/dynamic-entities/crop/CROP_ID