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[source]

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[source]

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:
Returns:

{“offset”: 956, “limit”: 345, “responseCode”: 200, “count”: 13, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Agreement radio fund than.”, “messageTemplate”: “May difficult city story task consumer.”, “field”: “Require usually do.”, “parameter”: {}, “timestamp”: 541212748}], “currentPage”: 190, “size”: 627}

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[source]

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:
Returns:

{“offset”: 531, “limit”: 527, “responseCode”: 200, “count”: 485, “data”: [{“lastUpdatedTimestamp”: 1141083799, “createdByUser”: {“id”: 165, “customerID”: 799, “userName”: “simmonsjoseph”, “name”: “Matthew Phillips”}, “createdTimestamp”: 953267665, “lastUpdatedByUser”: {“id”: 225, “customerID”: 228, “userName”: “bradleytaylor”, “name”: “Jeffrey Horn”}, “ownedByUser”: {“id”: 475, “customerID”: 602, “userName”: “solomonjamie”, “name”: “Perry Benjamin”}, “accessMode”: “explicit”, “parentElements”: [{“id”: 73, “name”: “Joyce Lee”}], “effectiveAccessMode”: “readRestricted”, “currentUserAccessLevel”: “write”, “elementType”: “document”, “name”: “Kelly Davidson”, “id”: 722}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Call hand force top mention prove source.”, “messageTemplate”: “Various chance hospital decision interest road send.”, “field”: “Enter chance hotel read how.”, “parameter”: {}, “timestamp”: 1313694743}], “currentPage”: 432, “size”: 249}

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[source]

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[source]

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[source]

Fetch specified folder metadata (PUBLIC)

Return type:

dict

Parameters:

folderID (int) – ID of folder to fetch

Raises:
Returns:

{“offset”: 223, “limit”: 592, “responseCode”: 200, “count”: 355, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Discuss wait in choice cause.”, “messageTemplate”: “Hair hot world but significant manage.”, “field”: “Kind true should available commercial score sport.”, “parameter”: {}, “timestamp”: 890239764}], “currentPage”: 700, “size”: 45}

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[source]

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[source]

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:
Returns:

{“offset”: 252, “limit”: 155, “responseCode”: 200, “count”: 275, “data”: [{“id”: 945, “subject”: {“id”: 959, “customerID”: 322, “name”: “Nathaniel White”}, “level”: “write”}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Usually her day maintain side.”, “messageTemplate”: “Any college factor occur.”, “field”: “Everybody value benefit pay vote television question focus.”, “parameter”: {}, “timestamp”: 1208617922}], “currentPage”: 162, “size”: 714}

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

Revoke specified explicit access from folder (PUBLIC)

Return type:

dict

Parameters:
  • folderID (int) – Folder ID
  • accessID (int) – Access ID
Raises:
Returns:

{“offset”: 376, “limit”: 700, “responseCode”: 200, “count”: 498, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Big sit home consumer such music.”, “messageTemplate”: “Film fine least particularly firm.”, “field”: “Growth career answer against.”, “parameter”: {}, “timestamp”: 469471729}], “currentPage”: 703, “size”: 370}

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[source]

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[source]

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:
Returns:

{“offset”: 299, “limit”: 126, “responseCode”: 200, “count”: 230, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Away sit simply at establish friend magazine.”, “messageTemplate”: “Research prove indeed.”, “field”: “Box dream relationship again north trade turn.”, “parameter”: {}, “timestamp”: 1464466352}], “currentPage”: 462, “size”: 884}

Module contents