Downloads

Get the DownloadRequest

If you have the specific download request ID, this endpoint allows you to retrieve detailed information about the download request.

get/plug/downloads/{downloadRequestWebhookId}

Request

  • Base URL: https://api.arcadia.com
  • URL: https://api.arcadia.com/plug/downloads/{downloadRequestWebhookId}
  • Auth: OAuth 2 (client credentials, token URL /oauth2/token)

Path parameters

downloadRequestWebhookIdstring required

Create the input for this field by appending the token from the response of the first step to the end of the downloadId without any space

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Response

OK

createdAtstring date-time required

A timestamp indicating when the entity was created.

downloadMethod'EMAIL' | 'IN_BROWSER' required

Method used for downloading data.

idstring required

A unique identifier for the entity.

status'SUCCESS' | 'PREPARING' | 'FAILURE' | 'NO_CONTENT' required

Status of the resource.

tokenstring required

We require this token to be provided when you want to access the requested download file. If you made the request via an API call, this token can be found in our response to you. If you made the request via the Dashboard, this token already be included in the email we would send you.

Changes

No recorded changes to this operation across all 1 revision of this API.