Microsoft SharePoint is a web-based collaborative platform that integrates with Microsoft Office, providing document management, intranet, and content management features for organizations.

Categories: File Storage, Communication

Type: microsoftSharePoint/v1

Connections

Version: 1

OAuth2 Authorization Code

Properties

Name	Label	Type	Required
clientId	Client Id	STRING	true
clientSecret	Client Secret	STRING	true
tenantId	Tenant Id	STRING	true

Connection Setup

Create OAuth 2.0 Application

Creation of OAuth 2.0 application is documented here.

Grant Necessary Permissions

Open the Azure Portal: https://portal.azure.com/
Click on App registrations.
Click on All applications.
Click on application you want to connect to Microsoft SharePoint.
Click on API permissions.
Click on Microsoft Graph (1).
Select following scopes:
- Sites.Manage.All
- Sites.ReadWrite.All
- offline_access
After selecting all the scopes click on Update permissions

Actions

Create Folder

Name: createFolder

Creates a new folder at path you specify.

Properties

Name	Label	Type	Description	Required
siteId	Site ID	STRING	The ID of the SharePoint site.	true
parentFolder	Parent Folder ID	STRING Depends On siteId	If no folder is selected, folder will be created in the root folder.	false
name	Folder Name	STRING		true

Example JSON Structure

{
  "label" : "Create Folder",
  "name" : "createFolder",
  "parameters" : {
    "siteId" : "",
    "parentFolder" : "",
    "name" : ""
  },
  "type" : "microsoftSharePoint/v1/createFolder"
}

Properties

Name	Type	Description
createdDateTime	DATE_TIME	The date and time when the folder was created.
eTag	STRING
id	STRING	ID of the folder.
lastModifiedDateTime	DATE_TIME	The date and time when the folder was last modified.
name	STRING	Name of the folder.
size	INTEGER	Size of the folder in bytes.
webUrl	STRING	URL to access the folder in a web browser.
cTag	STRING
commentSettings	OBJECT Properties {{BOOLEAN(isDisabled)}(commentingDisabled)}
createdBy	OBJECT Properties {{STRING(id), STRING(displayName)}(user)}
lastModifiedBy	OBJECT Properties {{STRING(id), STRING(displayName)}(user)}
folder	OBJECT Properties {INTEGER(childCount)}
shared	OBJECT Properties {STRING(scope)}

Output Example

{
  "createdDateTime" : "2021-01-01T00:00:00",
  "eTag" : "",
  "id" : "",
  "lastModifiedDateTime" : "2021-01-01T00:00:00",
  "name" : "",
  "size" : 1,
  "webUrl" : "",
  "cTag" : "",
  "commentSettings" : {
    "commentingDisabled" : {
      "isDisabled" : false
    }
  },
  "createdBy" : {
    "user" : {
      "id" : "",
      "displayName" : ""
    }
  },
  "lastModifiedBy" : {
    "user" : {
      "id" : "",
      "displayName" : ""
    }
  },
  "folder" : {
    "childCount" : 1
  },
  "shared" : {
    "scope" : ""
  }
}

Find Parent Folder ID

To find the Parent Folder ID, click here.

Name	Type	Description
createdDateTime	DATE_TIME	The date and time when the list was created.
description	STRING	Description of the list.
eTag	STRING
id	STRING	ID of the list.
lastModifiedDateTime	DATE_TIME	The date and time when the list was last modified.
name	STRING	Name of the list.
webUrl	STRING	URL to access the list in a web browser.
displayName	STRING	The displayable title of the list.
createdBy	OBJECT Properties {{STRING(id), STRING(displayName)}(user)}
list	OBJECT Properties {BOOLEAN(contentTypesEnabled), BOOLEAN(hidden), STRING(template)}

Create List Item

Name: createListItem

Creates a new item in a list.

Properties

Name	Label	Type	Description	Required
siteId	Site ID	STRING	The ID of the SharePoint site.	true
listId	List ID	STRING Depends On siteId		true
columns		DYNAMIC_PROPERTIES Depends On siteId, listId		null

Example JSON Structure

{
  "label" : "Create List Item",
  "name" : "createListItem",
  "parameters" : {
    "siteId" : "",
    "listId" : "",
    "columns" : { }
  },
  "type" : "microsoftSharePoint/v1/createListItem"
}

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

Upload File

Name: uploadFile

Upload file to Microsoft SharePoint folder.

Properties

Name	Label	Type	Description	Required
siteId	Site ID	STRING	The ID of the SharePoint site.	true
parentFolder	Parent Folder ID	STRING Depends On siteId	If no folder is selected, file will be uploaded to root folder.	false
file	File Entry	FILE_ENTRY	File to upload.	true

Example JSON Structure

{
  "label" : "Upload File",
  "name" : "uploadFile",
  "parameters" : {
    "siteId" : "",
    "parentFolder" : "",
    "file" : {
      "extension" : "",
      "mimeType" : "",
      "name" : "",
      "url" : ""
    }
  },
  "type" : "microsoftSharePoint/v1/uploadFile"
}

Properties

Name	Type	Description
createdDateTime	DATE_TIME	The date and time when the file was created.
eTag	STRING	eTag for the entire item (metadata + content).
id	STRING	ID of the file.
lastModifiedDateTime	DATE_TIME	The date and time when the file was last modified.
name	STRING	Name of the file.
size	INTEGER	Size of the file in bytes.
webUrl	STRING	URL to access the file in a web browser.
createdBy	OBJECT Properties {{STRING(email), STRING(id), STRING(displayName)}(user)}
lastModifiedBy	OBJECT Properties {{STRING(email), STRING(id), STRING(displayName)}(user)}
file	OBJECT Properties {{STRING(quickXorHash)}(hashes), STRING(mimeType)}

Output Example

{
  "createdDateTime" : "2021-01-01T00:00:00",
  "eTag" : "",
  "id" : "",
  "lastModifiedDateTime" : "2021-01-01T00:00:00",
  "name" : "",
  "size" : 1,
  "webUrl" : "",
  "createdBy" : {
    "user" : {
      "email" : "",
      "id" : "",
      "displayName" : ""
    }
  },
  "lastModifiedBy" : {
    "user" : {
      "email" : "",
      "id" : "",
      "displayName" : ""
    }
  },
  "file" : {
    "hashes" : {
      "quickXorHash" : ""
    },
    "mimeType" : ""
  }
}

Find Parent Folder ID

To find the Parent Folder ID, click here.

Triggers

New File

Name: newFile

Triggers when file is uploaded to folder.

Type: POLLING

Properties

Name	Label	Type	Description	Required
siteId	Site ID	STRING	The ID of the SharePoint site.	true
parentFolder	Parent Folder ID	STRING Depends On siteId	If no folder is selected, root folder will be monitored for new file.	false

Output

The output for this action is dynamic and may vary depending on the input parameters. To determine the exact structure of the output, you need to execute the action.

JSON Example

{
  "label" : "New File",
  "name" : "newFile",
  "parameters" : {
    "siteId" : "",
    "parentFolder" : ""
  },
  "type" : "microsoftSharePoint/v1/newFile"
}

Find Parent Folder ID

To find the Parent Folder ID, click here.

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

Additional Instructions

How to find your Site ID

Only way of finding Site ID in Microsoft SharePoint is using Microsoft Graph API.

Go to your Microsoft SharePoint site.
If your URL is https://company.sharepoint.com/sites/Finance then your site name is Finance.
Then use this Microsoft Graph API endpoint; GET https://graph.microsoft.com/v1.0/sites/company.sharepoint.com:/sites/Finance
You will get your folder ID.

How to find your Parent Folder ID

Only way of finding Folder ID in Microsoft SharePoint is using Microsoft Graph API endpoint: GET https://graph.microsoft.com/v1.0/sites/{site-id}/drives.

How to find your List ID

Open the SharePoint site.
Go to the Site Contents.
Find your list and click on 3 vertical dots (...)
Click on Settings
Look at the browser URL.
If your URL is https://6kqn7f.sharepoint.com/sites/Testsite/_layouts/15/listedit.aspx?List=2c8d8a57-10e1-43b7-b801-6cd5b328f55b
Then your List ID is 2c8d8a57-10e1-43b7-b801-6cd5b328f55b

Microsoft SharePoint

On this page