API Explorer 1884 endpoints

Get chain_sync_status List

GET /obp/v7.0.0/banks/ogcr/dynamic-entities/chain_sync_status

OBPv7.0.0-dynamicEntity_getchain_sync_statusList_ogcr Roles: CanGetDynamicEntityRecord_chain_sync_status(per bank) _Chain_sync_status(ogcr)Dynamic-EntityDynamic

Get chain_sync_status List.

Liveness record for OGCR-chain-cache: one record per chain, rewritten at the end of every mirror run. The other *_on_chain entities say what is on the chain; this says when anything last looked. Without it a quiet chain is indistinguishable from a dead mirror, because the newest mint could be old for either reason. Consumers should treat a record older than a few multiples of interval_seconds as stale.

Property List:

  • activity_count: Activity tokens mirrored in this run.
  • certification_count: Certification tokens mirrored in this run.
  • chain_id: EVM chain id that was read.
  • credit_balance_count: Carbon credit holder balances mirrored in this run.
  • credit_batch_count: Carbon credit batch tokens mirrored in this run.
  • error_count: Records that failed to upsert during the run.
  • head_block: Chain head at the end of the run. Rising across runs is the clearest sign the chain itself is alive, as opposed to only the mirror.
  • interval_seconds: Expected seconds between runs, from SYNC_INTERVAL_SECONDS. 0 when the cacher was run by hand. Lets a consumer decide what counts as stale without hardcoding the schedule.
  • mirrored_types: Which mirrors ran, comma separated. Distinguishes a count of zero meaning "none found" from a mirror that was skipped because its contract is not configured.
  • parcel_count: Parcel tokens mirrored in this run.
  • run_status: "ok" when every configured mirror completed with no errors, "partial" when the chain was reachable but some records failed to write. A run that cannot reach the chain at all writes nothing, so the previous record simply ages.
  • sync_key: Business key: "chain-<chain_id>". One record per chain, overwritten each run. A string key so it can be matched with a server-side query filter.
  • synced_at: UTC RFC-3339 timestamp of when the run finished. This is the field a heartbeat is actually built on.

MethodRouting settings example:

<details>

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"chain_sync_status"
    }
    {
        "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:

(no fields on this entity are declared indexed, so only the legacy bare-parameter filter below is available.)

  • 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": "ogcr",
  "chain_sync_status_list": [
    {
      "chain_sync_status": {
        "chain_sync_status_id": "d8839721-ad8f-45dd-9f78-2080414b93f9",
        "activity_count": 2,
        "certification_count": 2,
        "chain_id": 20253,
        "credit_balance_count": 5,
        "credit_batch_count": 2,
        "error_count": 0,
        "head_block": 12400,
        "interval_seconds": 30,
        "mirrored_types": "parcel,activity,certification,credit",
        "parcel_count": 2,
        "run_status": "ok",
        "sync_key": "chain-20253",
        "synced_at": "2026-09-08T20:14:03Z"
      },
      "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_getchain_sync_statusList_ogcr Originally /banks/ogcr/dynamic-entities/chain_sync_status