Tasks

PreviousUsers NextKey Value

Last updated 26 days ago

Was this helpful?

Get task status

get

Authorizations

Path parameters

operationIdstringRequired

Responses

200

The task status has been successfully retrieved.

application/json

get

GET /sfp/api/tasks/{operationId}/status HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

200

The task status has been successfully retrieved.

{
  "status": "completed",
  "progress": 100,
  "error": {
    "message": "Operation failed",
    "stack": "Error stack trace"
  }
}

Get task result

get

Authorizations

Path parameters

operationIdstringRequired

Responses

200

The task result has been successfully retrieved.

application/json

get

GET /sfp/api/tasks/{operationId}/result HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

200

The task result has been successfully retrieved.

{
  "status": "completed",
  "progress": 100,
  "error": {
    "message": "Operation failed",
    "stack": "Error stack trace"
  },
  "result": {
    "data": "example result"
  }
}

Cancel a task

delete

Authorizations

Path parameters

operationIdstringRequired

Responses

200

The task has been successfully cancelled.

application/json

delete

DELETE /sfp/api/tasks/{operationId} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

200

The task has been successfully cancelled.

{
  "message": "Task cancelled successfully"
}

Stop a recurring task

post

Stops a recurring task and prevents any future executions. Does not affect already completed executions.

Authorizations

Path parameters

operationIdstringRequired

The ID of the recurring task to stop

Example: 123e4567-e89b-12d3-a456-426614174000

Responses

200

The recurring task has been stopped successfully.

application/json

400

Task is already stopped or completed

404

Task not found or is not a recurring task

post

POST /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"
}

Get all instances of a recurring task

get

Authorizations

Path parameters

operationIdstringRequired

Responses

200

List of all instances of the recurring task

application/json

get

GET /sfp/api/tasks/{operationId}/recurring-instances HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

200

List of all instances of the recurring task

[
  {
    "status": "completed",
    "progress": 100,
    "error": {
      "message": "Operation failed",
      "stack": "Error stack trace"
    },
    "result": {
      "data": "example result"
    }
  }
]

Submit a new task

post

Authorizations

Body

typestring · enumRequired

The type of task to be executed

Example: fetchReviewEnvironmentPossible values:

dataobjectRequired

The data required for the task

Example:

{"value":{"repoId":"repo123","directory":"/path/to/dir","username":"user@devhub.ocom","pool":"core","pooltype":"sandbox","branch":"feature/123","issue":"ISSUE-123","wait":300,"leasefor":3600},"description":"Fetch a review environment"}

lockDurationnumberOptional

Lock duration in milliseconds (default: 300000 - 5 minutes)

Example: 300000

prioritystring · enumRequired

Type of task priority

Default: lowPossible values:

scheduleTypestring · enumRequired

Type of task scheduling

Default: immediatePossible values:

scheduledForstringOptional

Scheduled execution time for one-time scheduled tasks

Example: 2024-10-27T10:00:00Z

retryConfigall ofOptional

Retry configuration for this task

recurrenceConfigall ofOptional

Configuration for recurring tasks

Responses

201

The task has been successfully created.

application/json

post

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": "user@devhub.com",
    "pool": "core",
    "pooltype": "sandbox",
    "branch": "feature/123",
    "issue": "ISSUE-123",
    "wait": 300,
    "leasefor": 3600
  }
}

201

The task has been successfully created.

{
  "operationId": "1234567890",
  "type": "listAssignedReviewEnvironments"
}