Handbook
Task `sharepoint_list_library_files_rest` v1
Read-only list of all document files under a library folder via SharePoint REST OData, using the attached Playwright page’s browser cookies (same M365 session as Edge). No DOM scroll.
Updated
Task sharepoint_list_library_files_rest v1
Summary
Read-only list of all document files under a library folder via SharePoint REST OData, using the attached Playwright page’s browser cookies (same M365 session as Edge). No DOM scroll.
Inputs
| Field | Type | Required |
|---|---|---|
session_ref |
string | yes (PlaywrightPageSession) |
site_url |
string | yes (or query.site_url) |
library_path |
string | no |
max_depth |
integer | no (default 4) |
limit |
integer | no |
Output
ReadResult; items use source_kind: library_rest, extra.via: sharepoint_rest.
Timing and stability
| Measure | Typical live | Stability |
|---|---|---|
| Latency | 10–60 s for ~200–300 files | High when session cookies valid |
| Item count | Full folder (recursive) | Fails on auth expiry |
Alternatives
| Task | When |
|---|---|
sharepoint_list_library_files_scroll |
REST blocked; page already loaded |
Failure modes
| Kind | When |
|---|---|
PlaywrightError:unsupported_operation |
Session is not PlaywrightPageSession |
Empty items |
REST 401/403 or expired M365 cookies |
Examples
{
"session_ref": "edge-session",
"site_url": "https://contoso.sharepoint.com/sites/Engineering/Shared Documents"
}
Verification
tests/playwright/test_sharepoint_list_library_files_rest.py (offline mocks).
Changelog
| Version | Change |
|---|---|
| v1 | Canonical REST OData list task |