SHAREPOINT — FETCH REMOTE FILE¶
Pulls a file from a SharePoint site or library the calling user has access to, using their stored Microsoft OAuth token (registered via Account > Cloud Storage). Reuses the same OAuth registration as OneDrive — only the Sites.Read.All scope is additionally required. Token expiry is handled automatically via refresh_token.
When to use¶
Tagged: cloud, storage, sharepoint, microsoft, oauth, download, fetch, workbench.
Inputs¶
| Label | ID | Type | Default | Required | Description |
|---|---|---|---|---|---|
| File ID | file_id | string | — | ✓ | Composite id item:<driveId>:<itemId> from /api/cloud/listing?provider=sharepoint navigation (site selection -> library -> folder). |
| Target name | target_name | string | — | Optional filename for the staged copy. Defaults to a synthesised name based on job id. |
Outputs¶
| Label | ID | Type | Description |
|---|---|---|---|
| Status | status | string | ok on success; Error: <message> on failure. |
| Target path | target_path | string | Absolute server path of the staged file (per-user tmp dir). |
| File name | file_name | string | Sanitised filename used on disk. |
| Job ID | job_id | string | Token addressing the staged file via /api/cloud/get_blob. |
| Bytes downloaded | bytes | integer | Bytes actually pulled from the provider. |
| Total bytes | total_bytes | integer | Provider-reported size (0 if unknown). |
| Provider | provider | string | Always sharepoint for this worker. |
| Connected account | auth_email | string | Email of the Microsoft account that issued the token. |
| Connected on | auth_connected_on | string | Timestamp when this user first connected SharePoint. |
| Last successful use | auth_last_used_on | string | Timestamp of the previous successful API call against SharePoint for this user. |
| Access token expires | auth_expires_at | string | Expiry timestamp of the access token after this run (post-refresh if applicable). |
| Token refreshed | auth_token_refreshed | integer | 1 if the refresh_token was used to mint a new access_token during this run; 0 otherwise. |
| Scopes granted | auth_scope_granted | string | Space-separated scopes the provider actually issued. |
| Auth error kind | auth_error_kind | string | none / not_connected / refresh_failed / scope_insufficient / provider_403 / provider_other. |
Disciplines¶
- data.io.file
- platform.integration
Auto-generated from platform schema. Worker id: sharepoint_remote_fetch. Schema hash: a1fc55417847. Hand-curated docs in workerexamples/ override this page when present.