API Explorer 896 endpoints

Get crop List

GET /obp/dynamic-entity/banks/dylan-bank/crop

OBPv4.0.0-dynamicEntity_getcropList_dylan-bank Roles: CanGetDynamicEntityRecord_crop(per bank) _Crop(dylan-bank)Dynamic-EntityDynamic

Get crop List.

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.

Filtering, sorting and pagination on the list endpoint:

Queryable (declared indexed) fields: crop_id.

  • 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
{
  "bank_id": "dylan-bank",
  "crop_list": [
    {
      "crop_id": "crop_01JS0347FKH",
      "crop_type": "winter_wheat",
      "local_name": "Winterweizen",
      "commodity_category": "cereals",
      "lca_emission_factor": 0.52
    }
  ]
}
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_getcropList_dylan-bank Originally /banks/dylan-bank/crop