Create new chain_sync_status
POST /obp/v7.0.0/banks/ogcr/dynamic-entities/chain_sync_status
OBPv7.0.0-dynamicEntity_createchain_sync_status_ogcr Roles: CanCreateDynamicEntityRecord_chain_sync_status(per bank) _Chain_sync_status(ogcr)Dynamic-EntityDynamic
Create new chain_sync_status.
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.
Example request body
{
"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"
}Example success response
{
"bank_id": "ogcr",
"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 (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.