Get a download request

Poll the status of a download request by id. While processing, status is accepted. When status is completed, the response includes a presigned url to the CSV result (valid for 5 minutes). On failure, status is failed and error is populated.

GET /v1/downloads/{id}

Get a download request

cURL

curl --request GET \
  --url https://devx.{tenant}.oleria.io/v1/downloads/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "error": {
    "code": "<string>",
    "message": "<string>"
  },
  "url": "<string>"
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id · string<uuid> · required

ID in UUID format for a download request

Response

200

application/json

Download request found successfully

Tracks the status of a download request

id · string<uuid> · required

status · enum<string> · required

Available options: accepted, completed, failed

error · object

Show child attributes

url · string

A presigned URL to the S3 object containing the result data, valid for 5 minutes