Create and Maintain Single-Report Schedules
Create, inspect, clone, update, enable, disable, and delete single-report schedules.
Before you begin
Authenticate with the CRD API. See Authentication and Token Management. Use Discover Folders and Schedules to identify the relevant folder and schedule context.
Use the operation reference for each request and response schema. Schedule identifiers, execution identifiers, and process identifiers serve different purposes; use the identifier required by each operation.
Create and inspect a schedule
- Create a single-report schedule with CreateSingleReport. Supply the fields required by its request schema.
- Retrieve the schedule with Get or list schedules with GetAll.
- Clone an existing schedule with Clone when you need a separate schedule based on it. Follow the clone response and use its documented identifier.
Update schedule settings
Use the specific operation that matches the change:
- Update a parameter with UpdateParameter.
- Add, update, or delete an email destination with the corresponding AddEmailDestination, UpdateEmailDestination, or DeleteEmailDestination operation.
- Change the schedule name with RenameSchedule.
- Turn scheduling on or off with EnableSchedule or DisableSchedule.
These operations have distinct request schemas. Do not assume one update operation changes fields owned by another operation. Check the response documented for each call.
Delete a schedule
Use Delete with the identifier and parameters in its reference. Confirm the returned response before treating the schedule as removed.
Check execution status
Use GetExecutionStatus to retrieve execution status when needed. For the broader run-and-monitor workflow, see Quick Start: Execute and Monitor a Schedule.
For exact paths, methods, required fields, and response codes, use the linked API operation references.
Updated about 13 hours ago