Tasks
Retrieves the current status of a task including progress percentage, current step, and completion status. Use this endpoint to poll for task completion. Status values include: pending, active, completed, failed, cancelled.
GET /sfp/api/tasks/{operationId}/status HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
The task status has been successfully retrieved.
{
"status": "completed",
"progress": 100,
"error": {
"message": "Operation failed",
"stack": "Error stack trace"
}
}Retrieves the final result of a completed task. Returns error details if the task failed. Results are retained for a limited time after completion. For recurring tasks, this returns the result of the most recent execution.
GET /sfp/api/tasks/{operationId}/result HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
The task result has been successfully retrieved.
{
"status": "completed",
"progress": 100,
"error": {
"message": "Operation failed",
"stack": "Error stack trace"
},
"result": {
"data": "example result"
}
}Cancels a pending or active task. Completed tasks cannot be cancelled. For recurring tasks, this cancels the current execution but does not prevent future executions - use stop-recurring endpoint instead. Cancellation may not be immediate for actively running tasks.
DELETE /sfp/api/tasks/{operationId} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
The task has been successfully cancelled.
{
"message": "Task cancelled successfully"
}Submits a new task for asynchronous execution. Tasks can be one-time, delayed, or recurring. Supported task types include review environment operations (fetch, check, transition, list, unassign). Returns an operation ID that can be used to track task progress and retrieve results.
The type of task to be executed
fetchReviewEnvironmentPossible values: The data required for the task
{"value":{"repoId":"repo123","directory":"/path/to/dir","username":"[email protected]","pool":"core","pooltype":"sandbox","branch":"feature/123","issue":"ISSUE-123","wait":300,"leasefor":3600},"description":"Fetch a review environment"}Lock duration in milliseconds (default: 300000 - 5 minutes)
300000Type of task priority
lowPossible values: Type of task scheduling
immediatePossible values: Scheduled execution time for one-time scheduled tasks
2024-10-27T10:00:00ZRetry configuration for this task
Configuration for recurring tasks
POST /sfp/api/tasks HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 222
{
"type": "fetchReviewEnvironment",
"data": {
"repoId": "repo123",
"directory": "/path/to/dir",
"username": "[email protected]",
"pool": "core",
"pooltype": "sandbox",
"branch": "feature/123",
"issue": "ISSUE-123",
"wait": 300,
"leasefor": 3600
}
}The task has been successfully created.
{
"operationId": "1234567890",
"type": "listAssignedReviewEnvironments"
}Stops a recurring task and prevents any future executions. Does not affect already completed executions.
The ID of the recurring task to stop
123e4567-e89b-12d3-a456-426614174000POST /sfp/api/tasks/{operationId}/stop-recurring HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"message": "Recurring task stopped successfully",
"operationId": "123e4567-e89b-12d3-a456-426614174000",
"stoppedAt": "2024-10-26T21:43:47.000Z",
"totalExecutions": 10,
"lastExecutionAt": "2024-10-26T21:43:47.000Z",
"originalEndDate": "2024-12-31T23:59:59.000Z"
}Retrieves execution history for a recurring task including all past instances. Each instance shows its execution time, status, and result. Useful for monitoring recurring task performance and debugging issues. Returns empty array for non-recurring tasks.
GET /sfp/api/tasks/{operationId}/recurring-instances HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
List of all instances of the recurring task
[
{
"status": "completed",
"progress": 100,
"error": {
"message": "Operation failed",
"stack": "Error stack trace"
},
"result": {
"data": "example result"
}
}
]Last updated