Modify the report template configuration - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Modify the report template configuration","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/744a8207-9965-344e-aed3-d3ef846a4950","info":{"title":"Others","description":"Other APIs\n- Include APIs that do not belong to other categories\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Scheduled Report Management"],"summary":"Modify the report template configuration","description":"Update the report template by report ID","operationId":"updateReportTemplate","parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"description":"updated report config","content":{"application/json":{"schema":{"required":["emailRecipient","reportName","scheduleConfig"],"type":"object","properties":{"businessHours":{"required":["endTime","startTime"],"type":"object","properties":{"endTime":{"pattern":"^(20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$","type":"string"},"startTime":{"pattern":"^(20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$","type":"string"}},"description":"Report business hours for data generating","$$ref":"#/components/schemas/ReportBusinessHours"},"emailRecipient":{"maxItems":5,"minItems":0,"type":"array","description":"Email address list to receive the report files","example":["alice@cisco.com","bob@google.com"],"items":{"type":"string","description":"Email address list to receive the report files","example":["alice@cisco.com","bob@google.com"]}},"fileType":{"type":"string","enum":["pdf","csv"]},"reportName":{"maxLength":32,"minLength":1,"pattern":"(?=^.{1,32}$)[^&\u003c\u003e! \"]+$","type":"string","description":"Report Name","example":"ExecutiveSummaryReport"},"scheduleConfig":{"required":["scheduleType"],"type":"object","properties":{"scheduleType":{"type":"string","description":"Schedule type","example":"on_demand","enum":["on_demand","reoccur_onetime","reoccur_daily","reoccur_weekly","reoccur_monthly"]}},"description":"schedule config","discriminator":{"propertyName":"scheduleType"},"oneOf":[{"$ref":"#/components/schemas/ScheduleConfig","required":["scheduleType"],"type":"object","description":"On-demand schedule","$$ref":"#/components/schemas/OnDemandSchedule"},{"$ref":"#/components/schemas/ScheduleConfig","properties":{"startTime":{"pattern":"^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01]) (20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$","type":"string","description":"startTime string format is yyyy-MM-dd HH:mm:ss,UTC timezone","example":"2022-07-01 14:30:00"}},"required":["scheduleType","startTime"],"type":"object","description":"One time schedule time config","$$ref":"#/components/schemas/OneTimeSchedule"},{"$ref":"#/components/schemas/ScheduleConfig","properties":{"startTime":{"pattern":"^(20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$","type":"string","description":"startTime string format is HH:mm:ss"}},"required":["scheduleType","startTime"],"type":"object","description":"Daily schedule time config","$$ref":"#/components/schemas/ReoccurDailySchedule"},{"$ref":"#/components/schemas/ScheduleConfig","properties":{"startTime":{"pattern":"^(20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$","type":"string","description":"startTime string format is HH:mm:ss","example":"20:30:10"},"dayOfWeek":{"maximum":7,"minimum":1,"type":"integer","description":"The day number of a week, mapping is as 1 - Sun, 2 - Mon, 3 - Tus, 4 - Wed, 5 - Thu, 6 - Fri, 7 - Sat","format":"int32","example":1}},"required":["dayOfWeek","scheduleType","startTime"],"type":"object","description":"Weekly schedule time config","$$ref":"#/components/schemas/ReoccurWeeklySchedule"},{"$ref":"#/components/schemas/ScheduleConfig","properties":{"startTime":{"pattern":"^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12][0-9]|3[01]) (20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$","type":"string","description":"startTime string format is (yyyy-MM-dd HH:mm:ss), time zone is UTC","example":"2022-07-01 20:30:10"}},"required":["scheduleType","startTime"],"type":"object","description":"Monthly schedule time config","$$ref":"#/components/schemas/ReoccurMonthlySchedule"}],"$$ref":"#/components/schemas/ScheduleConfig"},"siteIds":{"type":"array","description":"Filtering by Site ID list is optional, if no site Id is included, all site ID will be used for report generating.","example":[100,200],"items":{"type":"integer","format":"int64"}},"templateType":{"type":"string","enum":["executive_summary","site_availability","link_availability","link_utilization","link_sla","app_usage","ips_events_collected","firewall_enforcement","malware_files_collected","internet_browsing","license_management"]},"timeRange":{"type":"string","description":"Time range for report(one_week/one_month)","example":"one_week","enum":["one_day","one_week","one_month"]}},"description":"Executive summary report template","$$ref":"#/components/schemas/ExecutiveSummaryReport"}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"required":["activeStatus","createdBy","hasTask","lastUpdateTime","nextRunTime","onVmanage","reportConfig","reportId","reportStatus"],"type":"object","properties":{"activeStatus":{"type":"string","description":"Report active status(active,cancelled)","example":"active","enum":["active","cancelled"]},"createdBy":{"maxLength":64,"minLength":0,"type":"string","description":"user name for who created the report template.","example":"admin"},"debugInfo":{"type":"string"},"fileType":{"type":"string","enum":["pdf","csv"]},"hasTask":{"type":"boolean","description":"If the report template has running task records or not","example":true},"lastUpdateTime":{"type":"integer","description":"Report template last update timestamp","format":"int64","example":1655968207288},"needRunImmediately":{"type":"boolean"},"nextRunTime":{"type":"integer","description":"Report next running timestamp","format":"int64","example":1655991420000},"onVmanage":{"type":"string","description":"vManage which scheduled report generating tasks","example":"10.1.1.100"},"reportConfig":{"required":["emailRecipient","reportName","scheduleConfig"],"type":"object","properties":{"businessHours":{"required":["endTime","startTime"],"type":"object","properties":{"endTime":{"pattern":"^(20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$","type":"string"},"startTime":{"pattern":"^(20|21|22|23|[0-1]?\\d):[0-5]?\\d:[0-5]?\\d$","type":"string"}},"description":"Report business hours for data generating","$$ref":"#/components/schemas/ReportBusinessHours"},"emailRecipient":{"maxItems":5,"minItems":0,"type":"array","description":"Email address list to receive the report files","example":["alice@cisco.com","bob@google.com"],"items":{"type":"string","description":"Email address list to receive the report files","example":["alice@cisco.com","bob@google.com"]}},"fileType":{"type":"string","enum":["pdf","csv"]},"reportName":{"maxLength":32,"minLength":1,"pattern":"(?=^.{1,32}$)[^&\u003c\u003e! \"]+$","type":"string","description":"Report Name","example":"ExecutiveSummaryReport"},"scheduleConfig":{"required":["scheduleType"],"type":"object","properties":{"scheduleType":{"type":"string","description":"Schedule type","example":"on_demand","enum":["on_demand","reoccur_onetime","reoccur_daily","reoccur_weekly","reoccur_monthly"]}},"description":"schedule config","discriminator":{"propertyName":"scheduleType"},"oneOf":[{"$ref":"#/components/schemas/OnDemandSchedule"},{"$ref":"#/components/schemas/OneTimeSchedule"},{"$ref":"#/components/schemas/ReoccurDailySchedule"},{"$ref":"#/components/schemas/ReoccurWeeklySchedule"},{"$ref":"#/components/schemas/ReoccurMonthlySchedule"}],"$$ref":"#/components/schemas/ScheduleConfig"},"siteIds":{"type":"array","description":"Filtering by Site ID list is optional, if no site Id is included, all site ID will be used for report generating.","example":[100,200],"items":{"type":"integer","format":"int64"}},"templateType":{"type":"string","enum":["executive_summary","site_availability","link_availability","link_utilization","link_sla","app_usage","ips_events_collected","firewall_enforcement","malware_files_collected","internet_browsing","license_management"]},"timeRange":{"type":"string","description":"Time range for report(one_week/one_month)","example":"one_week","enum":["one_day","one_week","one_month"]}},"description":"Executive summary report template","$$ref":"#/components/schemas/ExecutiveSummaryReport"},"reportId":{"type":"string","description":"The report UUID for report template","format":"uuid","example":"50671437-c88e-4514-aafa-103e58c4d9cc"},"reportStatus":{"type":"string","description":"Report schedule status(not_scheduled/scheduled/in_progress/completed/failed))","example":"in_progress","enum":["not_scheduled","scheduled","in_progress","completed","failed"]},"taskNum":{"type":"integer","format":"int64"},"templateType":{"type":"string","enum":["executive_summary","site_availability","link_availability","link_utilization","link_sla","app_usage","ips_events_collected","firewall_enforcement","malware_files_collected","internet_browsing","license_management"]}},"description":"Report Template detail info","$$ref":"#/components/schemas/ReportInfo"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"required":["code","details","message"],"type":"object","properties":{"code":{"type":"string","description":"Error code associated with the error event"},"details":{"type":"string","description":"Error message details"},"message":{"type":"string","description":"Error message title"}},"description":"error message","$$ref":"#/components/schemas/Model400ErrorError"}},"$$ref":"#/components/schemas/Model400Error"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"method":"put","path":"/v1/reports/{reportId}"}}