MobileApp

Function: list_reports Type: API Endpoint (GET)

Purpose:
Retrieves a list of reports from the database with various details.

Headers:

  • Customer_Key (str, required): The customer key.
  • App_Code (str, optional): The application code. If not provided, it defaults to 'AspireBI'.
  • Code (str, optional): The user code.

Response:
A JSON response containing a list of report objects, each with the following properties:

  • report_id: The ID of the report.
  • report_name: The name of the report.
  • display_name: The display name of the report.
  • module: The module code of the report.
  • application_type: The application type of the report.
  • report_type: The report type of the report.
  • report_path: The report path of the report.
  • workspace_id: The workspace ID of the report.
  • is_oem: A boolean indicating if the report is OEM.
  • status: A boolean indicating if the report is active.
  • shared_dataset: A boolean indicating if the report uses a shared dataset.
  • modified_by: The user who last modified the report.
  • modified_on: The date and time when the report was last modified.
  • is_adminstrator: A boolean indicating if the user is an administrator.
  • has_report_access: A boolean indicating if the user has access to the report.

Exceptions:

  • Raises JSONResponse with a 404 status code if no reports are found.
  • Raises JSONResponse with a 500 status code for any internal server errors.
get/api/MobileApp/master/reports

Request

Headers

Customer-Keystring required
App-Codestring nullable
Codestring nullable
Report-Typeinteger nullable

Response

Successful Response

unknown required

Changes