ROrossum
Documents Download

Create download

Changed on

Create a new download object.

post/api/v1/documents/downloads

Request

Request body

documentsstring[]

Comma-separated list of document URLs to be included in the resulting downloadable archive. Max. 500 documents.

file_namestring

The filename of the resulting archive. Must include a .zip extension.

type'document' | 'source_document'

One of document and source_document. The source_document means that for each of the documents the most distant non-empty parent document is put into the download.

zipboolean

Use application/zip to bundle the download contents. The zip value of false is only applicable for single document downloads where the file_name if omitted in the request is taken from the document being downloaded.

Example request

{
  "documents": [
    "https://example.rossum.app/api/v1/documents/123000",
    "https://example.rossum.app/api/v1/documents/123001"
  ],
  "file_name": "monday_invoices.zip",
  "type": "document",
  "zip": true
}

Response

Accepted

urlstring uri

URL of the created task

Example response

{
  "url": "https://example.rossum.app/api/v1/tasks/1"
}

Changes

  • f1b5a910991dRevision changes
    • breaking

      added the new required request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request optional property became not read-only

    • info

      the request property default value documents.zip was added