API endpoint to trigger reports as jobs

[Flix6x]

Description

Closes #2288 (API part): adds POST /api/v3_0/assets/<id>/reports/trigger, which queues a one-off reporting job on the reporting queue, mirroring how forecasts and schedules are triggered via the API. Builds on the reports-as-jobs infrastructure from #2297.

Request body

{
    "reporter": "PandasReporter",
    "config": { ... reporter configuration (static, stored on the reporter's data source) ... },
    "parameters": { "input": [...], "output": [...], "start": "...", "end": "..." }
}

• reporter (required): reporter class registered in FlexMeasures or a plugin (see flexmeasures show reporters).
• config (optional): validated by the reporter's config schema.
• parameters (required): validated against the base ReporterParametersSchema and then by the reporter's own parameters schema; must reference at least one output sensor.

Response

{"status": "PROCESSED", "report": "<job UUID>", "message": "Request has been processed."}

The job status can be polled via the existing generic GET /api/v3_0/jobs/<uuid> endpoint, and the queued job records its trigger as {"origin": "API"} in the job meta.

Permissions

The asset in the URL path scopes permissions: create-children access is required (any account member, or consultants), matching the schedule trigger endpoint. Output sensors are assumed to belong to the asset or its (grand)children (documented, not hard-enforced), and parameters without any output are rejected with a 422.

Look & Feel

New endpoint documented in the Swagger UI (with a PandasReporter example), in documentation/features/reporting.rst ("Automating reports") and in the API change log.

How to test

python -m pytest flexmeasures/api/v3_0/tests/test_report_trigger_api.py

Covers the permission matrix (anonymous 401 / other account 403 / account member 200), successful queueing (job on the reporting queue with meta["trigger"] == {"origin": "API"}), and a range of invalid messages (missing timing fields, missing output, unknown reporter, invalid config, missing required fields) each yielding a 422 without queueing a job.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Rbix8k1JfeUWNXEmHEZVpX

[read-the-docs-community]

Documentation build overview

📚 flexmeasures | 🛠️ Build #33546373 | 📁 Comparing df77725 against latest (4a5892f)

  🔍 Preview build  

36 files changed · + 5 added · ± 31 modified

+ Added

• _autosummary/flexmeasures.data.models.automations.html
• _autosummary/flexmeasures.data.schemas.automations.html
• _autosummary/flexmeasures.data.services.automations.html
• _autosummary/flexmeasures.data.services.reporting.html
• features/automations.html

± Modified

• changelog.html
• genindex.html
• http-routingtable.html
• index.html
• py-modindex.html
• _autosummary/flexmeasures.api.v3_0.assets.html
• _autosummary/flexmeasures.cli.utils.html
• _autosummary/flexmeasures.data.models.data_sources.html
• _autosummary/flexmeasures.data.models.html
• _autosummary/flexmeasures.data.models.reporting.html
• and 21 more...