🔍 Code Extractor

Retrieves and displays all document libraries from a SharePoint site using Microsoft Graph API, then explores items within each library.

Purpose

This function queries a SharePoint site to discover all document libraries (excluding other list types), prints their metadata (name, ID, web URL), and attempts to retrieve items from each library by calling explore_library_items(). It's designed for SharePoint site exploration and document discovery workflows.

Source Code

def explore_document_libraries(site_id, headers):
    """Explore document libraries specifically."""
    try:
        # Try to get document libraries via lists endpoint
        lists_url = f"https://graph.microsoft.com/v1.0/sites/{site_id}/lists"
        response = requests.get(lists_url, headers=headers)
        
        if response.status_code == 200:
            lists_data = response.json()
            
            doc_libraries = []
            for lst in lists_data.get('value', []):
                if lst.get('list', {}).get('template') == 'documentLibrary':
                    doc_libraries.append(lst)
            
            print(f"Found {len(doc_libraries)} document libraries:")
            for i, lib in enumerate(doc_libraries, 1):
                print(f"{i}. {lib.get('displayName', 'Unknown')}")
                print(f"   ID: {lib.get('id', 'Unknown')}")
                print(f"   Web URL: {lib.get('webUrl', 'Unknown')}")
                
                # Try to get items from this library
                explore_library_items(site_id, lib.get('id'), headers, lib.get('displayName', 'Unknown'))
                print()
        else:
            print(f"Failed to get lists: {response.status_code}")
            
    except Exception as e:
        print(f"Error exploring document libraries: {e}")

Parameters

Parameter Details

site_id: The unique identifier of the SharePoint site to explore. This should be a valid Microsoft Graph site ID string, typically in the format 'domain.sharepoint.com,guid,guid' or obtained from the Graph API sites endpoint.

headers: A dictionary containing HTTP headers for authentication with Microsoft Graph API. Must include an 'Authorization' header with a valid Bearer token that has permissions to read SharePoint sites and lists (e.g., Sites.Read.All or Sites.ReadWrite.All).

Return Value

This function does not return any value (implicitly returns None). It performs side effects by printing information about discovered document libraries to stdout and calling explore_library_items() for each library found.

Dependencies

• requests

Required Imports

import requests

Usage Example

import requests

# Assume you have obtained an access token
access_token = 'your_access_token_here'
site_id = 'contoso.sharepoint.com,abc123,def456'

headers = {
    'Authorization': f'Bearer {access_token}',
    'Content-Type': 'application/json'
}

# Define or import explore_library_items function
def explore_library_items(site_id, library_id, headers, library_name):
    print(f"Exploring items in {library_name}...")
    # Implementation here

# Call the function
explore_document_libraries(site_id, headers)

Best Practices

• Ensure the access token in headers has sufficient permissions (Sites.Read.All minimum) before calling this function
• Handle authentication token expiration by implementing token refresh logic before calling this function
• The function depends on explore_library_items() being defined - ensure this dependency is available in scope
• Consider implementing pagination if the site has more than 200 lists (Graph API default page size)
• Add logging instead of print statements for production use
• Implement rate limiting to avoid throttling by Microsoft Graph API
• The function catches all exceptions broadly - consider more specific exception handling for production code
• Validate site_id format before making API calls to avoid unnecessary requests

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• function check_all_libraries 82.7% similar

  Discovers and lists all document libraries (drives) in a SharePoint site, displaying their metadata and contents including folders and files.

  From: /tf/active/vicechatdev/SPFCsync/check_libraries.py

• function explore_library_items 81.8% similar

  Retrieves and displays items from a SharePoint document library using Microsoft Graph API, showing the total count and details of up to 5 items.

  From: /tf/active/vicechatdev/SPFCsync/diagnostic_comprehensive.py

• function explore_all_drives 78.3% similar

  Retrieves and displays all document drives from a SharePoint site using Microsoft Graph API, then explores the root folder of each drive.

  From: /tf/active/vicechatdev/SPFCsync/diagnostic_comprehensive.py

• function explore_site_structure 74.7% similar

  Explores and displays the complete structure of a SharePoint site using Microsoft Graph API, including drives, document libraries, lists, and alternative API endpoints.

  From: /tf/active/vicechatdev/SPFCsync/diagnostic_comprehensive.py

• function explore_site_lists 73.2% similar

  Retrieves and displays all SharePoint lists from a specified site using Microsoft Graph API, printing their display names, IDs, template types, and web URLs.

  From: /tf/active/vicechatdev/SPFCsync/diagnostic_comprehensive.py