GetBackgroundTaskResult - GET
|
Path |
/api/projects/{projectId}/tasks/{taskId}/result |
|---|---|
|
Http Method |
GET |
Overview
When a background task generates a result, it is saved as two things:
-
A blob of bytes. Which can be anything.
-
A Content-Type. Which helps the receiving browser handle it.
The actual contents and format of the result depend on the type of task. See GetBackgroundTask API call.
For organisation purposes, the contents and Content-Typeof the resulting objects of the various task types will be documented on the actual asynchronous API calls that generate a task.
Background tasks operate with the access rights of the user that created them. Task ids should therefore not be shared as they could leak information other people may not have access to. Tasks results remain available for 1 hour.
Required permissions
None
Request
|
Parameter |
Type |
Required |
Description |
Example |
|---|---|---|---|---|
|
taskId |
string |
Yes |
The id of the task, generated by the app on task creation. |
|
Response
Success response (200 OK)
The blob that is the result of the task. The Content-Type HTTP header will be set to the relevant file type. For example, if a background task generated a PNG, image/png would be used, and the body would be the actual image bytes.