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

Get execution history for scheduled task

get
/api/{tenantId}/scheduler/{taskId}/executions

Returns recent execution history for a scheduled background task, including success/failure status and retry information.

Authorization

Requires Scheduler.History scope.

Use Cases

  • Task monitoring dashboards

  • Failure investigation

  • Performance analysis

  • Retry pattern verification

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

Execution history retrieved successfully

or
or
get/api/{tenantId}/scheduler/{taskId}/executions

Retrieve a specific scheduler execution with its associated logs.

get
/api/{tenantId}/scheduler/{taskId}/executions/{executionId}

Returns comprehensive execution details including all trace and dependency logs collected from Application Insights. Useful for debugging scheduled task issues and monitoring execution performance.

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

CorrelationId of the scheduled task.

executionIdstringRequired

Execution Id reported by Application Insights.

tenantIdstringRequired
Responses
200

Execution details with logs retrieved successfully

idstringRequired
startDatestring · date-timeRequired
retryIndexinteger · int32Required
successboolean · nullableRequired
durationstring · nullableRequired
get/api/{tenantId}/scheduler/{taskId}/executions/{executionId}

List recent scheduler executions for the tenant

get
/api/{tenantId}/scheduler/executions

Returns the most recent scheduler task executions across all configured tasks for the tenant. Useful to monitor scheduler health, spot failing tasks and drill into individual executions.

Sorting: By startDate, taskId, taskType, duration, or retryIndex.

Pagination: Zero-based pageIndex and pageSize. Total count in x-pagination-total header.

Authorization

Requires Scheduler.History scope.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2implicitRequired
Authorization URL:
Path parameters
tenantIdstringRequired
Query parameters
pageIndexinteger · int32Optional

Zero-based page index.

Default: 0
pageSizeinteger · int32Optional

Number of executions per page.

Default: 20
Responses
200

Execution list retrieved successfully

idstringRequired
startDatestring · date-timeRequired
retryIndexinteger · int32Required
successboolean · nullableRequired
durationstring · nullableRequired
taskIdstringRequired

Identifier of the scheduled task (as declared in scheduler.yml), extracted from the CorrelationId.

taskTypestring · nullableRequired

Task type (handler) reported by the scheduler telemetry.

get/api/{tenantId}/scheduler/executions

Last updated