This documentation is currently under development. Certain sections are not yet complete and will be added shortly.
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Scheduler Management

Reset a scheduled task's internal state

post
/api/{tenantId}/scheduler/{taskId}/reset

Rebuilds the scheduler's internal state for a single task from source-of-truth. The concrete action dispatches on the task's trigger type:

  • DateRelative: deletes all pending-trigger rows for the task, then enqueues the dateRelative.backfill scheduler task which asynchronously rescans passes and rewrites rows. Client returns immediately after the enqueue; watch the executions endpoint for the backfill's progress via the returned correlationId.

  • Recurrence / FixedDate: no-op in this release (reset semantics for these are not yet implemented). The response reports no-op-not-implemented.

Safe to call repeatedly — enqueue uses a deterministic correlation id per (tenant, task).

Authorization

Requires Scheduler.Manage scope.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2implicitRequired
Authorization URL:
Path parameters
taskIdstringRequired

Id of the scheduled task (as declared in scheduler.yml).

tenantIdstringRequired
Responses
200

Reset accepted and dispatched

Result of a task reset operation.

taskIdstringRequired

Task id that was reset.

triggerTypestringRequired

Trigger discriminator, e.g. dateRelative, recurrence, fixedDate.

actionstringRequired

Short summary of what happened, e.g. backfill-enqueued, no-op-not-implemented.

rowsDeletedinteger · nullableOptional

Number of pending-trigger rows deleted prior to backfill. null when the trigger type has no rows.

correlationIdstring · nullableOptional

Correlation id of the enqueued backfill task, if any. Support can trace this in the executions endpoint.

post/api/{tenantId}/scheduler/{taskId}/reset

Last updated