get-private-reports-REPORT_ID.rst (2025B)
1 .. http:get:: [/instances/$INSTANCE]/private/reports/$REPORT_ID 2 3 This is used to obtain detailed information about a specific 4 scheduled report. 5 6 **Required permission:** ``reports-read`` 7 8 **Response:** 9 10 :http:statuscode:`200 OK`: 11 The backend has successfully returned the detailed information about a specific report. Returns a `ReportDetailResponse`. 12 :http:statuscode:`400 Bad Request`: 13 The report ID parameter is malformed. 14 Returned with ``TALER_EC_GENERIC_PARAMETER_MALFORMED``. 15 :http:statuscode:`404 Not found`: 16 The report or instance is unknown to the backend. 17 Returned with ``TALER_EC_MERCHANT_GENERIC_REPORT_UNKNOWN``. 18 :http:statuscode:`500 Internal Server Error`: 19 The server experienced an internal failure. 20 Returned with ``TALER_EC_GENERIC_DB_FETCH_FAILED``. 21 22 **Details:** 23 24 .. ts:def:: ReportDetailResponse 25 26 interface ReportDetailResponse { 27 28 // Report identifier 29 report_serial: Integer; 30 31 // Description of the report. Possibly included 32 // in the report message. 33 description: string; 34 35 // Merchant backend configuration section specifying 36 // the program to use to transmit the report 37 program_section: string; 38 39 // Mime-type to request from the data source. 40 mime_type: string; 41 42 // Base URL to request the data from. 43 data_source: string; 44 45 // Address where the report program should send 46 // the report. 47 target_address: string; 48 49 // Report frequency 50 report_frequency: RelativeTime; 51 52 // Report frequency shift 53 report_frequency_shift: RelativeTime; 54 55 // Timestamp of the next scheduled transmission. 56 next_transmission: Timestamp; 57 58 // Numeric `error code <error-codes>` unique to the 59 // error encountered in generating the latest report. 60 // Absent if there was no error. 61 last_error_code?: Integer; 62 63 // Details about any error encountered 64 // in generating the latest report. 65 last_error_detail?: string; 66 }