get-private-reports-REPORT_ID.rst (1869B)
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 :http:statuscode:`500 Internal Server Error`: 18 The server experienced an internal failure. 19 Returned with ``TALER_EC_GENERIC_DB_FETCH_FAILED``. 20 21 **Details:** 22 23 .. ts:def:: ReportDetailResponse 24 25 interface ReportDetailResponse { 26 27 // Report identifier 28 report_serial: Integer; 29 30 // Description of the report. Possibly included 31 // in the report message. 32 description: string; 33 34 // Merchant backend configuration section specifying 35 // the program to use to transmit the report 36 program_section: string; 37 38 // Mime-type to request from the data source. 39 mime_type: string; 40 41 // Base URL to request the data from. 42 data_source: string; 43 44 // Address where the report program should send 45 // the report. 46 target_address: string; 47 48 // Report frequency 49 report_frequency: RelativeTime; 50 51 // Report frequency shift 52 report_frequency_shift: RelativeTime; 53 54 // Numeric `error code <error-codes>` unique to the 55 // error encountered in generating the latest report. 56 // Absent if there was no error. 57 last_error_code?: Integer; 58 59 // Details about any error encountered 60 // in generating the latest report. 61 last_error_detail?: string; 62 }