folder_path_access#

Autogenerated API

argus_api.lib.documents.v1.folder.path.folder_path_access.add_document(folderID: int, name: str = None, mimeType: str = None, accessMode: str = None, overwriteExisting: bool = None, data: str = None, notificationOptions: dict = None, text: str = 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#

Create a new document (PUBLIC)

Parameters

  • folderID (int) – Parent folder ID

  • 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.

  • data (str) – Base64 encoded document content formatted according to the given MIME type. It is required if ‘text’ parameter is not defined

  • 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)

  • 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

argus_api.lib.documents.v1.folder.path.folder_path_access.add_document_raw(folderID: int, documentName: str, accessMode: str = 'roleBased', 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

  • folderID (int) – Parent folder ID

  • documentName (str) – Document name

  • accessMode (str) – Access mode to set on new 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.folder.path.folder_path_access.add_folder(parentID: int, name: str = None, accessMode: str = 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#

Create a new subfolder (PUBLIC)

Parameters

  • parentID (int) – ID of parent folder

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

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

  • 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

argus_api.lib.documents.v1.folder.path.folder_path_access.add_folder_by_path(parentFolderPath: str, customer: str = None, name: str = None, accessMode: str = None, createMissingFolders: 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 subfolder in specified parent folder. (PUBLIC)

Parameters

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

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

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

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

  • createMissingFolders (bool) – If true, create any missing parent folder elements (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.folder.path.folder_path_access.add_folder_watcher(folderID: 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 folder. Requires write access to specified folder. (PUBLIC)

Parameters

  • folderID (int) – ID of folder

  • 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.folder.path.folder_path_access.add_folder_watcher_by_path(path: 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 folder (PUBLIC)

Parameters

  • path (str) – Path to folder

  • 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.folder.path.folder_path_access.browse_folder(folderID: 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 folder entries (PUBLIC)

Parameters

  • folderID (int) – ID of folder to browse

  • 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.folder.path.folder_path_access.browse_folder_by_path(path: 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 specified folder entries (PUBLIC)

Parameters

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

  • 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.folder.path.folder_path_access.delete_folder(folderID: int, cascadeDocumentID: int = None, mode: str = 'DELETE_IF_EMPTY', 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 specified folder, possibly recursively discarding contained documents (PUBLIC)

Parameters

  • folderID (int) – ID of folder to delete

  • cascadeDocumentID (list) – List with IDs of documents which can be discarded (with mode DELETE_CASCADE_LISTED_DOCUMENTS)

  • mode (str) – Recursive folder delete strategy, default is DELETE_IF_EMPTY

  • 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.folder.path.folder_path_access.delete_folder_by_path(parentFolderPath: str, folderName: str, customer: str = None, cascadeDocumentID: int = None, mode: str = 'DELETE_IF_EMPTY', 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 specified folder, possibly recursively discarding contained documents (PUBLIC)

Parameters

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

  • folderName (str) – Folder name

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

  • cascadeDocumentID (list) – List with IDs of documents which can be discarded (with mode DELETE_CASCADE_LISTED_DOCUMENTS)

  • mode (str) – Recursive folder delete strategy, default is DELETE_IF_EMPTY

  • 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.folder.path.folder_path_access.delete_folder_watcher(folderID: 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 from folder. Requires write access to specified folder. (PUBLIC)

Parameters

  • folderID (int) – ID of folder

  • 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.folder.path.folder_path_access.delete_folder_watcher_by_path(path: 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 from folder (PUBLIC)

Parameters

  • path (str) – Path to folder

  • 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.folder.path.folder_path_access.get_current_user_folder_watch_status(folderID: 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 folder (PUBLIC)

Parameters

  • folderID (int) – ID of 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.folder.path.folder_path_access.get_current_user_folder_watch_status_by_path(path: 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 folder (PUBLIC)

Parameters

  • path (str) – Path to folder

  • 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.folder.path.folder_path_access.get_current_user_root_folder(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 root folder for the customers that current user has access to (PUBLIC)

Parameters

  • 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.folder.path.folder_path_access.get_folder_meta_info_by_id(folderID: 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 folder metadata (PUBLIC)

Parameters

  • folderID (int) – ID of folder 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.folder.path.folder_path_access.get_folder_meta_info_by_path(path: 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 folder metadata (PUBLIC)

Parameters

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

  • 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.folder.path.folder_path_access.get_folder_watchers_by_id(folderID: 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 folder (PUBLIC)

Parameters

  • folderID (int) – ID of folder

  • 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.folder.path.folder_path_access.get_folder_watchers_by_path(path: 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 folder (PUBLIC)

Parameters

  • path (str) – Path to folder

  • 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.folder.path.folder_path_access.grant_folder_access(folderID: 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 folder (PUBLIC)

Parameters

  • folderID (int) – Folder 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.folder.path.folder_path_access.grant_folder_access_by_path(path: 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 folder (PUBLIC)

Parameters

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

  • 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.folder.path.folder_path_access.list_document_watchers_2(path: 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#

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

argus_api.lib.documents.v1.folder.path.folder_path_access.list_document_watchers_by_path_1(path: 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#

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

argus_api.lib.documents.v1.folder.path.folder_path_access.list_folder_access(folderID: 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 folder (PUBLIC)

Parameters

  • folderID (int) – Folder 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.folder.path.folder_path_access.list_folder_access_by_path(path: 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 folder (PUBLIC)

Parameters

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

  • 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.folder.path.folder_path_access.list_folder_watchers_by_path(folderID: 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_folder_watchers_by_path is an alias for get_folder_watchers_by_id. Exists only for backward compatibility - do not use - use get_folder_watchers_by_id instead.

argus_api.lib.documents.v1.folder.path.folder_path_access.move_folder(folderID: 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 specified folder (PUBLIC)

Parameters

  • folderID (int) – ID of folder to update

  • 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.folder.path.folder_path_access.revoke_folder_access(folderID: 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 folder (PUBLIC)

Parameters

  • folderID (int) – Folder 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.folder.path.folder_path_access.revoke_folder_access_by_path(path: 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 folder (PUBLIC)

Parameters

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

  • 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.folder.path.folder_path_access.set_current_user_folder_watch_status(folderID: 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#

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

argus_api.lib.documents.v1.folder.path.folder_path_access.set_current_user_folder_watch_status_1(path: 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#

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

argus_api.lib.documents.v1.folder.path.folder_path_access.set_current_user_folder_watch_status_by_id(folderID: 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 folder. Requires read access to folder. (PUBLIC)

Parameters

  • folderID (int) – ID of folder

  • watch (bool) – If true, enable an explicit watcher for the current user for the target folder. 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.folder.path.folder_path_access.set_current_user_folder_watch_status_by_path(path: 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#

Set current user watcher status for folder (PUBLIC)

Parameters

  • path (str) – Path to folder

  • 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 folder. 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.folder.path.folder_path_access.update_document_access_settings_1(folderID: 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#

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

argus_api.lib.documents.v1.folder.path.folder_path_access.update_document_access_settings_by_path_1(path: 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#

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

argus_api.lib.documents.v1.folder.path.folder_path_access.update_folder(folderID: int, name: 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 specified folder (PUBLIC)

Parameters

  • folderID (int) – ID of folder to update

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

  • 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.folder.path.folder_path_access.update_folder_access_settings(folderID: 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 folder (PUBLIC)

Parameters

  • folderID (int) – Folder 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.folder.path.folder_path_access.update_folder_access_settings_by_path(path: 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 folder (PUBLIC)

Parameters

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

  • 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

argus_api.lib.documents.v1.folder.path.folder_path_access.update_folder_by_path(path: str, customer: str = None, name: 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 specified folder (PUBLIC)

Parameters

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

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

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

  • 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