STstackone
Files

Download File

Changed on
get/unified/documents/files/{id}/download

Request

  • Base URL
    https://api.stackone.com
  • URL
    https://api.stackone.com/unified/documents/files/{id}/download
  • Auth
    HTTP basic

Path parameters

idstring required

Query parameters

formatstring nullable
Example:base64

The format to download the file in

export_formatstring nullable
Example:text/plain

The export format of the file

Headers

x-account-idstring required

The account identifier

x-stackone-api-session-tokenstring

The session token

Response

The file with the given identifiers was retrieved.

datastring binary required

The file data in binary format

Example response

{
  "headers": {
    "content-disposition": "attachment; filename=\"example.pdf\"",
    "content-type": "application/pdf",
    "content-length": 1024,
    "content-range": "bytes 0-1023/2048",
    "content-encoding": "gzip",
    "transfer-encoding": "chunked"
  }
}

Changes

  • e66c4796163bRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

  • 8037b5276a45Revision changes
    • breaking

      the response's property type changed from no type to object for status