Skip to main content

DownloadLink

A secure link to download a page of content.

type DownloadLink {
  byteSize: Float
  displayFilename: String
  downloadUrl: String!
  expires: String!
  ordinal: Int
  requestHeaders: JSONObject!
  rowCount: Int
  status: ReportFileStatus
  totalFiles: Int
}

Fields​

DownloadLink.byteSize ● Float scalar​

The size of the file in bytes as it is downloaded, a whole number. Null means unknown; it is never 0 as a stand-in.

DownloadLink.displayFilename ● String scalar​

The name to show for the file. Null when it was not recorded, which is the case for reports generated before per-file details were stored.

DownloadLink.downloadUrl ● String! non-null scalar​

The URL string that should be used to retrieve the content

DownloadLink.expires ● String! non-null scalar​

The date and time that this download link will expire in ISO 8601 format.

DownloadLink.ordinal ● Int scalar​

The 1-based position of the file this link downloads within the report. It is the page number that selects it.

DownloadLink.requestHeaders ● JSONObject! non-null scalar​

These are request headers, where the keys are the header names and the values the header values, that MUST be passed along when GETting files with the downloadUrl. Note these headers may contain decryption keys to use when pulling down content and thus should be considered sensitive.

DownloadLink.rowCount ● Int scalar​

The number of data rows in the file, not counting the header. Null means unknown; it is never 0 as a stand-in.

DownloadLink.status ● ReportFileStatus enum​

Whether the file can be downloaded right now. A file with a link here is AVAILABLE.

DownloadLink.totalFiles ● Int scalar​

How many files the report has in total. Fewer links than this means some files have none; see Report.files.

Member Of​

Report object ● TaxFormDownloadLinkResult object