ROrossum
Documents Download

Retrieve download

Changed on

Get a download object.

get/api/v1/documents/downloads/{documentsDownloadID}

Request

Path parameters

documentsDownloadIDinteger required

A unique integer value identifying this documents download.

Response

OK

idinteger required

ID of the download object

urlstring uri required

URL of the download object

file_namestring required

Name of the archive to be downloaded.

expires_atstring date-time required

Timestamp of a guaranteed availability of the download object and its content. Set to the archive creation time plus 2 hours. Expired downloads are being deleted periodically.

contentstring uri nullable required

Link to the download's raw content. May be null if there is no archive associated yet.

Example response

{
  "id": 105,
  "url": "https://example.rossum.app/api/v1/documents/456700",
  "file_name": "test_invoice_1.pdf",
  "expires_at": "2023-09-13T23:04:00.933658Z",
  "content": "https://example.rossum.app/api/v1/documents/downloads/105/content"
}

Changes

  • f1b5a910991dRevision changes
    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status