circle-exclamation
This documentation is currently under development. Certain sections are not yet complete and will be added shortly.

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.

Task Identification

Tasks are identified by correlationId. Supports wildcard matching:

  • nightly-sync - Exact match

  • nightly-* - Prefix match (all tasks starting with "nightly-")

Use Cases

  • Task monitoring dashboards

  • Failure investigation

  • Performance analysis

  • Retry pattern verification

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
Authorizations
OAuth2implicitRequired
Authorization URL:
Path parameters
taskIdstringRequired

CorrelationId of the scheduled task (supports a trailing * wildcard).

tenantIdstringRequired
Responses
chevron-right
200

Execution history retrieved successfully

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.

chevron-right
lockRequired 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
chevron-right
200

Execution details with logs retrieved successfully

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

Last updated