Bufdir Export Service
API Contract
REST
/api/v1/bufdir-exports
4 endpoints
POST
/api/v1/bufdir-exports/api/v1/bufdir-exports/preview
Preview export before generation
Public
Request Example
{
"org_id": "org_482",
"scope_id": "scope_region_07",
"scope_level": "region",
"date_range": {
"from": "2025-01-01",
"to": "2025-12-31"
},
"format": "pdf"
}
Response Example
{
"preview_id": "prev_9183",
"org_id": "org_482",
"scope_id": "scope_region_07",
"scope_level": "region",
"date_range": {
"from": "2025-01-01",
"to": "2025-12-31"
},
"format": "pdf",
"activity_count": 1247,
"mentor_count": 83,
"unmapped_types": [],
"warnings": [],
"generated_at": "2026-03-26T10:15:00Z"
}
POST
/api/v1/bufdir-exports/api/v1/bufdir-exports/generate
Trigger full export generation
Public
Request Example
{
"org_id": "org_482",
"scope_id": "scope_region_07",
"scope_level": "region",
"date_range": {
"from": "2025-01-01",
"to": "2025-12-31"
},
"format": "pdf"
}
Response Example
{
"report_id": "rpt_20250101_region07_pdf",
"org_id": "org_482",
"scope_id": "scope_region_07",
"scope_level": "region",
"format": "pdf",
"status": "generating",
"created_at": "2026-03-26T10:16:00Z"
}
GET
/api/v1/bufdir-exports/api/v1/bufdir-exports/:report_id/download
Download a completed export by report ID
Public
Request Example
{}
Response Example
{
"report_id": "rpt_20250101_region07_pdf",
"download_url": "https://storage.example.no/exports/org_482/rpt_20250101_region07_pdf.pdf?token=abc123&expires=1743000000",
"filename": "bufdir_export_region07_2025.pdf",
"mime_type": "application/pdf",
"size_bytes": 204800,
"expires_at": "2026-03-26T11:16:00Z"
}
DELETE
/api/v1/bufdir-exports/api/v1/bufdir-exports/:report_id/cancel
Cancel an in-progress export
Public
Request Example
{}
Response Example
{
"report_id": "rpt_20250101_region07_pdf",
"status": "cancelled",
"cancelled_at": "2026-03-26T10:17:30Z"
}