patch-private-reports-REPORT_ID.rst (1704B)
1 .. http:patch:: [/instances/$INSTANCE]/private/reports/$REPORT_ID 2 3 This is used to update a scheduled report. 4 5 **Required permission:** ``reports-write`` 6 7 **Request:** 8 9 The request body must be a `ReportPatchRequest`. 10 11 **Response:** 12 13 :http:statuscode:`204 No content`: 14 The report has successfully modified. 15 :http:statuscode:`400 Bad Request`: 16 The report ID parameter or request body is malformed. 17 Returned with ``TALER_EC_GENERIC_PARAMETER_MALFORMED``. 18 :http:statuscode:`404 Not found`: 19 The report or instance is unknown to the backend. 20 Returned with ``TALER_EC_MERCHANT_GENERIC_REPORT_UNKNOWN``. 21 :http:statuscode:`500 Internal Server Error`: 22 The server experienced an internal failure. 23 Returned with ``TALER_EC_GENERIC_DB_STORE_FAILED``. 24 25 26 **Details:** 27 28 .. ts:def:: ReportPatchRequest 29 30 interface ReportPatchRequest { 31 32 // Description of the report. Possibly included 33 // in the report message. 34 description: string; 35 36 // Merchant backend configuration section specifying 37 // the program to use to transmit the report 38 program_section: string; 39 40 // Mime-type to request from the data source. 41 mime_type: string; 42 43 // URL under the instance to request the data from. 44 // Must start with '/'. The base URL and the instance 45 // prefix will be prefixed to the given data source. 46 data_source: string; 47 48 // Address where the report program should send 49 // the report. 50 target_address: string; 51 52 // Report frequency 53 report_frequency: RelativeTime; 54 55 // Report frequency shift. Defaults to zero if missing. 56 report_frequency_shift?: RelativeTime; 57 58 }