SharePoint

SharePoint

SharePoint helps organizations share and collaborate with colleagues, partners, and customers. You can connect to SharePoint Online or to an on-premises SharePoint 2013 or 2016 farm using the On-Premises Data Gateway to manage documents and list items.

Note:

  • This is a Standard connector.

To use this connector in PowerApps, learn more here.

Throttling Limits

Name Calls Renewal Period
API calls per connection 600 60 seconds

Creating a connection

To connect your account, you will need the following information:

Authentication Type
string
Authentication type to connect to your database
Username
securestring
Username credential
Password
securestring
Password credential
Gateway
gatewaySetting

Actions

Add attachment

Adds a new attachment to the specified list item.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
List Name
string
SharePoint list name.
Id
integer
Id of the list item to attach the file to.
File Name
string
File name.
File Content
binary
Content of the file.

Returns

Body
SPListItemAttachment

SharePoint list item attachment

Approve hub site join request

Approve hub site join request. This will return an approval token that can be used to complete the join request using the join hub site action.

Required Parameters

Hub Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
Requesting Site Id
string
Id of the requesting site.

Returns

Body
ApproveHubSiteJoinResponse

Result object of ApproveHubSiteJoin action

Cancel hub site join request

Cancel hub join request. If applicable, you should specify the same Approval Correlation Id as used in the "Set hub site join status to pending" action.

Required Parameters

Requesting Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.

Optional Parameters

Approval Correlation Id
string
Approval correlation identifier for this request.

Returns

Body
SPListItemAttachment

SharePoint list item attachment

Copy file

Copies a file. Works in a similar way to the "Copy to" command in SharePoint libraries. Returns information about the new file after copy.

Required Parameters

Current Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
File to Copy
string
File Identifier
Destination Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename
Destination Folder
string
Destination Folder
If another file is already there
integer
Pick one of the options available

Returns

Body
SPBlobMetadataResponse

The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized

Copy file (deprecated)

Copies a file to a SharePoint site.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
Source File Path
string
Path to the source file.
Destination File Path
string
Path to the destination file.

Optional Parameters

Overwrite Flag
boolean
Whether or not to overwrite the destination file if it exists.

Returns

Body
BlobMetadata

Blob metadata

Copy folder

Copies a folder. Works in a similar way to the "Copy to" command in SharePoint libraries. Returns information about the new folder after copy.

Required Parameters

Current Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
Folder to Copy
string
File Identifier
Destination Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename
Destination Folder
string
Destination Folder
If another folder is already there
integer
Pick one of the options available

Returns

Body
SPBlobMetadataResponse

The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized

Create file

Uploads a file to a SharePoint site. Make sure to pick an existing library.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
Folder Path
string
Must start with an existing library. Add folders if needed.
File Name
string
Name of the file.
File Content
binary
Content of the file.

Returns

Body
SPBlobMetadataResponse

The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized

Create item

Creates a new item in a SharePoint list.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename
List Name
string
SharePoint list name
Item
dynamic
Item to create

Optional Parameters

Limit Columns by View
string
Avoid column threshold issues by only using columns defined in a view

Returns

The outputs of this operation are dynamic.

Create sharing link for a file or folder.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
Library Name
string
SharePoint library name.
Item Id
integer
Id of the file or folder item.
Link Type
string
The type of sharing link to create
Link Scope
string
Choose who your sharing link gives access to. "Anyone" option will only work if your administrator has enabled it.

Optional Parameters

Link Expiration
date-time
The date after which the link will expire in yyyy-MM-dd format. Only applicable for anonymous links.

Returns

Body
SharingLinkPermission

Internal structure for sharing links

Delete attachment

Deletes the specified attachment.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
List Name
string
SharePoint list name.
Id
integer
Id of the list item the file is attached to.
File Identifier
string
File identifier for the attachment.

Returns

Body
SPListItemAttachment

SharePoint list item attachment

Delete file

Deletes the file specified by the file identifier.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
File Identifier
string
Select a file.

Returns

Body
SPListItemAttachment

SharePoint list item attachment

Delete item

Deletes an item from a SharePoint list.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename
List Name
string
SharePoint list name
Id
integer
Unique identifier of item to be deleted

Returns

Body
SPListItemAttachment

SharePoint list item attachment

Extract folder

Extracts an archive file into a SharePoint folder (example: .zip).

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
Source File Path
string
Path to the source file.
Destination Folder Path
string
Path to the destination folder.

Optional Parameters

Overwrite Flag
boolean
Whether or not to overwrite the destination file if it exists.

Returns

array of BlobMetadata

Get all lists and libraries

Get all lists and libraries.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.

Returns

Body
TablesList

Represents a list of tables.

Get attachment content

Returns file contents using the file identifier. The contents can be copied somewhere else, or be used as an attachment.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
List Name
string
SharePoint list name.
Id
integer
Id of the list item the file is attached to.
File Identifier
string
File identifier for the attachment.

Returns

Attachment Content
binary

The content of the attachment.

Get attachments

Returns the list of attachments for the specified list item. You can add a "Get attachment content" step and use the "File identifier" property returned by this action to get to the contents of the file.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
List Name
string
SharePoint list name.
Id
string
Id of the list item to get attachments from.

Returns

Get entity values

Gets possible values for a SharePoint entity.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
List Name
string
SharePoint list name.
Entity Id
string
Entity id.

Returns

Body
SPListItemAttachment

SharePoint list item attachment

Get file content

Gets file contents using the file identifier. The contents can be copied somewhere else, or be used as an attachment.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
File Identifier
string
Select a file.

Optional Parameters

Infer Content Type
boolean
Infer content-type based on extension.

Returns

File Content
binary

The content of the file.

Get file content using path

Gets file contents using the file path.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
File Path
string
Select a file.

Optional Parameters

Infer Content Type
boolean
Infer content-type based on extension.

Returns

File Content
binary

The content of the file.

Get file metadata

Gets information about the file such as size, etag, created date, etc. Uses a file identifier to pick the file. Use "Get file properties" action to get to the values stored in the columns in the library.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
File Identifier
string
Select a file.

Returns

Body
SPBlobMetadataResponse

The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized

Get file metadata using path

Gets information about the file such as size, etag, created date, etc. Uses a file path to pick the file. Use "Get file properties" action to get to the values stored in the columns in the library.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
File Path
string
Select a file.

Returns

Body
SPBlobMetadataResponse

The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized

Get file properties

Gets the properties saved in the columns in the library for the item specified by the item id. You can add a "Get file content" step and use the "File identifier" property returned by this action to get to the contents of the file. When using this with the On-Premises Data Gateway, the name of the library to connect to may need to be entered manually.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename
Library Name
string
SharePoint library name
Id
integer
Unique identifier of item to be retrieved

Optional Parameters

Limit Columns by View
string
Avoid column threshold issues by only using columns defined in a view

Returns

The outputs of this operation are dynamic.

Get files (properties only)

Gets the properties saved in the columns in the library for all folders and files stored in the library. You can also filter down to the items that match a condition. An "Apply to each" section is usually used to work with the output from this action. When using this with the On-Premises Data Gateway, the name of the library to connect to may need to be entered manually.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename
Library Name
string
SharePoint library name

Optional Parameters

Filter Query
string
An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).
Order By
string
An ODATA orderBy query for specifying the order of entries.
Top Count
integer
Total number of entries to retrieve (default = all).
Limit Columns by View
string
Avoid column threshold issues by only using columns defined in a view

Returns

The outputs of this operation are dynamic.

Get folder metadata

Gets information about the folder. Uses a file identifier to pick the folder.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
File Identifier
string
Select a folder.

Returns

Body
SPBlobMetadataResponse

The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized

Get folder metadata using path

Gets information about the folder. Uses a folder path to pick the folder.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
Folder Path
string
Select a folder.

Returns

Body
SPBlobMetadataResponse

The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized

Get item

Gets a single item by its id from a SharePoint list.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename
List Name
string
SharePoint list name
Id
integer
Unique identifier of item to be retrieved

Optional Parameters

Limit Columns by View
string
Avoid column threshold issues by only using columns defined in a view

Returns

The outputs of this operation are dynamic.

Get items

Gets items from a SharePoint list.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename
List Name
string
SharePoint list name

Optional Parameters

Filter Query
string
An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).
Order By
string
An ODATA orderBy query for specifying the order of entries.
Top Count
integer
Total number of entries to retrieve (default = all).
Limit Columns by View
string
Avoid column threshold issues by only using columns defined in a view

Returns

The outputs of this operation are dynamic.

Get list views

Gets views from a SharePoint list.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
List Name
string
SharePoint list name.

Returns

Body
TablesList

Represents a list of tables.

Get lists

Gets SharePoint lists from a site.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename

Returns

Body
TablesList

Represents a list of tables.

Join hub site

Join the requested site to the hub site. An Approval Token is required to complete the join successfully if that hub requires approval. If applicable, you should specify the same Approval Correlation Id as used in the "Set hub site join status to pending" action.

Required Parameters

Requesting Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
Hub Site Id
string
Id of the hub site.

Optional Parameters

Approval Token
string
Approval token for this request.
Approval Correlation Id
string
Approval correlation identifier for this request.

Returns

Body
SPListItemAttachment

SharePoint list item attachment

List folder

Returns files contained in a SharePoint folder.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
File Identifier
string
Unique identifier of the folder.

Returns

array of BlobMetadata

List root folder

Returns files in the root SharePoint folder.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.

Returns

array of BlobMetadata

Move file

Moves a file. Works in a similar way to the "Move to" command in SharePoint libraries. Returns information about the new file after move.

Required Parameters

Current Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
File to Move
string
File Identifier
Destination Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename
Destination Folder
string
Destination Folder
If another file is already there
integer
Pick one of the options available

Returns

Body
SPBlobMetadataResponse

The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized

Move folder

Moves a folder. Works in a similar way to the "Move to" command in SharePoint libraries. Returns information about the new folder after move.

Required Parameters

Current Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
Folder to Move
string
File Identifier
Destination Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename
Destination Folder
string
Destination Folder
If another folder is already there
integer
Pick one of the options available

Returns

Body
SPBlobMetadataResponse

The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized

Resolve person

Returns a single matching user value so it can be assigned to a column of type person. If there are no matches, or multiple matches, this action will error out.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
List or Library
string
Pick the list or library that the column is in.
Column
string
Pick the column you want to assign the value to.
Email or name
string
Use the email address, or the full name of the user.

Optional Parameters

Limit Columns by View
string
Avoid column threshold issues by only using columns defined in a view.

Returns

Body
SPListExpandedUser

SharePoint expanded user field

Send an HTTP request to SharePoint

Construct a SharePoint REST API to invoke. Note – This action may execute any SharePoint REST API you have access to. Please proceed with caution.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
Method
string
Http Method
Uri
string
Example: _api/web/lists/getbytitle('Documents')

Optional Parameters

Body
string
Enter request content in JSON

Returns

Body
SPListItemAttachment

SharePoint list item attachment

Set content approval status

Sets the content approval status for an item in a list or library that has content approval turned on. You must provide an ETag for pages and files. You can get the ETag using the Get File Metadata action. This action is only available for SharePoint Online and SharePoint 2019.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
Library Name
string
SharePoint library name.
Id
integer
Id of the item you are setting the status of.
Action
string
Pick the approval action.

Optional Parameters

Comments
string
Add the comments from the approver.
ETag
string
Add an ETag (required for files and pages).

Returns

Body
SetApprovalStatusOutput

SetApprovalStatus output

Set hub site join status to pending

Set the requested site's hub join request status to pending. The Approval Correlation Id is an optional parameter that helps SharePoint identify a particular hub join request. The requesting site can only have one pending request at a given time.

Required Parameters

Requesting Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.

Optional Parameters

Approval Correlation Id
string
Approval correlation identifier for this request.

Returns

Body
SPListItemAttachment

SharePoint list item attachment

Update file

Updates the contents of the file specified by the file identifier.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
File Identifier
string
Select a file.
File Content
binary
Content of the file.

Returns

Body
BlobMetadataResponse

Represents blob datasets metadata response

Update file properties

Updates the properties stored in columns in a library for the item specified by the item id. Use "Update file" action to update file contents. When using this with the On-Premises Data Gateway, the name of the library to connect to may need to be entered manually.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename
Library Name
string
SharePoint library name
Id
integer
Unique identifier of item to be updated
Item
dynamic
Item with changed properties

Optional Parameters

Limit Columns by View
string
Avoid column threshold issues by only using columns defined in a view

Returns

The outputs of this operation are dynamic.

Update item

Updates an item in a SharePoint list.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename
List Name
string
SharePoint list name
Id
integer
Unique identifier of item to be updated
Item
dynamic
Item with changed properties

Optional Parameters

Limit Columns by View
string
Avoid column threshold issues by only using columns defined in a view

Returns

The outputs of this operation are dynamic.

Triggers

When a file is created (properties only)

Triggers when an item is created in a library. Returns only the properties stored in the library columns. You can add a "Get file content" step and use the "File identifier" property returned by this action to get to the contents of the file. When using this with the On-Premises Data Gateway, the name of the library to connect to may need to be entered manually.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename
Library Name
string
SharePoint library name

Optional Parameters

Folder
string
Select a folder, or leave blank for the whole library
Limit Columns by View
string
Avoid column threshold issues by only using columns defined in a view

Returns

The outputs of this operation are dynamic.

When a file is created in a folder

Triggers when a file is created in a SharePoint folder.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
Folder Id
string
Select a folder.

Optional Parameters

Infer Content Type
boolean
Infer content-type based on extension.

Returns

File Content
binary

The content of the file.

When a file is created or modified (properties only)

Triggers when an item is created, or modified in a library. Returns only the properties stored in the library columns. You can add a "Get file content" step and use the "File identifier" property returned by this action to get to the contents of the file. When using this with the On-Premises Data Gateway, the name of the library to connect to may need to be entered manually.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename
Library Name
string
SharePoint library name

Optional Parameters

Folder
string
Select a folder, or leave blank for the whole library
Limit Columns by View
string
Avoid column threshold issues by only using columns defined in a view

Returns

The outputs of this operation are dynamic.

When a file is created or modified in a folder

Triggers when a file is created, and also each time it is modified in a SharePoint folder.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename.
Folder Id
string
Select a folder.

Optional Parameters

Infer Content Type
boolean
Infer content-type based on extension.

Returns

File Content
binary

The content of the file.

When a file is deleted

Triggers when a file is deleted in a library. You can optionally specify a folder to watch as well. When a folder is deleted, the trigger will fire only once for the deleted folder

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename
Library Name
string
SharePoint library name

Optional Parameters

Folder
string
Select a folder, or leave blank for the whole library

Returns

Body
DeletedItemList

List of Deleted items

When an item is created

Triggers when an item is created.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename
List Name
string
SharePoint list name

Optional Parameters

Limit Columns by View
string
Avoid column threshold issues by only using columns defined in a view

Returns

The outputs of this operation are dynamic.

When an item is created or modified

Triggers when an item is created, and also each time it is modified.

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename
List Name
string
SharePoint list name

Optional Parameters

Limit Columns by View
string
Avoid column threshold issues by only using columns defined in a view

Returns

The outputs of this operation are dynamic.

When an item is deleted

Triggers when an item is deleted in a list

Required Parameters

Site Address
string
Example: https://contoso.sharepoint.com/sites/sitename
List Name
string
SharePoint list name

Returns

Body
DeletedItemList

List of Deleted items

Definitions

Internal structure for sharing links

Sharing Link
string
A link to the item

SharingLinkPermission

Internal structure for sharing links

link
SharingLink
Internal structure for sharing links

TablesList

Represents a list of tables.

value
array of Table
List of Tables

Table

Represents a table.

DisplayName
string
The display name of the table.
DynamicProperties
object
Additional table properties provided by the connector to the clients.
Name
string
The name of the table. The name is used at runtime.

SPBlobMetadataResponse

The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized

DisplayName
string
The display name of the file or folder.
ETag
string
The etag of the file or folder.
FileLocator
string
The filelocator of the file or folder.
Id
string
The unique id of the file or folder.
IsFolder
boolean
A boolean value (true, false) to indicate whether or not the blob is a folder.
ItemId
integer
The value that can be used to Get or Update file properties in libraries.
LastModified
date-time
The date and time the file or folder was last modified.
MediaType
string
The media type of the file or folder.
Name
string
The name of the file or folder.
Path
string
The path of the file or folder.
Size
integer
The size of the file or folder.

BlobMetadataResponse

Represents blob datasets metadata response

DisplayName
string
The display name of the file or folder.
ETag
string
The etag of the file or folder.
FileLocator
string
The filelocator of the file or folder.
Id
string
The unique id of the file or folder.
IsFolder
boolean
A boolean value (true, false) to indicate whether or not the blob is a folder.
LastModified
date-time
The date and time the file or folder was last modified.
MediaType
string
The media type of the file or folder.
Name
string
The name of the file or folder.
Path
string
The path of the file or folder.
Size
integer
The size of the file or folder.

BlobMetadata

Blob metadata

DisplayName
string
The display name of the file or folder.
ETag
string
The etag of the file or folder.
FileLocator
string
The filelocator of the file or folder.
Id
string
The unique id of the file or folder.
IsFolder
boolean
A boolean value (true, false) to indicate whether or not the blob is a folder.
LastModified
date-time
The date and time the file or folder was last modified.
MediaType
string
The media type of the file or folder.
Name
string
The name of the file or folder.
Path
string
The path of the file or folder.
Size
integer
The size of the file or folder.

SPListExpandedUser

SharePoint expanded user field

@odata.type
string
SharePoint expanded user field
Claims
string
user claims
Department
string
user department
DisplayName
string
user title
Email
string
user email
JobTitle
string
user job title
Picture
string
user picture

SetApprovalStatusOutput

SetApprovalStatus output

ApprovalLink
string
A link to the item that needs approval
ETag
string
ETag of the item after the approval status was set

SPListItemAttachment

SharePoint list item attachment

AbsoluteUri
string
Link to attachment
DisplayName
string
Name
Id
string
File identifier

ApproveHubSiteJoinResponse

Result object of ApproveHubSiteJoin action

ApprovalToken
string
Approval Token

DeletedItemList

List of Deleted items

value
array of DeletedItem
List of Deleted Items

DeletedItem

An item deleted from a SharePoint list or library

Deleted by
string
The name of the user who deleted this item
Filename with extension
string
File name with extension of the item in document libraries, same as Name of the item in lists
ID
integer
List item id
Is folder
boolean
A true/false value to indicate if the item is a folder
Name
string
File name of the item in document libraries, display name of the item in lists
Time deleted
date-time
When this item was deleted