Client

Class to create a SharePoint Client used to be the interface with SharePoint

class sharepoint_rest_api.client.SharePointClient(*args, **kwargs)

Client to access SharePoint Document Library

download_file(filename)
Parameters:filename – name of the file to download
Returns:

download file in current folder

get_folder(folder_name)
Parameters:folder_name – name of the folder
Returns:folder object

Return folder object

read_caml_items(filters=None, scope=None)
Parameters:
  • filters – filter dictionary
  • scope – SharePoint scope
Returns:

items

Retrieves (filtered) items on current folder using CamlQueries

read_file(filename)
Parameters:filename – filename
Returns:

Retrieve file in current folder

read_files(filters=None)
Parameters:filters –
Returns:files

Returns files metadata for files in current folder

read_folders(folder_name)
Parameters:folder_name –
Returns:folders

Return folders metadata for subfolder of current folder

read_items(filters=None, select=None)
Parameters:
  • filters – filter dictionary
  • scope – SharePoint scope
Returns:

items

Retrieves (filtered) items on current folder using querystring

search(search=None, filters=None, select=None, order_by=None, source_id=None, page=1)
Parameters:
  • filter – filter dictionary
  • select – select string
  • order_by – SharePoint order fields
  • source_id – SharePoint SourceId
Returns:

items and total row number

search file in the SharePoint site

upload_file(file, folder_name='Documents', metadata=<class 'dict'>)
Parameters:
  • path – inmemory file
  • folder_name – name of the folder
  • metadata – metadata dictionary
Returns: