Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get background task result

GET /tasks/{id}

Returns result of an asynchronous operation, e.g. database service configuration.

Path parameters

Parameter Type & Description
id required
string

The requested task Id.

Request Examples

Shell
onepanel-rest-cli -u onepanel:$PASSPHRASE getTaskStatus id=$TASK_ID --host https://$HOST:9443

Responses

application/json
200

The requested task status.

PropertyType & Description
status
string

The operation status.

Enum:
okerrorrunning
steps
array of strings

The list of operation steps that have been executed successfully.

totalSteps
integer

Total number of steps to be executed.

error
object (Error)

The generic error model for REST requests.

error required
object

Object describing an error.

id required
string

String identifying the error type. Does not change between error instances.

description required
string

Human readable error description. May contain information specific to given error instance.

details
object

Details about the error instance. The object schema is specific to each error type.

Example

application/json
{
  "status": "running",
  "steps": [
    "configuring"
  ],
  "totalSteps": 3
}
401

Unauthorized request.

403

Forbidden request.

404

The task does not exist.

500

Internal server error.

PropertyType & Description
error
object

Object describing an error.

id required
string

String identifying the error type. Does not change between error instances.

description required
string

Human readable error description. May contain information specific to given error instance.

details
object

Details about the error instance. The object schema is specific to each error type.

Example

application/json
{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}