For Developers

Syncs Overview

A Sync represents a single scheduled or on-demand execution of Edlink's data synchronization pipeline. During a sync, data is fetched from the source provider, normalized into standard Edlink entities, validated, and loaded into the regional database.

Properties

PropertyTypeDescription
idUUIDUnique identifier for the sync execution run.
created_dateDateWhen the sync was queued.
updated_dateDateLast time the sync record was updated.
heartbeat_dateDateLast time the sync worker reported progress.
stateStringCurrent execution status: planned, queued, working, staged, flushing, complete, error, canceled, killed, reverted, or pending.
typeStringSync type: full, partial, buffer, person, class, or attendance.
source_idUUIDIdentifier of the data source being synchronized.
parent_idUUIDParent sync ID when this run is a child sync.

JSON Example

{
    "id": "673cf97a-9a91-4560-8f96-3a72df54db12",
    "created_date": "2024-06-21T06:00:00.000Z",
    "updated_date": "2024-06-21T06:45:00.000Z",
    "heartbeat_date": "2024-06-21T06:45:00.000Z",
    "state": "complete",
    "type": "full",
    "source_id": "7b5a19cb-9ea8-4b71-9b16-564ec5ea0b12"
}