# api.documents.v1.folder package

## Submodules

## api.documents.v1.folder.folder_root module

Autogenerated API

`api.documents.v1.folder.folder_root.``add_document`(folderID: int, name: str = None, data: str = None, text: str = None, mimeType: str = None, accessMode: str = 'roleBased', lockRequestTime: int = 300000, inheritExplicitPermissions: bool = 'True', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict

  Create a new document (PUBLIC) In order to create plain text document, use ‘text’ property and send text. Otherwise use ‘data’ property populated with base64 encoded representation of the document. Sending the both parameters will result in error.

  Return type: | `dict`

`api.documents.v1.folder.folder_root.``add_folder`(parentID: int, name: str = None, accessMode: str = 'roleBased', inheritExplicitPermissions: bool = 'True', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict

  Create a new subfolder (PUBLIC)

  Return type: | `dict`
  Parameters: | parentID (int) – ID of parent folder name (str) – Name of new folder => Sanitize by regex [a-zA-Z0-9ÅåØøÆæ_-. ]* accessMode (str) – General access mode of new folder (default roleBased) inheritExplicitPermissions (bool) – Inherit explicit permissions from parent folder (default true)
  Raises: | AuthenticationFailedException – on 401 ValidationFailedException – on 412 AccessDeniedException – on 403 ParentFolderNotFoundException – on 404
  Returns: | {“offset”: 27, “limit”: 608, “responseCode”: 200, “count”: 51, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “About world others hot.”, “messageTemplate”: “Late against until money show.”, “field”: “Lay shake when plant my animal mean deal.”, “parameter”: {}, “timestamp”: 133120927}], “currentPage”: 115, “size”: 10}

`api.documents.v1.folder.folder_root.``browse_folder`(folderID: int, limit: int = 25, offset: int = 0, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict

  Fetch specified folder entries (PUBLIC)

  Return type: | `dict`
  Parameters: | folderID (int) – ID of folder to browse limit (int) – Maximum number of returned results offset (int) – Skip a number of results
  Raises: | AuthenticationFailedException – on 401 ValidationFailedException – on 412 AccessDeniedException – on 403 FolderNotFoundException – on 404
  Returns: | {“offset”: 781, “limit”: 60, “responseCode”: 200, “count”: 924, “data”: [{“parentElements”: [{“id”: 310, “name”: “John Vasquez”}], “effectiveAccessMode”: “roleBased”, “currentUserAccessLevel”: “folder”, “lastUpdatedTimestamp”: 736282983, “createdByUser”: {“id”: 705, “customerID”: 989, “userName”: “jamestorres”, “name”: “Danielle Hendrix”}, “createdTimestamp”: 503509156, “lastUpdatedByUser”: {“id”: 544, “customerID”: 868, “userName”: “diana52”, “name”: “Kimberly Blevins”}, “ownedByUser”: {“id”: 362, “customerID”: 705, “userName”: “icarr”, “name”: “Wayne Henderson”}, “accessMode”: “roleBased”, “elementType”: “document”, “name”: “Angel Day”, “id”: 447}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Occur me world image test site.”, “messageTemplate”: “Lot even threat assume improve range whether.”, “field”: “Stock assume prevent defense election.”, “parameter”: {}, “timestamp”: 970402464}], “currentPage”: 65, “size”: 176}

`api.documents.v1.folder.folder_root.``delete_folder`(folderID: int, cascadeDocumentID: list = None, mode: str = 'DELETE_IF_EMPTY', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict

  Delete specified folder, possibly recursively discarding contained documents (PUBLIC) If folder contains undeleted documents, the mode must be DELETE_CASCADE_ALL or DELETE_CASCADE_LISTED_DOCUMENTS with a list of documents to delete. If mode is DELETE_IF_EMPTY (default) and folder contains undeleted documents, the request will fail with a 409 CONFLICT and a metadata key ‘documentID’ listing documents which are not deleted.

  Return type: | `dict`

`api.documents.v1.folder.folder_root.``get_current_user_root_folder`(limit: int = 25, offset: int = 0, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict

  Fetch root folder for the customers that current user has access to (PUBLIC) If the current user has access to a single customer it returns the content of that customer’s root folder, otherwise it returns the list of root folders for each customer, without a content.

  Return type: | `dict`

`api.documents.v1.folder.folder_root.``get_folder_meta_info_by_id`(folderID: int, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict

  Fetch specified folder metadata (PUBLIC)

  Return type: | `dict`
  Parameters: | folderID (int) – ID of folder to fetch
  Raises: | AuthenticationFailedException – on 401 ValidationFailedException – on 412 AccessDeniedException – on 403 ObjectNotFoundException – on 404
  Returns: | {“offset”: 993, “limit”: 840, “responseCode”: 200, “count”: 26, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Tree marriage possible herself amount home full.”, “messageTemplate”: “Protect join organization name.”, “field”: “Rule visit future again lay science great.”, “parameter”: {}, “timestamp”: 766030546}], “currentPage”: 410, “size”: 118}

`api.documents.v1.folder.folder_root.``grant_folder_access`(folderID: int, subjectID: int = None, level: str = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict

  Grant access to specified folder (PUBLIC) If the access level is folder, the user is allowed to obtain the information about the folder (without folder content). If the access level is read, the user is allowed to obtain the content of the folder. If the access level is write, the user is allowed to update the folder.

  Return type: | `dict`

`api.documents.v1.folder.folder_root.``list_folder_access`(folderID: int, offset: int = 0, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict

  Fetch ACL for specified folder (PUBLIC)

  Return type: | `dict`
  Parameters: | folderID (int) – Folder ID offset (int) – Skip a number of results limit (int) – Maximum number of returned results
  Raises: | AuthenticationFailedException – on 401 ValidationFailedException – on 412 AccessDeniedException – on 403 ObjectNotFoundException – on 404
  Returns: | {“offset”: 580, “limit”: 430, “responseCode”: 200, “count”: 971, “data”: [{“id”: 942, “subject”: {“id”: 82, “customerID”: 171, “name”: “Scott Ellis”}, “level”: “write”}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Short gas style.”, “messageTemplate”: “Interesting reduce chair determine miss away.”, “field”: “Take myself protect inside.”, “parameter”: {}, “timestamp”: 1153732623}], “currentPage”: 374, “size”: 152}

`api.documents.v1.folder.folder_root.``revoke_folder_access`(folderID: int, accessID: int, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict

  Revoke specified explicit access from folder (PUBLIC)

  Return type: | `dict`
  Parameters: | folderID (int) – Folder ID accessID (int) – Access ID
  Raises: | AuthenticationFailedException – on 401 ValidationFailedException – on 412 AccessDeniedException – on 403 ObjectNotFoundException – on 404
  Returns: | {“offset”: 978, “limit”: 895, “responseCode”: 200, “count”: 261, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Make situation trial fill resource.”, “messageTemplate”: “Carry behavior development low girl laugh decide check.”, “field”: “At natural team race character environment away.”, “parameter”: {}, “timestamp”: 130265149}], “currentPage”: 323, “size”: 168}

`api.documents.v1.folder.folder_root.``update_document_access_settings`(folderID: int, accessMode: str = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict

  Change access settings on specified folder (PUBLIC) If the access mode is roleBased, user accessing the folder must have appropriate role, set by administrator. If the access mode is writeRestricted, user accessing the folder can read, but must have appropriate role for write, set by administrator. If the access mode is readRestricted, user accessing the folder must have appropriate roles for both read and write, set by administrator. If the access mode is explicit, user accessing the folder must have explicit grant by folder’s owner.

  Return type: | `dict`

`api.documents.v1.folder.folder_root.``update_folder`(folderID: int, name: str = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict

  Update specified folder (PUBLIC)

  Return type: | `dict`
  Parameters: | folderID (int) – ID of folder to update name (str) – If set change folder name => Sanitize by regex [a-zA-Z0-9ÅåØøÆæ_-. ]*
  Raises: | AuthenticationFailedException – on 401 ValidationFailedException – on 412 AccessDeniedException – on 403 ObjectNotFoundException – on 404
  Returns: | {“offset”: 710, “limit”: 311, “responseCode”: 200, “count”: 2, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Magazine pick degree right.”, “messageTemplate”: “Role why effort at majority wind structure.”, “field”: “Member quickly result anything our always.”, “parameter”: {}, “timestamp”: 195192902}], “currentPage”: 262, “size”: 707}

## Module contents