Generated Reports Repository - API Contract

GET /api/v1/generated-reports/api/v1/generated-reports

List all generated reports

Public

Request Example

{}

Response Example

{
  "data": [
    {
      "report_id": "rpt_20250101_region07_pdf",
      "org_id": "org_482",
      "scope_id": "scope_region_07",
      "scope_level": "region",
      "format": "pdf",
      "status": "complete",
      "file_url": "https://storage.example.no/exports/org_482/rpt_20250101_region07_pdf.pdf",
      "submission_ref": "bufdir_ref_20260326_00482",
      "created_at": "2026-03-26T10:16:00Z"
    },
    {
      "report_id": "rpt_20240101_region07_csv",
      "org_id": "org_482",
      "scope_id": "scope_region_07",
      "scope_level": "region",
      "format": "csv",
      "status": "complete",
      "file_url": "https://storage.example.no/exports/org_482/rpt_20240101_region07_csv.csv",
      "submission_ref": null,
      "created_at": "2025-03-15T08:10:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 7
  }
}

GET /api/v1/generated-reports/api/v1/generated-reports/:report_id

Get a single generated report record

Public

Request Example

{}

Response Example

{
  "report_id": "rpt_20250101_region07_pdf",
  "org_id": "org_482",
  "scope_id": "scope_region_07",
  "scope_level": "region",
  "date_range": {
    "from": "2025-01-01",
    "to": "2025-12-31"
  },
  "format": "pdf",
  "status": "complete",
  "file_url": "https://storage.example.no/exports/org_482/rpt_20250101_region07_pdf.pdf",
  "submission_ref": "bufdir_ref_20260326_00482",
  "created_at": "2026-03-26T10:16:00Z",
  "updated_at": "2026-03-26T10:32:00Z"
}

POST /api/v1/generated-reports/api/v1/generated-reports

Create a new generated report record

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",
  "date_range": {
    "from": "2025-01-01",
    "to": "2025-12-31"
  },
  "format": "pdf",
  "status": "pending",
  "file_url": null,
  "submission_ref": null,
  "created_at": "2026-03-26T10:16:00Z"
}

PUT /api/v1/generated-reports/api/v1/generated-reports/:report_id

Update status, file URL, or submission reference on a report

Public

Request Example

{
  "status": "complete",
  "file_url": "https://storage.example.no/exports/org_482/rpt_20250101_region07_pdf.pdf",
  "submission_ref": "bufdir_ref_20260326_00482"
}

Response Example

{
  "report_id": "rpt_20250101_region07_pdf",
  "status": "complete",
  "file_url": "https://storage.example.no/exports/org_482/rpt_20250101_region07_pdf.pdf",
  "submission_ref": "bufdir_ref_20260326_00482",
  "updated_at": "2026-03-26T10:32:00Z"
}

DELETE /api/v1/generated-reports/api/v1/generated-reports/:report_id

Delete a generated report record

Public

Request Example

{}

Response Example

{
  "report_id": "rpt_20250101_region07_pdf",
  "deleted": true,
  "deleted_at": "2026-03-26T10:45:00Z"
}

Additional Metadata

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}