OMomni
App downloads

Get app download file

Changed on

Stream the finished file for an app download job. Poll Get app download status until status is complete first. Finished files are retained for about a day.

get/v1/apps/{documentId}/download/{jobId}

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/apps/{documentId}/download/{jobId}
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

documentIdstring required
Example:12db1a0a

The document's URL slug (e.g. abc123) or its canonical workbook UUID.

jobIdstring uuid required
Example:123e4567-e89b-12d3-a456-426614174000

The job ID returned by Initiate app download.

Query parameters

userIdstring uuid

Organization API key required. The membership ID of the user to act as.

Response

The file, streamed, with Content-Type, Content-Length, and Content-Disposition: attachment set.

The Content-Type indicates the format of the download:

FormatContent-TypeExtension
pngimage/png.png
pdfapplication/pdf.pdf
xlsxapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheet.xlsx
csvapplication/zip (one CSV per query).zip

Changes