read_jobs
Monitor and manage data replication jobs in CData Sync. Retrieve job configurations, check status, view execution history, and access logs for troubleshooting synchronization processes.
Instructions
Access and monitor data replication jobs that move data from source to destination.
RETURNS:
list: Array of job objects with name, status, and configuration
get: Full job configuration details
status: Current execution state and progress
history: Past execution records
logs: Detailed execution logs for debugging
COMMON ERRORS:
"Job not found" - Verify job name/ID
"No logs available" - Check log retention settings
"Access denied" - Verify user permissions
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| action | No | Operation: list all, get config, check status, view history, or download logs. For counts, use 'list' and count results client-side. | list |
| jobName | No | Job name (required for get/status/logs). Use descriptive names like 'Daily_Sales_Sync'. Case-sensitive. | |
| jobId | No | Alternative to jobName - use the UUID job identifier for status/logs | |
| filter | No | OData filter expression. SUPPORTED: eq, ne, gt, lt, ge, le, and, or LIMITED SUPPORT: contains(), startswith() NOT SUPPORTED: nested queries, computed properties Example: "Status eq 'Running' and Source eq 'MySQL'" | |
| select | No | Properties to include (e.g., 'JobName,Status,Source,Destination') | |
| top | No | Maximum results to return | |
| skip | No | Results to skip for pagination | |
| orderby | No | Sort order for history (e.g., 'RunStartDate desc') | |
| days | No | Number of days of logs to retrieve (default: 1, max depends on retention) | |
| pushOnQuery | No | Include detailed query status (default: true) | |
| workspaceId | No | Workspace ID to use for this operation. Overrides the default workspace. Use 'default' for the default workspace or a UUID for specific workspaces. |