get-private-reports-REPORT_SERIAL.rst (1583B)
1 .. http:get:: [/instances/$INSTANCES]/private/reports/$REPORT_SERIAL 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 13 :http:statuscode:`404 Not found`: 14 The report or instance is unknown to the backend. 15 16 **Details:** 17 18 .. ts:def:: ReportDetailResponse 19 20 interface ReportDetailResponse { 21 22 // Report identifier 23 report_serial: Integer; 24 25 // Description of the report. Possibly included 26 // in the report message. 27 description: string; 28 29 // Merchant backend configuration section specifying 30 // the program to use to transmit the report 31 program_section: string; 32 33 // Mime-type to request from the data source. 34 mime_type: string; 35 36 // Base URL to request the data from. 37 data_source: string; 38 39 // Address where the report program should send 40 // the report. 41 target_address: string; 42 43 // Report frequency 44 report_frequency: RelativeTime; 45 46 // Report frequency shift 47 report_frequency_shift: RelativeTime; 48 49 // Numeric `error code <error-codes>` unique to the 50 // error encountered in generating the latest report. 51 // Absent if there was no error. 52 last_error_code?: Integer; 53 54 // Details about any error encountered 55 // in generating the latest report. 56 last_error_detail?: string; 57 }