Reports

Get a report's details + steps (legacy GET /reports/details)

Requires permission: ReportAdmins

Returns the report detail and its steps for the report-setup editor. Port of the legacy v2 GetReportDetails endpoint. Steps are returned as the base ReportSteps shape (the Flutter ReportStepRequest extends it; entry-group/mark-grade-form fields default to null).

get/reports/details

Query parameters

reportIdinteger required

Response

Success - Got report details

Changes

Changed in 2 of the 22 revisions of this API.11

    • added the optional property steps/items/entries/items/student/oneOf[Student]/academicHouseObject/oneOf[House]/day to the response with the 200 status

      response-optional-property-added

    • added the optional property steps/items/entries/items/student/oneOf[Student]/boardingHouseObject/oneOf[House]/day to the response with the 200 status

      response-optional-property-added

    • added the optional property steps/items/entries/items/student/oneOf[Student]/academicHouseObject/oneOf[House]/staff/items/staff/oneOf[StaffMember]/employeeId to the response with the 200 status

      response-optional-property-added

    • added the optional property steps/items/entries/items/student/oneOf[Student]/academicHouseObject/oneOf[House]/staff/items/staff/oneOf[StaffMember]/school to the response with the 200 status

      response-optional-property-added

    • added the optional property steps/items/entries/items/student/oneOf[Student]/boardingHouseObject/oneOf[House]/staff/items/staff/oneOf[StaffMember]/employeeId to the response with the 200 status

      response-optional-property-added

    • added the optional property steps/items/entries/items/student/oneOf[Student]/boardingHouseObject/oneOf[House]/staff/items/staff/oneOf[StaffMember]/school to the response with the 200 status

      response-optional-property-added

    • added the optional property steps/items/entries/items/student/oneOf[Student]/formObject/oneOf[Form]/staff/items/employeeId to the response with the 200 status

      response-optional-property-added

    • added the optional property steps/items/entries/items/student/oneOf[Student]/formObject/oneOf[Form]/staff/items/school to the response with the 200 status

      response-optional-property-added

    • added the optional property steps/items/entries/items/student/oneOf[Student]/musicLessons/items/teacher/oneOf[StaffMember]/employeeId to the response with the 200 status

      response-optional-property-added

    • added the optional property steps/items/entries/items/student/oneOf[Student]/musicLessons/items/teacher/oneOf[StaffMember]/school to the response with the 200 status

      response-optional-property-added

    • added the optional property steps/items/groupSelectionsJson to the response with the 200 status

      response-optional-property-added