Partially update crop
PATCH /obp/dynamic-entity/crop/CROP_ID
OBPv4.0.0-dynamicEntity_patchcrop_ Roles: CanUpdateDynamicEntityRecord_crop(per bank) _CropDynamic-EntityDynamic
Partially update crop: 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.
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 request body
{
"crop_id": "crop_01JS0347FKH",
"crop_type": "winter_wheat",
"local_name": "Winterweizen",
"commodity_category": "cereals",
"lca_emission_factor": 0.52
}Example success response
{
"crop": {
"crop_id": "crop_01JS0347FKH",
"crop_type": "winter_wheat",
"local_name": "Winterweizen",
"commodity_category": "cereals",
"lca_emission_factor": 0.52
}
}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.