upload_prepare#

Autogenerated API

argus_api.lib.documents.v1.upload.upload_prepare.add_document_fragment(documentID: int, idx: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Upload next fragment of data to a prepared document.Fragments MUST be uploaded in order, first fragment with index 0. (PUBLIC)

Parameters

  • documentID (int) – Document ID (as returned from the prepare endpoint)

  • idx (int) – Fragment index

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • 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

  • body – body of the request. other parameters will override keys defined in the body.

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

Raises
Returns

dictionary translated from JSON

argus_api.lib.documents.v1.upload.upload_prepare.complete_document_upload(documentID: int, sha256: str = None, notificationOptions: dict = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Finalize upload of document.Completion request must specify correct checksum and document size. (PUBLIC)

Parameters

  • documentID (int) – Document ID (as returned from the prepare endpoint)

  • sha256 (str) – The sha256 of the entire document.

  • notificationOptions (dict) –

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • 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

  • body – body of the request. other parameters will override keys defined in the body.

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

Raises
Returns

dictionary translated from JSON

argus_api.lib.documents.v1.upload.upload_prepare.disard_document_upload(documentID: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

DEPRECATED : disard_document_upload is an alias for discard_document_upload. Exists only for backward compatibility - do not use - use discard_document_upload instead.

argus_api.lib.documents.v1.upload.upload_prepare.discard_document_upload(documentID: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Abort and discard fragmented upload. (PUBLIC)

Parameters

  • documentID (int) – Document ID (as returned from the prepare endpoint)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • 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

  • body – body of the request. other parameters will override keys defined in the body.

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

Raises
Returns

dictionary translated from JSON

argus_api.lib.documents.v1.upload.upload_prepare.prepare_upload(parentFolderID: int = None, name: str = None, mimeType: str = None, accessMode: str = None, overwriteExisting: bool = None, lockRequestTime: int = None, inheritExplicitPermissions: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Prepare upload of a new document (PUBLIC)

Parameters

  • parentFolderID (int) – The ID of the parent folder to upload into

  • name (str) – Name of new document => Sanitize by regex A[^\\/:*”’?<>|]{1,254}z

  • mimeType (str) – MIME type of document content

  • accessMode (str) – General access mode of new document (default roleBased)

  • overwriteExisting (bool) – If true, overwrite existing document with same name in parent folder, as a new revision.

  • lockRequestTime (int) – Specify how long the document should be locked (default 0)

  • inheritExplicitPermissions (bool) – Inherit explicit permissions from parent folder (default false)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • 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

  • body – body of the request. other parameters will override keys defined in the body.

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

Raises
Returns

dictionary translated from JSON