document#

Autogenerated API

argus_api.lib.documents.v1.document.add_document_by_path_raw(parentFolderPath: str, documentName: str, customer: str = None, accessMode: str = 'roleBased', createMissing: bool = None, overwriteExisting: bool = None, skipNotification: 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#

Create a new document with the specified name into the parent folder (PUBLIC)

Parameters

  • parentFolderPath (str) – Path from customer root to the parent folder (if not specified, add the folder in the root folder)

  • documentName (str) – Document name

  • customer (str) – Customer space to fetch from (default is current users customer

  • accessMode (str) – Access mode to set on new document

  • createMissing (bool) – If true, create any missing folders before adding document

  • overwriteExisting (bool) – If true, overwrite existing document with the same name

  • skipNotification (bool) – If true, skip notification to folder watchers

  • 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.document.add_document_watcher(documentID: int, subjectDomain: str = None, subject: str = None, negated: 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#

Add watcher to specified document. Requires write access to the document. (PUBLIC)

Parameters

  • documentID (int) – ID of document

  • subjectDomain (str) – Domain to resolve subject shortname in. Defaults to current users domain.

  • subject (str) – ID or shortname of subject to add as watcher.

  • negated (bool) – If true, register an explicitly negated watcher entry. Default is to add a new active watcher. (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

argus_api.lib.documents.v1.document.add_document_watcher_by_path(parentFolderPath: str, documentName: str, customer: str = None, subjectDomain: str = None, subject: str = None, negated: 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#

Add watcher to specified document. Requires write access to the document. (PUBLIC)

Parameters

  • parentFolderPath (str) – Path to parent folder (if not specified, select document from root folder)

  • documentName (str) – Document name

  • customer (str) – Customer space to lookup folder in (default is current users customer)

  • subjectDomain (str) – Domain to resolve subject shortname in. Defaults to current users domain.

  • subject (str) – ID or shortname of subject to add as watcher.

  • negated (bool) – If true, register an explicitly negated watcher entry. Default is to add a new active watcher. (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

argus_api.lib.documents.v1.document.commit_document(documentID: int, name: str = None, mimeType: str = None, data: str = None, notificationOptions: dict = None, text: str = None, lockRequestTime: int = 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#

Commit specified document (PUBLIC)

Parameters

  • documentID (int) – ID of document to commit

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

  • mimeType (str) – If set change document MIME type

  • data (str) – Base64 encoded document content formatted according to the given MIME type. If set change document content

  • notificationOptions (dict) –

  • text (str) – Plain text document content. If set change document content

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

  • 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.document.delete_document(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#

Discard specified document (PUBLIC)

Parameters

  • documentID (int) – ID of document to discard

  • 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.document.delete_document_by_path(parentFolderPath: str, documentName: str, customer: str = 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#

Discard specified document (PUBLIC)

Parameters

  • parentFolderPath (str) – Path from customer root to the parent folder (if not specified, fetch document from root folder)

  • documentName (str) – Document name

  • customer (str) – Customer space to fetch from (default is current users customer

  • 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.document.delete_document_watcher(documentID: int, entryID: str, 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#

Delete watcher entry on document. Requires write access to document. (PUBLIC)

Parameters

  • documentID (int) – ID of document

  • entryID (str) – ID of watcher entry

  • 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.document.delete_document_watcher_by_path(parentFolderPath: str, documentName: str, entryID: str, customer: str = 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#

Delete watcher entry on document. Requires write access to document. (PUBLIC)

Parameters

  • parentFolderPath (str) – Path to parent folder (if not specified, select document from root folder)

  • documentName (str) – Document name

  • entryID (str) – ID of watcher entry

  • customer (str) – Customer space to lookup folder in (default is current users customer)

  • 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.document.get_current_user_document_watch_status(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#

Get current user watcher status for document (PUBLIC)

Parameters

  • documentID (int) – ID of document

  • 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.document.get_current_user_document_watch_status_by_path(parentFolderPath: str, documentName: str, customer: str = 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#

Get current user watcher status for document (PUBLIC)

Parameters

  • parentFolderPath (str) – Path to parent folder (if not specified, select document from root folder)

  • documentName (str) – Document name

  • customer (str) – Customer space to lookup folder in (default is current users customer)

  • 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.document.get_document_content_by_id(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) → requests.models.Response#

Download content as a file for specified document (PUBLIC)

Parameters

  • documentID (int) – ID of document to fetch

  • 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

requests.Response object

argus_api.lib.documents.v1.document.get_document_content_by_path(parentFolderPath: str, documentName: str, customer: str = 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#

Download content as a file for specified document (PUBLIC)

Parameters

  • parentFolderPath (str) – Path from customer root to the parent folder (if not specified, fetch document from root folder)

  • documentName (str) – Document name

  • customer (str) – Customer space to fetch from (default is current users customer

  • 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.document.get_document_revisions(documentID: int, limit: int = 25, offset: int = 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#

Fetch specified document revisions (PUBLIC)

Parameters

  • documentID (int) – ID of document to fetch revisions

  • limit (int) – Maximum number of returned results

  • offset (int) – Skip a number of results

  • 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.document.get_meta_info_by_id(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#

Fetch specified document excluding content (PUBLIC)

Parameters

  • documentID (int) – ID of document to fetch

  • 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.document.get_meta_info_by_path(parentFolderPath: str, documentName: str, customer: str = 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#

Fetch specified document meta data (PUBLIC)

Parameters

  • parentFolderPath (str) – Path from customer root to the parent folder (if not specified, fetch document from root folder)

  • documentName (str) – Document name

  • customer (str) – Customer space to fetch from (default is current users customer

  • 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.document.grant_document_access(documentID: int, subject: str = None, level: str = 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#

Grant access to specified document (PUBLIC)

Parameters

  • documentID (int) – Document ID

  • subject (str) – Specify user/group to grant access to

  • level (str) – Specify access level to grant to user/group

  • 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.document.grant_document_access_by_path(parentFolderPath: str, documentName: str, customer: str = None, subject: str = None, level: str = 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#

Grant access to specified document (PUBLIC)

Parameters

  • parentFolderPath (str) – Path from customer root (if not specified, this returns the root)

  • documentName (str) – Document name

  • customer (str) – Customer space to fetch from (default is current users customer)

  • subject (str) – Specify user/group to grant access to

  • level (str) – Specify access level to grant to user/group

  • 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.document.list_document_access(documentID: int, limit: int = 25, offset: int = 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#

Fetch ACL for specified document (PUBLIC)

Parameters

  • documentID (int) – Document ID

  • limit (int) – Maximum number of returned results

  • offset (int) – Skip a number of results

  • 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.document.list_document_access_by_path(parentFolderPath: str, documentName: str, customer: str = None, limit: int = 25, offset: int = 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#

Fetch ACL for specified document (PUBLIC)

Parameters

  • parentFolderPath (str) – Path from customer root (if not specified, this returns the root)

  • documentName (str) – Document name

  • customer (str) – Customer space to fetch from (default is current users customer)

  • limit (int) – Maximum number of returned results

  • offset (int) – Skip a number of results

  • 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.document.list_document_watchers(documentID: int, offset: int = None, includeNegated: bool = None, includeDeleted: bool = None, limit: int = 25, includeInherited: bool = True, 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 : list_document_watchers is an alias for list_document_watchers_by_id. Exists only for backward compatibility - do not use - use list_document_watchers_by_id instead.

argus_api.lib.documents.v1.document.list_document_watchers_by_id(documentID: int, offset: int = None, includeNegated: bool = None, includeDeleted: bool = None, limit: int = 25, includeInherited: bool = True, 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#

Get all watchers for document (PUBLIC)

Parameters

  • documentID (int) – ID of document

  • offset (int) – Skip this number of results

  • includeNegated (bool) – If true, also fetch explicit unwatch records

  • includeDeleted (bool) – If true, also fetch deleted watcher records

  • limit (int) – Limit the result

  • includeInherited (bool) – If true, also fetch watchers defined on parent folders

  • 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.document.list_document_watchers_by_path(parentFolderPath: str, documentName: str, customer: str = None, offset: int = None, includeNegated: bool = None, includeDeleted: bool = None, limit: int = 25, includeInherited: bool = True, 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#

Get all watchers for document (PUBLIC)

Parameters

  • parentFolderPath (str) – Path to parent folder (if not specified, select document from root folder)

  • documentName (str) – Document name

  • customer (str) – Customer space to lookup folder in (default is current users customer)

  • offset (int) – Skip this number of results

  • includeNegated (bool) – If true, also fetch explicit unwatch records

  • includeDeleted (bool) – If true, also fetch deleted watcher records

  • limit (int) – Limit the result

  • includeInherited (bool) – If true, also fetch watchers defined on parent folders

  • 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.document.list_documents(customerID: int = None, keywords: str = None, limit: int = 25, offset: int = 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#

List documents (PUBLIC)

Parameters

  • customerID (list) – Filter documents by customerID

  • keywords (list) – Filter documents by keywords

  • limit (int) – Maximum number of returned results

  • offset (int) – Skip a number of results

  • 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.document.lock_document(documentID: int, lockRequestTime: int = None, mode: str = 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#

Lock/Unlock specified document (PUBLIC)

Parameters

  • documentID (int) – ID of document to lock/unlock

  • lockRequestTime (int) – If ‘mode’ is set to LOCK, specify how long the document should be locked

  • mode (str) – Specify whether to lock or unlock the document, or to override an existing lock (default LOCK)

  • 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.document.move_document(documentID: int, newFolderID: int = 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#

Move document to a different folder (PUBLIC)

Parameters

  • documentID (int) – ID of document to move

  • newFolderID (int) – The ID of the parent folder to move this document to

  • 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.document.revoke_document_access(documentID: int, accessID: 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#

Revoke specified explicit access from document (PUBLIC)

Parameters

  • documentID (int) – Document ID

  • accessID (int) – Access ID

  • 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.document.revoke_document_access_by_path(parentFolderPath: str, documentName: str, accessID: int, customer: str = 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#

Revoke specified explicit access from document (PUBLIC)

Parameters

  • parentFolderPath (str) – Path from customer root (if not specified, this returns the root)

  • documentName (str) – Document name

  • accessID (int) – Access ID

  • customer (str) – Customer space to fetch from (default is current users customer)

  • 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.document.search_documents(limit: int = None, offset: int = None, includeDeleted: bool = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, customerID: int = None, id: int = None, userID: int = None, userFieldStrategy: str = None, accessMode: str = None, state: str = None, startTimestamp: int = None, endTimestamp: int = None, timeMatchStrategy: str = None, timeFieldStrategy: str = None, keywords: str = None, keywordMatchStrategy: str = None, keywordFieldStrategy: str = None, labels: str = None, folderID: int = None, sortBy: str = None, includeFlags: str = None, excludeFlags: str = None, recursive: bool = True, 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#

Search for specific documents (PUBLIC)

Parameters

  • limit (int) – Max number of results.

  • offset (int) – Skip the first (offset) objects. By default, return result from first object.

  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.

  • subCriteria (list) – Set additional criterias which are applied using a logical OR.

  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.

  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).

  • customerID (list) – Restrict search to data belonging to specified customers.

  • id (list) – ID of documents to match

  • userID (list) – Restrict search to documents associated with any of these users.

  • userFieldStrategy (list) – Defines which user fields will be used for searching for documents associated to userID field. (default all)

  • accessMode (list) – Match these access modes

  • state (list) – The status of the documents to match

  • startTimestamp (int) – Start of time search period

  • endTimestamp (int) – End of time search period

  • timeMatchStrategy (str) – TimeMatchStrategy to define how to match startTimestamp and endTimestamp with fields. (default any)

  • timeFieldStrategy (list) – TimeFieldStrategy to define which timestamp field(s) to match. (default createdTimestamp)

  • keywords (list) – A set of keywords matched against documents based on the set KeywordFieldStrategy and KeywordMatchStrategy.

  • keywordMatchStrategy (str) – KeywordMatchStrategy to define how to match keywords with fields. (default any)

  • keywordFieldStrategy (list) – KeywordFieldStrategy to define which document field(s) to match. (default all)

  • labels (list) – Match documents with any of these labels

  • folderID (list) – Search for documents within any of these folders. Use folderID=0 to search root folders.

  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).

  • includeFlags (list) – Only include objects which have includeFlags set.

  • excludeFlags (list) – Exclude objects which have excludeFlags set.

  • recursive (bool) – Search all subfolders below selected folders (default true)

  • 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.document.set_current_user_document_watch_status(documentID: int, watch: 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#

Change current user watcher status for document. Requires read access to the document. (PUBLIC)

Parameters

  • documentID (int) – ID of document

  • watch (bool) – If true, enable an explicit watcher for the current user for the target document. If false, add an explicit negation for the current user.

  • 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.document.set_current_user_document_watch_status_by_path(parentFolderPath: str, documentName: str, customer: str = None, watch: 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#

Change current user watcher status for document. Requires read access to the document. (PUBLIC)

Parameters

  • parentFolderPath (str) – Path to parent folder (if not specified, select document from root folder)

  • documentName (str) – Document name

  • customer (str) – Customer space to lookup folder in (default is current users customer)

  • watch (bool) – If true, enable an explicit watcher for the current user for the target document. If false, add an explicit negation for the current user.

  • 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.document.set_document_labels(documentID: int, setLabels: str = None, addLabels: str = None, removeLabels: str = 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#

Update labels for specified document (PUBLIC)

Parameters

  • documentID (int) – ID of document to set labels for

  • setLabels (list) – Overwrite existing labels with this set of labels. Cannot be used with addLabels or removeLabels.

  • addLabels (list) – Add these labels to existing labels. Cannot be used with setLabels.

  • removeLabels (list) – Remove these labels from existing labels. Cannot be used with setLabels.

  • 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.document.update_document(documentID: int, name: str = None, mimeType: str = None, data: str = None, notificationOptions: dict = None, text: str = None, lockRequestTime: int = 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#

Update specified document (PUBLIC)

Parameters

  • documentID (int) – ID of document to update

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

  • mimeType (str) – If set change document MIME type

  • data (str) – Base64 encoded document content formatted according to the given MIME type. If set change document content

  • notificationOptions (dict) –

  • text (str) – Plain text document content. If set change document content

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

  • 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.document.update_document_access_settings(documentID: int, accessMode: str = 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#

Change access settings on specified document (PUBLIC)

Parameters

  • documentID (int) – Document ID

  • accessMode (str) – Specify general access mode for document/folder

  • 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.document.update_document_access_settings_by_path(parentFolderPath: str, documentName: str, customer: str = None, accessMode: str = 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#

Change access settings on specified document (PUBLIC)

Parameters

  • parentFolderPath (str) – Path from customer root (if not specified, this returns the root)

  • documentName (str) – Document name

  • customer (str) – Customer space to fetch from (default is current users customer)

  • accessMode (str) – Specify general access mode for document/folder

  • 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