update_report
Update an existing CData Arc report to change its metrics, filters, schedule, or email delivery. Define columns like TransactionsSent or TotalProcessingTime to get the exact data you need.
Instructions
Update an existing Arc report configuration. The Columns parameter is critical - include the metrics you want to see in the report (e.g., TransactionsSent, TransactionsReceived, TotalProcessingTime, TransactionsSuccess, TransactionsError).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Name of the report to update | |
| type | No | Type of report. Valid values: 'Connector', 'EDI' | |
| format | No | Report output format (e.g., 'PDF', 'CSV', 'Excel') | |
| columns | No | CRITICAL: Comma-separated list of metrics to include in the report. Valid values: WorkspaceId, ConnectorId, ConnectorType, TransactionsAll, TransactionsSent, TransactionsReceived, TotalProcessingTime, TotalFileSize, TransactionsSuccess, TransactionsError, TransactionsWarning. Always include relevant columns based on what the user is asking for. | |
| endDate | No | Schedule end date in ISO format (only used with schedule parameter). Example: 2025-11-04T00:00:00.000-05:00 | |
| filters | No | Filters to apply to the report. Use ConnectorType (e.g., 'AS2', 'SFTP', 'FTP') and/or ConnectorId. Example: 'ConnectorType=AS2' or 'ConnectorType=SFTP,FTP;ConnectorId=SFTP1,SFTP2' | |
| summary | No | Summary statistics to include. Valid values: Total, Average, Minimum, Maximum | |
| schedule | No | Cron expression for automated report scheduling. Format: 'minute hour day month dayOfWeek'. Example: '30 15 1 * *' runs on the 1st of each month at 15:30 | |
| groupRows | No | Comma-separated list of dimensions to group the report by. Valid values: Year, Quarter, Month, Week, WorkspaceId, ConnectorType | |
| startDate | No | Schedule start date in ISO format (only used with schedule parameter). Example: 2025-11-04T00:00:00.000-05:00 | |
| timePeriod | No | Time period for the report. Valid values: 'All', 'LastMonth', 'Last3Months', 'Last6Months', 'Last12Months', 'MonthToDate', 'QuarterToDate', 'YearToDate', 'SinceLastRun', 'Custom' (if using Custom, also set timePeriodStart and timePeriodEnd in format: 2025-11-04T00:00:00.000-05:00) | |
| emailReport | No | Whether to send the report via email | |
| emailSubject | No | Email subject line (only used if emailReport is true) | |
| timePeriodEnd | No | Custom time period end date in ISO format (only used when timePeriod is 'Custom'). Format: 2025-11-04T00:00:00.000-05:00 | |
| emailRecipients | No | Comma-separated list of email recipients (only used if emailReport is true) | |
| timePeriodStart | No | Custom time period start date in ISO format (only used when timePeriod is 'Custom'). Format: 2025-11-04T00:00:00.000-05:00 |