feat: 37468/add REST API endpoints for instructor dashboard data downloads

[wgu-jesse-stewart]

Issue #37468

Description

This PR adds REST API endpoints to support programmatic access to the Instructor Dashboard's data download functionality. It introduces two new v2 API endpoints that allow instructors to list available report downloads and trigger report generation for their courses.

Changes:

• GET /api/instructor/v2/courses/{course_id}/reports - Lists all available report downloads for a course with metadata (filename, URL, type, date generated)
• POST /api/instructor/v2/courses/{course_id}/reports/{report_type}/generate - Triggers generation of a specific report type

Supported Report Types:

• enrolled_students - Student profile and enrollment data
• pending_enrollments - Users allowed to enroll but haven't yet
• pending_activations - Inactive users with enrollments
• anonymized_student_ids - Anonymized student ID mapping
• grade - Course grade report
• problem_grade - Problem-level grade report
• problem_responses - Student responses to problems
• ora2_summary - Open Response Assessment summary
• ora2_data - ORA detailed data export
• ora2_submission_files - ORA submission file archives
• issued_certificates - Certificate issuance data

User Roles Impacted:

• Instructors/Course Staff - Can now programmatically access data downloads via API
• Developers - Can integrate course data exports into external systems

Supporting information

Related to ticket #37468

Testing instructions

1. Setup: Ensure you have instructor access to a course with existing data

2. Test GET endpoint:

   curl -X GET "http://localhost:18000/api/instructor/v2/courses/{course_id}/reports" \
     -H "Authorization: Bearer {token}"

   Expected: Returns JSON array of available downloads with metadata

3. Test POST endpoint (generate grade report):

   curl -X POST "http://localhost:18000/api/instructor/v2/courses/{course_id}/reports/grade/generate" \
     -H "Authorization: Bearer {token}"

   Expected: Returns success message indicating report generation started

4. Test Problem Responses with specific problem:

   curl -X POST "http://localhost:18000/api/instructor/v2/courses/{course_id}/reports/problem_responses/generate" \
     -H "Authorization: Bearer {token}" \
     -H "Content-Type: application/json" \
     -d '{"problem_location": "block-v1:..."}'

5. Verify report detection: Check that existing reports in storage are correctly categorized by type

6. Test error cases:

   • Invalid course ID (expect 404)
   • Invalid report type (expect 400)
   • Non-instructor user (expect 403)

Other information

• These endpoints use existing instructor task infrastructure - no new background task types required
• Report storage uses the existing ReportStore configured via GRADES_DOWNLOAD
• The issued_certificates report is generated synchronously (small dataset), all others are async tasks
• GenerateReportView uses @method_decorator(transaction.non_atomic_requests) to allow async task submission
• New ReportType enum added to instructor_task/data.py for consistent report type identifiers
• Report type detection from filenames uses pattern matching (most specific patterns checked first)

[openedx-webhooks]

Thanks for the pull request, @wgu-jesse-stewart!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

• If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
  • This process (including the steps you'll need to take) is documented here.
• If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

• Dependencies

  This PR must be merged before / after / at the same time as ...

• Blockers

  This PR is waiting for OEP-1234 to be accepted.

• Timeline information

  This PR must be merged by XX date because ...

• Partner information

  This is for a course on edx.org.

• Supporting documentation
• Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details

---

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

• The size and impact of the changes that it introduces
• The need for product review
• Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

[Copilot]

Pull request overview

This PR introduces new Instructor API v2 endpoints to support programmatic access to the Instructor Dashboard “Data Downloads” workflows by (1) listing available report files from ReportStore and (2) triggering generation of specific report types (mostly via existing instructor-task async infrastructure).

Changes:

• Added ReportType enum (and a task-type→report-type mapping) intended to standardize report identifiers.
• Added v2 API views to list report downloads and trigger report generation (including a synchronous issued-certificates export stored into ReportStore).
• Wired the new endpoints into the instructor v2 URL configuration.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 10 comments.

File	Description
lms/djangoapps/instructor_task/data.py	Adds ReportType and a mapping from instructor task types to report types.
lms/djangoapps/instructor/views/api_v2.py	Implements the new GET /reports and POST /reports/{report_type}/generate endpoints and related helpers.
lms/djangoapps/instructor/views/api_urls.py	Registers the new v2 routes for listing/generating report downloads.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.