For Developers
Enrichments Overview
An Enrichment is a background job that reconciles multiple linked sources (e.g. merging student identifiers from an SIS with activity and grade data from an LMS) into unified records in the regional database.
Properties
| Property | Type | Description |
|---|---|---|
id | UUID | Unique identifier for the enrichment execution run. |
created_date | Date | When the enrichment was queued. |
updated_date | Date | Last modification time. |
started_date | Date | Time when enrichment began. |
completed_date | Date | Time when enrichment completed. |
state | String | Execution status: queued, running, completed, or failed. |
source_id | UUID | Primary source ID for this enrichment. |
JSON Example
{
"id": "e931b9fa-7104-4c8d-8bb4-0980fa2a5c11",
"created_date": "2024-06-21T07:00:00.000Z",
"started_date": "2024-06-21T07:02:00.000Z",
"completed_date": "2024-06-21T07:15:00.000Z",
"state": "completed",
"source_id": "7b5a19cb-9ea8-4b71-9b16-564ec5ea0b12"
}
