For Developers

Extractions Overview

An Extraction is the first stage in the Edlink synchronization workflow for extract-capable providers. During an extraction, raw data is scraped from provider endpoints and stored in an isolated staging extraction database.

Properties

PropertyTypeDescription
idUUIDUnique identifier for the extraction run.
created_dateDateWhen the extraction was initiated.
updated_dateDateWhen the extraction record was last updated.
started_dateDateWhen data extraction began executing.
completed_dateDateWhen data extraction concluded.
stateStringExecution state: running, completed, failed, or cancelled.
source_idUUIDSource whose provider is being extracted.
sequenceNumberMonotonically increasing sequence number.

JSON Example

{
    "id": "4a18dc60-5ff0-482a-9e1e-28ebc9735d10",
    "created_date": "2024-06-21T05:00:00.000Z",
    "started_date": "2024-06-21T05:01:00.000Z",
    "completed_date": "2024-06-21T05:30:00.000Z",
    "state": "completed",
    "sequence": 42,
    "source_id": "7b5a19cb-9ea8-4b71-9b16-564ec5ea0b12"
}