API¶

Model Views
Base Views
Settings Based Views
URL Based Views

Model Views ¶

Views to allow CRUD on SharePoint models

sharepoint_rest_api.views.model_views.SharePointTenantViewSet(**kwargs)¶: A viewset that provides default list() and retrieve() actions.

sharepoint_rest_api.views.model_views.SharePointSiteViewSet(**kwargs)¶: A viewset that provides default list() and retrieve() actions.

sharepoint_rest_api.views.model_views.SharePointLibraryViewSet(**kwargs)¶: A viewset that provides default list() and retrieve() actions.

Base Views ¶

Base views extracted by settings and based views

sharepoint_rest_api.views.base.AbstractSharePointViewSet(**kwargs)¶: Base ViewSet for SharePoint Integration

sharepoint_rest_api.views.base.CamlQuerySharePointViewSet(**kwargs)¶: Viewset for CamlQuery Integration

sharepoint_rest_api.views.base.RestQuerySharePointViewSet(**kwargs)¶: Viewset for Rest Integration

sharepoint_rest_api.views.base.FileSharePointViewSet(**kwargs)¶: Base Viewset to handle SharePoint file metadata

sharepoint_rest_api.views.base.SharePointSearchViewSet(**kwargs)¶: Base class for SharePoint Search API

Settings Based Views ¶

Views used for settings mode

sharepoint_rest_api.views.settings_based.SettingsBasedSharePointViewSet(**kwargs)¶: Base viewset for settings based mode

sharepoint_rest_api.views.settings_based.SharePointSettingsRestViewSet(**kwargs)¶: Viewset for SharePoint Rest (settings based)

sharepoint_rest_api.views.settings_based.SharePointSettingsCamlViewSet(**kwargs)¶: Viewset for SharePoint Caml (settings based)

sharepoint_rest_api.views.settings_based.SharePointSettingsFileViewSet(**kwargs)¶: Viewset for SharePoint File metadata (settings based)

sharepoint_rest_api.views.settings_based.SharePointSettingsSearchViewSet(**kwargs)¶: Viewset for SharePoint Search (settings based)

URL Based Views ¶

Views used for URL mode

sharepoint_rest_api.views.url_based.UrlBasedSharePointViewSet(**kwargs)¶: Base viewset for URL based mode

sharepoint_rest_api.views.url_based.SharePointUrlRestViewSet(**kwargs)¶: Viewset for SharePoint Rest (URL based)

sharepoint_rest_api.views.url_based.SharePointUrlCamlViewSet(**kwargs)¶: Viewset for SharePoint Caml (URL based)

sharepoint_rest_api.views.url_based.SharePointUrlFileViewSet(**kwargs)¶: Viewset for SharePoint File metadata (URL based)