Microsoft SharePoint Component
Interact with sites, drives, and items connected to your instance of Microsoft SharePoint.
Component key: ms-sharepoint
Description
Microsoft SharePoint is a web-based collaborative platform that integrates with Microsoft Office. This component allows you to interact with your sites, drives, and items by making queries through the Microsoft Graph API.
API Documentation
This component was built using the Microsoft Graph Rest API v1.0
Example SharePoint Integration
The examples repo has an example integration that you can import that demonstrates how to listen for changes to a SharePoint drive, or fetch lists and items from a SharePoint site.
This example integration contains five flows:
- Import SharePoint File on Event - Whenever a file is created/updated/deleted in your customer's selected Sharepoint drive, that file is fetched and uploaded to an "Acme" endpoint that your customer enters.
- Subscribe to SharePoint File Events - This flow runs every week and creates a subscription to a Sharepoint drive, instructing Sharepoint to send notifications to the Import SharePoint File on Event flow whenever files are updated.
- Run Subscription Flow on Deploy - This flow calls the Subscribe to SharePoint File Events once on instance deploy to ensure the subscription is configured immediately.
- Get Files from SharePoint - This is a synchronous flow that can be called from an external system to list files in a SharePoint drive.
- Fetch Events and Documents from Site Lists - This flow demonstrates how to fetch "lists" in a SharePoint site,. A "list" can represent a calendar of events or a directory with files in it.
Connections
Microsoft SharePoint OAuth 2.0
Once you have an instance of Microsoft SharePoint licensed to your account, you will need to create and configure a new "App Registration" within your Azure Active Directory tenant. When creating the application you will be prompted to select the 'Supported account types'. Under this section, be sure to select 'Accounts in any organizational directory (Any Azure AD directory - Multitenant)'.
You will need to go to "Platforms" and add the "Web" platform. In that section you should add Prismatic's OAuth 2.0 callback URL - https://oauth2.prismatic.io/callback
- as a Redirect URI.
Next, go to "Certificates & Secrets" for the app and add a new Client Secret. Note this value as you will need to supply it to the connection within Prismatic.
You will also need the Application (client) ID from the "Overview" page.
The last step of configuring the "App Registration" is assigning "App Permissions". Click "Add Permission", click on the square labeled "SharePoint", and then "Delegated permissions". You should select all permissions that are required for your desired integration.
Now, configure the OAuth 2.0 connection in Prismatic. Add an MS SharePoint OAuth 2.0 connection config variable:
- Use the Application (client) ID value for the Client ID field.
- Use the Client Secret for the same named field.
- If you didn't select Multitenant when creating the Azure application, you will need to replace the Authorize URL and Token URL with ones specific to your tenant.
Save your integration and you should be able to authenticate a user through MS SharePoint with OAuth 2.0.
Input | Default | Notes |
---|---|---|
Authorize URL string / Required authorizeUrl | https://login.microsoftonline.com/common/oauth2/v2.0/authorize | Provide a tenant specific OAuth 2.0 authorize endpoint. |
Client ID string / Required clientId | Client Id of your Azure application | |
Client Secret password / Required clientSecret | Client Secret generated under 'Certificates & Secrets' in your Azure application. | |
Scopes string / Required scopes | Sites.ReadWrite.All Sites.Manage.All offline_access | Space separated OAuth 2.0 permission scopes |
Token URL string / Required tokenUrl | https://login.microsoftonline.com/common/oauth2/v2.0/token | Provide a tenant specific OAuth 2.0 token endpoint. |
Triggers
Webhook
Receive and validate webhook requests from Sharepoint for webhooks you configure. | key: webhook
Data Sources
List Drives from Source
A picklist of files in a given directory | key: listDrives | type: picklist
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Directory string dir | /groups/{groupId}/drives | Retrieve the list of Drive resources available for a target User, Group, or Site. https://learn.microsoft.com/en-us/graph/api/drive-list?view=graph-rest-1.0&tabs=http | /groups/{groupId}/drives |
List Folders from Source
A picklist of folders in a given directory | key: listFolders | type: picklist
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Directory string dir | /groups/{groupId}/drives | Retrieve the list of Drive resources available for a target User, Group, or Site. https://learn.microsoft.com/en-us/graph/api/drive-list?view=graph-rest-1.0&tabs=http | /groups/{groupId}/drives |
List Sites from Sharepoint
A picklist of Sites | key: listSites | type: picklist
Input | Notes |
---|---|
Connection connection / Required connection |
Actions
Create a Subscription
Create a Subscription to notify you of changes to a resource | key: createSubscription
Input | Default | Notes | Example |
---|---|---|---|
Allow Duplicates boolean allowDuplicates | Enable to allow more than one subscription per endpoint | ||
Change Type string / Required changeType | updated | The type of changes that should generate notifications for this subscription. OneDrive only supports updated. | updated |
Client State string clientState | An optional string value that is passed back in the notification message for this subscription. | client-specific string | |
Connection connection / Required connection | |||
Expiration Date Time string / Required expirationDateTime | The date and time when the subscription will expire if not updated or renewed. | 2018-01-01T11:23:00.000Z | |
Notification URL string / Required notificationUrl | The URL that notifications should be delivered to, if required for the specified notificationType. | https://contoso.azurewebsites.net/api/webhook-receiver | |
Resource string / Required resource | The relative path of the subscription within the drive. Read-only. | /me/drive/root |
Example Payload for Create a Subscription
{
"data": {
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#subscriptions/$entity",
"id": "38031b7d-16b1-448a-8e68-68b8aec62315",
"resource": "/me/drive/root",
"applicationId": "0fed8223-8c47-4c71-ba78-92c6f9448725",
"changeType": "updated",
"clientState": "client-specific string",
"notificationUrl": "https://hooks.prismatic.io/trigger/SW5z",
"notificationQueryOptions": null,
"lifecycleNotificationUrl": null,
"expirationDateTime": "2023-07-01T11:23:00Z",
"creatorId": "6219df3c-04d4-4b39-b2a4-ad162a5dcb8f",
"includeResourceData": null,
"latestSupportedTlsVersion": "v1_2",
"encryptionCertificate": null,
"encryptionCertificateId": null,
"notificationUrlAppId": null
}
}
Create Item in Site List
Create a new item inside the given site list | key: createItemInSite
Input | Notes | Example |
---|---|---|
Connection connection / Required connection | ||
Fields string / Required Key Value List fields | For each item, provide a key value pair to be added to the new drive item's properties. | |
List Id string / Required listId | Provide the unique identifier of a SharePoint site list. | 48bf81d7-2d37-40a9-b47b-c1d1960d00f87 |
Site Id string / Required siteId | Provide the unique identifier of a SharePoint site. | example.sharepoint.com,c45de8832-a4969-479d-aeb2-7nAh8321,48bf81d7-2d37-40a9-b47b-c1d1960d00f87 |
Create Site List Subscription
Create a Site List subscription for Microsoft SharePoint | key: createSiteListSubscription
Input | Default | Notes | Example |
---|---|---|---|
Allow Duplicates boolean allowDuplicates | false | Enable to allow more than one webhook per endpoint | |
Connection connection / Required connection | |||
Expiration Date/Time string expirationDateTime | Expiration date/time for subscription. If unspecified the default will be the current date/time plus 29 days (close to the maximum permitted by the Graph API). | ||
List Id string / Required listId | Provide the unique identifier of a SharePoint site list. | 48bf81d7-2d37-40a9-b47b-c1d1960d00f87 | |
Notification URL string / Required notificationUrl | URL to send events of this Subscription to | ||
Site Id string / Required siteId | Provide the unique identifier of a SharePoint site. | example.sharepoint.com,c45de8832-a4969-479d-aeb2-7nAh8321,48bf81d7-2d37-40a9-b47b-c1d1960d00f87 |
Example Payload for Create Site List Subscription
{
"data": {
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#subscriptions/$entity",
"id": "e9d5b726-4478-4412-bfba-268530484566",
"resource": "sites/example.sharepoint.com,17cd4ada-1a76-420e-a7ec-4adaa3327c86,87742bc7-2d2f-404c-8255-d3d9fa9a6561/lists/3a3c0f6a-86da-4567-94d4-3b939da63200",
"applicationId": "e76615c0-13e3-4cd2-8235-a2d628ad13de",
"changeType": "updated",
"clientState": null,
"notificationUrl": "https://example.com/webhook/",
"notificationQueryOptions": null,
"lifecycleNotificationUrl": null,
"expirationDateTime": "2022-11-22T23:32:10.231Z",
"creatorId": "c8edbeda-c453-446c-91ce-c6d5c7310a6c",
"includeResourceData": null,
"latestSupportedTlsVersion": "v1_2",
"encryptionCertificate": null,
"encryptionCertificateId": null,
"notificationUrlAppId": null
}
}
Delete a Subscription
Delete a Subscription by ID | key: deleteSubscription
Input | Notes | Example |
---|---|---|
Connection connection / Required connection | ||
Subscription Id string / Required subscriptionId | The Id the subscription to delete | 48bf81d7-2d37-40a9-b47b-c1d1960d00f87 |
Example Payload for Delete a Subscription
{
"data": ""
}
Delete All Instance Subscriptions
Delete all subscriptions pointed at this instance | key: deleteAllInstanceSubscriptions
Input | Notes |
---|---|
Connection connection / Required connection |
Example Payload for Delete All Instance Subscriptions
{
"data": {
"subscriptionsRemoved": [
"26ebd1e9-c54a-4bbe-9583-fc05974952a4",
"b9b27172-ee2e-4248-86df-fc98cb71d914"
]
}
}
Download File
Download a file from the specified drive | key: downloadFile
Input | Notes | Example |
---|---|---|
Connection connection / Required connection | ||
Drive string / Required driveId | Provide the unique identifier of a SharePoint drive. | b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv |
Item Id string / Required itemId | Provide the unique identifier of a SharePoint item Id. | 01Q7VXROAW7LCB32ODBRCKZNSJIC544XAQ |
Get Current User
Get the information and metadata of the user that is currently logged in | key: getCurrentUser
Input | Notes |
---|---|
Connection connection / Required connection |
Example Payload for Get Current User
{
"data": {
"businessPhones": [
"+1 555 555 5555"
],
"displayName": "exampleUser",
"givenName": "exampleUser",
"jobTitle": "Retail Manager",
"mail": "someoneV@example.onmicrosoft.com",
"mobilePhone": "+1 555 555 5555",
"officeLocation": "example",
"preferredLanguage": "en-US",
"surname": "Example",
"id": "3693-4789-a1c3-f4de565f"
}
}
Get Drive
Returns the information and metadata of a SharePoint drive | key: getDrive
Input | Notes | Example |
---|---|---|
Connection connection / Required connection | ||
Drive string / Required driveId | Provide the unique identifier of a SharePoint drive. | b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv |
Get File
Get a file from a Drive | key: getFile
Input | Notes | Example |
---|---|---|
Connection connection / Required connection | ||
Drive string / Required driveId | Provide the unique identifier of a SharePoint drive. | b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv |
Item Id string / Required itemId | Provide the unique identifier of a SharePoint item Id. | 01Q7VXROAW7LCB32ODBRCKZNSJIC544XAQ |
Get Item from Site List
Returns the information and metadata of the given item | key: getItemInSite
Input | Notes | Example |
---|---|---|
Connection connection / Required connection | ||
Item Id string / Required itemId | Provide the unique identifier of a SharePoint item Id. | 01Q7VXROAW7LCB32ODBRCKZNSJIC544XAQ |
List Id string / Required listId | Provide the unique identifier of a SharePoint site list. | 48bf81d7-2d37-40a9-b47b-c1d1960d00f87 |
Opt In Fields string optInFields | Provide a comma separated list of fields to overwrite the default result set. | name, description, id |
Site Id string / Required siteId | Provide the unique identifier of a SharePoint site. | example.sharepoint.com,c45de8832-a4969-479d-aeb2-7nAh8321,48bf81d7-2d37-40a9-b47b-c1d1960d00f87 |
Get Root Site
Returns the information and metadata of the root SharePoint site in your tenant | key: getRootSite
Input | Notes |
---|---|
Connection connection / Required connection |
Example Payload for Get Root Site
{
"data": {
"description": "Example description",
"id": "example.sharepoint.com,c45e332-a998-479d-aeb2-2a",
"name": "Example SharePoint Site",
"webUrl": "https://example.sharepoint.com",
"displayName": "Communication Site",
"siteCollection": {
"hostname": "https://example.sharepoint.com"
}
}
}
Get Site
Returns the information and metadata of the given SharePoint site | key: getSite
Input | Notes | Example |
---|---|---|
Connection connection / Required connection | ||
Site Id string / Required siteId | Provide the unique identifier of a SharePoint site. | example.sharepoint.com,c45de8832-a4969-479d-aeb2-7nAh8321,48bf81d7-2d37-40a9-b47b-c1d1960d00f87 |
Example Payload for Get Site
{
"data": {
"description": "Example description",
"id": "example.sharepoint.com,c45e332-a998-479d-aeb2-2a",
"name": "Example SharePoint Site",
"webUrl": "https://example.sharepoint.com",
"displayName": "Communication Site",
"siteCollection": {
"hostname": "https://example.sharepoint.com"
}
}
}
Get Site List
Returns the information and metadata of an existing site list | key: getList
Input | Notes | Example |
---|---|---|
Connection connection / Required connection | ||
List Id string / Required listId | Provide the unique identifier of a SharePoint site list. | 48bf81d7-2d37-40a9-b47b-c1d1960d00f87 |
Site Id string / Required siteId | Provide the unique identifier of a SharePoint site. | example.sharepoint.com,c45de8832-a4969-479d-aeb2-7nAh8321,48bf81d7-2d37-40a9-b47b-c1d1960d00f87 |
List Changes
Track changes in a driveItem and its children over time. | key: listChanges
Input | Default | Notes | Example |
---|---|---|---|
$expand Parameter string $expand | Retrieves related resources. https://learn.microsoft.com/en-us/graph/query-parameters?tabs=http#expand-parameter | members | |
$select Parameter string $select | Filters properties (columns). https://learn.microsoft.com/en-us/graph/query-parameters?tabs=http#select-parameter | givenName,surname | |
$top Parameter string $top | Sets the page size of results. https://learn.microsoft.com/en-us/graph/query-parameters?tabs=http#top-parameter | 5 | |
Connection connection / Required connection | |||
URL to fetch for delta string / Required deltaURL | /drives/{drive-id}/root/delta | The URL to track changes in a driveItem and its children over time. You can also paste here the @odata.nextLink or @odata.deltaLink from a previous response to resume tracking changes. | /drives/{drive-id}/root/delta |
Fetch All boolean fetchAll | false | Set to true to retrieve all results. |
List Drives
List all drives within any given SharePoint site | key: listDrives
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Fetch All boolean fetchAll | false | Set to true to retrieve all results. | |
Page Limit string pageLimit | Enter a number amount for the page size. | 100 | |
Page Token string pageToken | Enter the token for the desired page. | X%2744537079ghv | |
Site Id string / Required siteId | Provide the unique identifier of a SharePoint site. | example.sharepoint.com,c45de8832-a4969-479d-aeb2-7nAh8321,48bf81d7-2d37-40a9-b47b-c1d1960d00f87 |
Example Payload for List Drives
{
"data": {
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#drives",
"value": [
{
"createdDateTime": "2023-05-14T05:14:52Z",
"description": "",
"id": "b!o2UaIfdNxk-5091VjGz1sDVso2efo6RGrpVCkPpe547Qrf38sox_TYIFuj9QrJhv",
"lastModifiedDateTime": "2023-05-14T05:14:52Z",
"name": "Documents",
"webUrl": "https://example.sharepoint.com/Shared%20Documents",
"driveType": "documentLibrary",
"createdBy": {
"user": {
"displayName": "System Account"
}
},
"owner": {
"group": {
"id": "9705118a-6ce1-4fa3-adba-09f94b69d568",
"displayName": "9705118a-6ce1-4fa3-acda-09f94b69d446"
}
},
"quota": {
"deleted": 0,
"remaining": 27487789251101,
"state": "normal",
"total": 27487790694400,
"used": 1443299
}
}
]
}
}
List Files in Drive
List all the files from a Drive | key: getFilesFromDriveWithPagination
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Drive string / Required driveId | Provide the unique identifier of a SharePoint drive. | b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv | |
Fetch All boolean fetchAll | false | Set to true to retrieve all results. | |
Page Limit string pageLimit | Enter a number amount for the page size. | 100 | |
Page Token string pageToken | Enter the token for the desired page. | X%2744537079ghv |
List Files in Drive (Deprecated)
List all the files from a Drive. This version of the action is being deprecated. Please replace action with List Files In Drive. | key: getFilesFromDrive
Input | Notes | Example |
---|---|---|
Connection connection / Required connection | ||
Drive string / Required driveId | Provide the unique identifier of a SharePoint drive. | b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv |
List Folder Files in Drive
List all the files inside of a folder from a Drive | key: getFilesFromDriveFolderWithPagination
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Drive string / Required driveId | Provide the unique identifier of a SharePoint drive. | b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv | |
Fetch All boolean fetchAll | false | Set to true to retrieve all results. | |
Folder ID string folderId | Provide the unique identifier of a Sharepoint folder Id. | 01Q7VXAXZW7LCB32ODBRCKZNSJIC544FXU | |
Page Limit string pageLimit | Enter a number amount for the page size. | 100 | |
Page Token string pageToken | Enter the token for the desired page. | X%2744537079ghv |
List Folder Files in Drive (Deprecated)
List all the files inside of a folder from a Drive. This version of the action is being deprecated. Please replace action with List Folder Files In Drive. | key: getFilesFromDriveFolder
Input | Notes | Example |
---|---|---|
Connection connection / Required connection | ||
Drive string / Required driveId | Provide the unique identifier of a SharePoint drive. | b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv |
Folder ID string folderId | Provide the unique identifier of a Sharepoint folder Id. | 01Q7VXAXZW7LCB32ODBRCKZNSJIC544FXU |
List Followed Sites
List all Followed Sites | key: listFollowedSites
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Fetch All boolean fetchAll | false | Set to true to retrieve all results. | |
Page Limit string pageLimit | Enter a number amount for the page size. | 100 | |
Page Token string pageToken | Enter the token for the desired page. | X%2744537079ghv |
Example Payload for List Followed Sites
{
"data": {
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#sites",
"value": [
{
"displayName": "Example",
"id": "example.sharepoint.com,6c44888f-5883-4ef0-c542-d21a802cfea6,ed2d5d06-e192-4047-afa6-a5d7f25b3418",
"sharepointIds": {
"siteId": "6c44888f-5883-4ef0-c542-d21a802cfea6",
"webId": "ed2d5d06-e192-4047-afa6-a5d7f25b3418"
},
"siteCollection": {
"hostname": "example.sharepoint.com"
},
"webUrl": "https://example.sharepoint.com/sites/Example"
}
]
}
}
List Items in Site List
Return all items inside the given site list | key: getListItemsInSite
Input | Notes | Example |
---|---|---|
Connection connection / Required connection | ||
List Id string / Required listId | Provide the unique identifier of a SharePoint site list. | 48bf81d7-2d37-40a9-b47b-c1d1960d00f87 |
Opt In Fields string optInFields | Provide a comma separated list of fields to overwrite the default result set. | name, description, id |
Page Limit string pageLimit | Enter a number amount for the page size. | 100 |
Page Token string pageToken | Enter the token for the desired page. | X%2744537079ghv |
Site Id string / Required siteId | Provide the unique identifier of a SharePoint site. | example.sharepoint.com,c45de8832-a4969-479d-aeb2-7nAh8321,48bf81d7-2d37-40a9-b47b-c1d1960d00f87 |
List Shared Documents
Lists documents shared with the user. | key: listSharedDocuments
Input | Notes |
---|---|
Connection connection / Required connection |
List Site Lists
List all Site Lists | key: listSiteLists
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Fetch All boolean fetchAll | false | Set to true to retrieve all results. | |
Site Id string / Required siteId | Provide the unique identifier of a SharePoint site. | example.sharepoint.com,c45de8832-a4969-479d-aeb2-7nAh8321,48bf81d7-2d37-40a9-b47b-c1d1960d00f87 |
List Sites
List all SharePoint sites | key: listSites
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Fetch All boolean fetchAll | false | Set to true to retrieve all results. | |
Page Limit string pageLimit | Enter a number amount for the page size. | 100 | |
Page Token string pageToken | Enter the token for the desired page. | X%2744537079ghv |
Example Payload for List Sites
{
"data": {
"value": [
{
"description": "Example description",
"id": "example.sharepoint.com,c45e332-a998-479d-aeb2-2a",
"name": "Example SharePoint Site",
"webUrl": "https://example.sharepoint.com",
"displayName": "Communication Site",
"siteCollection": {
"hostname": "https://example.sharepoint.com"
}
}
]
}
}
List Subscriptions
List all available Subscriptions | key: listSubscriptions
Input | Default | Notes |
---|---|---|
Connection connection / Required connection | ||
Show Instance Subscriptions boolean showInstanceSubscriptions | Show only subscriptions for this Instance's Subscriptions |
Example Payload for List Subscriptions
{
"data": {
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#subscriptions",
"value": [
{
"id": "38031b7d-16b1-448a-8e68-68b8aec6df45",
"resource": "/me/drive/root",
"applicationId": "0fed8223-8c47-4c71-ba78-92c6f9441235",
"changeType": "updated",
"clientState": null,
"notificationUrl": "https://hooks.prismatic.io/trigger/SW5",
"notificationQueryOptions": null,
"lifecycleNotificationUrl": null,
"expirationDateTime": "2023-07-01T11:23:00Z",
"creatorId": "62162f3c-04d4-4b39-b2a4-ad891a5dcb8f",
"includeResourceData": null,
"latestSupportedTlsVersion": "v1_2",
"encryptionCertificate": null,
"encryptionCertificateId": null,
"notificationUrlAppId": null
}
]
}
}
Raw Request
Send raw HTTP request to Microsoft Sharepoint | key: rawRequest
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Data string data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
File Data string Key Value List fileData | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] | |
File Data File Names string Key Value List fileDataFileNames | File names to apply to the file data inputs. Keys must match the file data keys above. | ||
Form Data string Key Value List formData | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] | |
Header string Key Value List headers | A list of headers to send with the request. | User-Agent: curl/7.64.1 | |
Max Retry Count string maxRetries | 0 | The maximum number of retries to attempt. | |
Method string / Required method | The HTTP method to use. | ||
Query Parameter string Key Value List queryParams | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | ||
Response Type string / Required responseType | json | The type of data you expect in the response. You can request json, text, or binary data. | |
Retry On All Errors boolean retryAllErrors | false | If true, retries on all erroneous responses regardless of type. | |
Retry Delay (ms) string retryDelayMS | 0 | The delay in milliseconds between retries. | |
Timeout string timeout | The maximum time that a client will await a response to its request | 2000 | |
URL string / Required url | Input the path only (/me/followedSites), The base URL is already included (https://graph.microsoft.com/v1.0). For example, to connect to https://graph.microsoft.com/v1.0/me/followedSites, only /me/followedSites is entered in this field. | /me/followedSites | |
Use Exponential Backoff boolean useExponentialBackoff | false | Specifies whether to use a pre-defined exponential backoff strategy for retries. |
Update File
Update a file to the specified drive | key: updateFile
Input | Notes | Example |
---|---|---|
Connection connection / Required connection | ||
Drive string / Required driveId | Provide the unique identifier of a SharePoint drive. | b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv |
File Data data / Required fileData | Provide data to be uploaded to your desired SharePoint drive. | These are my file contents. |
Item Id string / Required itemId | Provide the unique identifier of a SharePoint item Id. | 01Q7VXROAW7LCB32ODBRCKZNSJIC544XAQ |
Update Site List Subscription Expiration
Update existing Site List subscription expiration for Microsoft SharePoint | key: updateSiteListSubscriptionExpiration
Input | Notes |
---|---|
Connection connection / Required connection | |
Expiration Date/Time string expirationDateTime | Expiration date/time for subscription. If unspecified the default will be the current date/time plus 29 days (close to the maximum permitted by the Graph API). |
Subscription ID string / Required subscriptionId | Subscription ID to manage |
Subscriptions have an expiration date/time provided upon creation. This can also be modified with the update API. This action will default to adding 29 days (close to the maximum value for SharePoint resources) to the current date/time unless a value is specified. This is useful for "touching" the subscription to ensure its expiration is extended.
Example Payload for Update Site List Subscription Expiration
{
"data": {
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#subscriptions/$entity",
"id": "e9d5b726-4478-4412-bfba-268530484566",
"resource": "sites/example.sharepoint.com,17cd4ada-1a76-420e-a7ec-4adaa3327c86,87742bc7-2d2f-404c-8255-d3d9fa9a6561/lists/3a3c0f6a-86da-4567-94d4-3b939da63200",
"applicationId": "e76615c0-13e3-4cd2-8235-a2d628ad13de",
"changeType": "updated",
"clientState": null,
"notificationUrl": "https://example.com/webhook/",
"notificationQueryOptions": null,
"lifecycleNotificationUrl": null,
"expirationDateTime": "2022-11-22T23:32:10.231Z",
"creatorId": "c8edbeda-c453-446c-91ce-c6d5c7310a6c",
"includeResourceData": null,
"latestSupportedTlsVersion": "v1_2",
"encryptionCertificate": null,
"encryptionCertificateId": null,
"notificationUrlAppId": null
}
}
Upload File
Upload a file to the specified drive or folder's drive | key: uploadFile
Input | Notes | Example |
---|---|---|
Connection connection / Required connection | ||
Drive string / Required driveId | Provide the unique identifier of a SharePoint drive. | b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv |
File Data data / Required fileData | Provide data to be uploaded to your desired SharePoint drive. | These are my file contents. |
File Name string / Required fileName | Provide a string value for the name of the new file. | reports.csv |
Folder ID string folderId | Provide the unique identifier of a Sharepoint folder Id. | 01Q7VXAXZW7LCB32ODBRCKZNSJIC544FXU |