download

argus_api.files.documents.download.download_document(document: Union[str, int], destination_file: Optional[Union[str, pathlib.Path]] = None, customer: Optional[Union[str, int]] = None, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, api_session: Optional[ArgusAPISession] = None) → bytes

Download a document.

returns the content of the document as bytes. If destination_path is set to a path, the sample will be written to the file at that location.

Parameters

• document – path or ID of the document to download. If an ID is provided, it must be passend as an int.

• destination_file – if set, write the document to the file at the path this points to.

• customer – ID or shortname of the customer whose space the document will be downloaded from. Ignored if the destnation folder is provided as an ID, otherwise defaults to the current user’s customer.

• verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

• apiKey – Argus API key.

• authentication – authentication override

• server_url – API base URL override

• api_session – session to use for this request. If not set, the global session will be used.

Raises

• AuthenticationFailedException – on 401

• AccessDeniedException – on 403

• ParentFolderNotFoundException – on 404

• ValidationFailedException – on 412

• ArgusException – on other status codes

Returns

dictionary translated from JSON