The Task API provides a standardized way to manage and track long-running or background operations in the Marketplace Platform.
A task represents an operation that may take some time, has progress, task logs, and a result. With this API, you can:
- Create a new task, for example, to start a buyer transfer.
- Update progress, ETA, and parameters within a task. Only the owner service or extension can update a task.
- Get task results, which may include a
JSONresult or redirect to a resource if the result is a file. - Transition the task status to
queued,processing,completed,rescheduled, orfailed. - Get detailed logs containing additional information regarding task execution.
Review the shared API docs before you work with task resources.
The Task API is built around the following core resources:
- Task – Represents the state of an asynchronous, usually long-running operation.
- Task log – Represents additional information regarding the execution of the task.
The API is organized into collections, each containing a set of operations. Access to these operations varies by role, depending on whether you are a client, vendor, or operations user.
See the following sections to determine which roles are authorized to perform specific operations within each collection:
| Operation | Method | Description | Access |
|---|---|---|---|
| Create task | POST | Creates a task. | svc |
| List tasks | GET | Gets a list of tasks. | ops, svc, vendor, client |
| Get task by id | GET | Gets a task by id. | ops, svc, vendor, client |
| Get task result | GET | Redirects to a platform resource or returns a result JSON value. | ops, svc, vendor, client |
| Operation | Method | Description | Access |
|---|---|---|---|
| Get task logs | GET | Gets the log records for a task. | ops, svc |