API Explorer 891 endpoints

Get reversal_event List

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

OBPv4.0.0-dynamicEntity_getreversal_eventList_dylan-bank Roles: CanGetDynamicEntityRecord_reversal_event(per bank) _Reversal_event(dylan-bank)Dynamic-EntityDynamic

Get reversal_event List.

‘certificate of compliance’ means a conformity statement issued by a certification body certifying that an activity complies with this Regulation;. This Dynamic Entity is part of OGCR.

Property List:

  • reversal_event_id: Internal identifier for the reversal event
  • activity_id: Activity the reversal traces back to
  • parcel_id: Parcel(s) affected by the reversal, if reversal is parcel-specific rather than activity-wide
  • monitoring_period_id: Monitoring period during which the reversal occurred (Art. 6(2)(a) ties mitigation rules to the monitoring period)
  • token_id: The minted unit(s)/token(s) affected — feeds the state transition to Invalidated/Revoked
  • quantity_reversed_tco2e: Amount of carbon released back to the atmosphere, quantified conservatively per Art. 4(12)
  • reversal_cause: Cause of the reversal (fire, drought, tillage/ploughing, land-use change, pest/disease, other)
  • voluntary_flag: Whether the reversal was voluntary, involuntary, or undetermined (Recital 22 distinction)
  • occurrence_date: Date the reversal actually happened
  • detected_date: Date the reversal was detected/reported
  • detection_source: Who/what detected it (self-report, monitoring system, certifier audit, third-party)
  • status_code: Workflow status of the reversal case
  • liability_choice_id: Which liability mechanism applies (buffer pool / individual liability / insurance) — Art. 6(2)(b)
  • buffer_pool_drawdown_amount: Amount drawn from the buffer pool to cover the reversal, if applicable
  • units_cancelled: Reference(s) to units directly cancelled as last resort (Art. 6(3)(i))
  • verification_body_id: Certification body that confirmed the reversal
  • audit_report_id: Audit report documenting confirmation of the reversal
  • certification_methodology_reference: Which methodology's reversal/liability rules governed this case
  • corrective_measures: Remediation actions required/taken
  • on_chain_tx_hash: Transaction hash of the invalidation/cancellation event on-chain
  • created_at: Record creation timestamp
  • updated_at: Last update timestamp

MethodRouting settings example:

<details>

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"reversal_event"
    }
    {
        "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: activity_id, audit_report_id, liability_choice_id, monitoring_period_id, parcel_id, reversal_event_id, status_code, verification_body_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.

This entity's reference fields (each usable as a one-hop join edge to its target entity): activity_id → activity, audit_report_id → audit_report, liability_choice_id → liability_choice, monitoring_period_id → monitoring_plan, parcel_id → parcel, verification_body_id → certification_body.

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",
  "reversal_event_list": [
    {
      "reversal_event_id": "rev_01HZZ2P3Q4R5S6T7U8V9",
      "activity_id": "a_05OFWI037022",
      "parcel_id": "parcel_03OGNWO397234DQ",
      "monitoring_period_id": "mp_01HZYW8C9R7P4D2A6K1TQ3",
      "token_id": "0xAb58...token_id_42",
      "quantity_reversed_tco2e": 6,
      "reversal_cause": "fire",
      "voluntary_flag": "involuntary",
      "occurrence_date": "2028-06-14",
      "detected_date": "2028-06-20",
      "detection_source": "monitoring_system",
      "status_code": "reported / under_review / confirmed / liability_applied / resolved",
      "liability_choice_id": "lc_01HZZ3...",
      "buffer_pool_drawdown_amount": 6,
      "units_cancelled": "0xAb58...token_id_42",
      "verification_body_id": "cb_01HZZ1M2A3B4C5D6E7F8",
      "audit_report_id": "ar_01HZZ4...",
      "certification_methodology_reference": "{\"id\": \"crcf_agri_mineral_soils\", \"version\": \"1.0\"}",
      "corrective_measures": "Re-establishment of cover crop, revised monitoring frequency",
      "on_chain_tx_hash": "0x8f2a...c91e",
      "created_at": "2028-06-20",
      "updated_at": "2028-07-01"
    }
  ]
}
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_getreversal_eventList_dylan-bank Originally /banks/dylan-bank/reversal_event