Ask Learn
Preview
Ask Learn is an AI assistant that can answer questions, clarify concepts, and define terms using trusted Microsoft documentation.
Please sign in to use Ask Learn.
Sign inThis browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
SharePoint helps organizations share and collaborate with colleagues, partners, and customers. You can connect to SharePoint Online or to an on-premises SharePoint 2016 or 2019 farm using the On-Premises Data Gateway to manage documents and list items.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Copilot Studio | Standard | All Power Automate regions |
Logic Apps | Standard | All Logic Apps regions |
Power Apps | Standard | All Power Apps regions |
Power Automate | Standard | All Power Automate regions |
Contact | |
---|---|
Name | Microsoft |
URL | Microsoft LogicApps Support Microsoft Power Automate Support Microsoft Power Apps Support |
Connector Metadata | |
---|---|
Publisher | Microsoft |
Website | https://products.office.com/sharepoint/collaboration |
Notes
See the Power Apps SharePoint documentation
See the Power Apps SharePoint delegation documentation
Name | Value |
---|---|
Maximum number of megabytes being transferred to/from the connector within a bandwidth time interval (per connection) | 1000 |
Bandwidth time interval (in miliseconds) | 60000 |
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
Gateway | gatewaySetting | On-prem gateway (see https://docs.microsoft.com/data-integration/gateway for more details | |
Authentication Type | string | Authentication type to connect to your database | |
Username | securestring | Username credential | True |
Password | securestring | Password credential | True |
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 600 | 60 seconds |
Add attachment |
Adds a new attachment to the specified list item. |
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. |
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. |
Check if the scheduled version of the item is published [DEPRECATED] |
Returns the result in the output variable IsFilePublished. |
Check in file |
Check in a checked out file in a document library, which makes the version of the document available to others. |
Check out file |
Check out a file in a document library to prevent others from editing the document, and your changes from being visible until the documented is checked in. |
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. |
Copy file (deprecated) |
Copies a file to a SharePoint site. |
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. |
Create an approval request for an item or file |
Creates an approval request for an item or file. |
Create file |
Uploads a file to a SharePoint site. Make sure to pick an existing library. |
Create item |
Creates a new item in a SharePoint list. |
Create new document set |
Creates a new document set list item. |
Create new folder |
Creates a new folder or folder path. |
Create sharing link for a file or folder |
Create sharing link for a file or folder. |
Delete attachment |
Deletes the specified attachment. |
Delete file |
Deletes the file specified by the file identifier. |
Delete item |
Deletes an item from a SharePoint list. |
Discard check out |
If you check out a file and don’t make changes to it, or you make changes that you don’t want to keep, you can simply discard the checkout, rather than saving the file. If your organization tracks versions, a new version is created each time you check a file back into the library. By discarding the checkout, you can avoid making new versions when you haven’t made any changes to the file. |
Extract folder |
Extracts an archive file into a SharePoint folder (example: .zip). |
Generate document using Microsoft Syntex (preview) |
Use this action to create documents based on modern templates from Microsoft Syntex. This preview requires a Syntex license. Pricing is subject to change. For more info see: https://docs.microsoft.com/en-us/microsoft-365/contentunderstanding/content-assembly. |
Get all lists and libraries |
Get all lists and libraries. |
Get attachment content |
Returns file contents using the file identifier. The contents can be copied somewhere else, or be used as an 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. |
Get changes for an item or a file (properties only) |
Returns information about columns that have changed within a given time window. Note: The list must have Versioning turned on. |
Get file content |
Gets file contents using the file identifier. The contents can be copied somewhere else, or be used as an attachment. |
Get file content using path |
Gets file contents using the file path. |
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. |
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. |
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. |
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. |
Get folder metadata |
Gets information about the folder. Uses a file identifier to pick the folder. |
Get folder metadata using path |
Gets information about the folder. Uses a folder path to pick the folder. |
Get item |
Gets a single item by its id from a SharePoint list. |
Get items |
Gets items from a SharePoint list. |
Get list views |
Gets views from a SharePoint list. |
Get lists |
Gets SharePoint lists from a site. |
Grant access to an item or a folder |
Grant access to an item or a folder in SharePoint to specific people. |
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. |
List folder |
Returns files contained in a SharePoint folder. |
List root folder |
Returns files in the root SharePoint folder. |
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. |
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. |
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. |
Send an HTTP request to Share |
Construct a SharePoint REST API to invoke. Note – This action may execute any SharePoint REST API you have access to. Please proceed with caution. |
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. |
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. |
Stop sharing an item or a file |
Delete all links giving access to an item or a file and remove all people with direct access except for owners. |
Update file |
Updates the contents of the file specified by the file identifier. |
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. |
Update file properties using AI Builder model results |
Updates the values stored in library columns for a file analyzed by the model specified by the ModelId. |
Update item |
Updates an item in a SharePoint list. |
Adds a new attachment to the specified list item.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
List Name
|
table | True | string |
SharePoint list name. |
Id
|
itemId | True | integer |
Id of the list item to attach the file to. |
File Name
|
displayName | True | string |
File name. |
File Content
|
body | True | binary |
Content of the file. |
SharePoint list item attachment
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.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Hub Site Address
|
dataset | True | string |
Example: |
Requesting Site Id
|
joiningSiteId | True | string |
Id of the requesting site. |
Result object of ApproveHubSiteJoin action
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.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Requesting Site Address
|
dataset | True | string |
Example: |
Approval Correlation Id
|
approvalCorrelationId | string |
Approval correlation identifier for this request. |
Returns the result in the output variable IsFilePublished.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Library Name
|
table | True | string |
SharePoint library name. |
Item ID
|
id | True | integer |
Unique identifier of the file. |
Scheduled Version
|
scheduledVersion | True | string |
Version of file that was scheduled for publish. |
Output object of the CheckIfFileIsPublished endpoint on the SPO Connector shim
Check in a checked out file in a document library, which makes the version of the document available to others.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Library Name
|
table | True | string |
SharePoint library name. |
Id
|
id | True | integer |
Id of the list item the file is attached to. |
Comments
|
comment | True | string |
Type comments describing what has changed in this version |
Check in type
|
checkinType | True | integer |
Select the type of version you would like to check in |
Check out a file in a document library to prevent others from editing the document, and your changes from being visible until the documented is checked in.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Library Name
|
table | True | string |
SharePoint library name. |
Id
|
id | True | integer |
Id of the list item the file is attached to. |
Copies a file. Works in a similar way to the "Copy to" command in SharePoint libraries. Returns information about the new file after copy.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Current Site Address
|
dataset | True | string |
Example: |
File to Copy
|
sourceFileId | True | string |
File Identifier |
Destination Site Address
|
destinationDataset | True | string |
Example: |
Destination Folder
|
destinationFolderPath | True | string |
Destination Folder |
If another file is already there
|
nameConflictBehavior | True | integer |
Pick one of the options available |
The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized
Copies a file to a SharePoint site.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Source File Path
|
source | True | string |
Path to the source file. |
Destination File Path
|
destination | True | string |
Path to the destination file. |
Overwrite Flag
|
overwrite | boolean |
Whether or not to overwrite the destination file if it exists. |
Blob metadata
Copies a folder. Works in a similar way to the "Copy to" command in SharePoint libraries. Returns information about the new folder after copy.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Current Site Address
|
dataset | True | string |
Example: |
Folder to Copy
|
sourceFolderId | True | string |
File Identifier |
Destination Site Address
|
destinationDataset | True | string |
Example: |
Destination Folder
|
destinationFolderPath | True | string |
Destination Folder |
If another folder is already there
|
nameConflictBehavior | True | integer |
Pick one of the options available |
The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized
Creates an approval request for an item or file.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
List or Library
|
table | True | string |
SharePoint list or library name. |
Id
|
id | True | integer |
Id of the item the approval request is being created for. |
Approval Type
|
approvalType | True | integer |
Select an approval type. |
Approval Schema
|
approvalSchema | True | dynamic |
Schema for the selected approval type. |
Output object of the new approval request
Uploads a file to a SharePoint site. Make sure to pick an existing library.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Folder Path
|
folderPath | True | string |
Must start with an existing library. Add folders if needed. |
File Name
|
name | True | string |
Name of the file. |
File Content
|
body | True | binary |
Content of the file. |
The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized
Creates a new item in a SharePoint list.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
List Name
|
table | True | string |
SharePoint list name |
Item
|
item | True | dynamic |
Item to create |
Limit Columns by View
|
view | string |
Avoid column threshold issues by only using columns defined in a view |
Creates a new document set list item.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Library
|
table | True | string |
SharePoint library name. |
Document Set Path
|
path | True | string |
Example: folder1/folder2/dsName |
Content Type Id
|
contentTypeId | True | string |
Example: 0x0120D520 |
DynamicProperties
|
DynamicProperties | object |
Creates a new folder or folder path.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
List or Library
|
table | True | string |
SharePoint list or library name. |
Folder Path
|
path | True | string |
Example: folder1/folder2/folder3 |
Limit Columns by View
|
view | string |
Avoid column threshold issues by only using columns defined in a view. |
Create sharing link for a file or folder.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Library Name
|
table | True | string |
SharePoint library name. |
Item Id
|
id | True | integer |
Id of the file or folder item. |
Link Type
|
type | True | string |
The type of sharing link to create |
Link Scope
|
scope | True | string |
Choose who your sharing link gives access to. "Anyone" option will only work if your administrator has enabled it. |
Link Expiration
|
expirationDateTime | date-time |
The date after which the link will expire in yyyy-MM-dd format. Only applicable for anonymous links. |
Internal structure for sharing links
Deletes the specified attachment.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
List Name
|
table | True | string |
SharePoint list name. |
Id
|
itemId | True | integer |
Id of the list item the file is attached to. |
File Identifier
|
attachmentId | True | string |
File identifier for the attachment. |
Deletes the file specified by the file identifier.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
File Identifier
|
id | True | string |
Select a file. |
Deletes an item from a SharePoint list.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
List Name
|
table | True | string |
SharePoint list name |
Id
|
id | True | integer |
Unique identifier of item to be deleted |
If you check out a file and don’t make changes to it, or you make changes that you don’t want to keep, you can simply discard the checkout, rather than saving the file. If your organization tracks versions, a new version is created each time you check a file back into the library. By discarding the checkout, you can avoid making new versions when you haven’t made any changes to the file.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Library Name
|
table | True | string |
SharePoint library name. |
Id
|
id | True | integer |
Id of the list item the file is attached to. |
Extracts an archive file into a SharePoint folder (example: .zip).
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Source File Path
|
source | True | string |
Path to the source file. |
Destination Folder Path
|
destination | True | string |
Path to the destination folder. |
Overwrite Flag
|
overwrite | boolean |
Whether or not to overwrite the destination file if it exists. |
Use this action to create documents based on modern templates from Microsoft Syntex. This preview requires a Syntex license. Pricing is subject to change. For more info see: https://docs.microsoft.com/en-us/microsoft-365/contentunderstanding/content-assembly.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Document Library Name
|
table | True | string |
SharePoint document library name. |
Document Template
|
template | True | string |
Document template. |
Placeholders
|
item | True | dynamic |
Document placeholder values. |
Folder Path
|
folderPath | string |
Must start with an existing library. |
|
File Name
|
fileName | string |
Document file name. |
|
View (no effect)
|
view | string |
This parameter does nothing. Please do not use. |
The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized
Get all lists and libraries.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Represents a list of tables.
Returns file contents using the file identifier. The contents can be copied somewhere else, or be used as an attachment.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
List Name
|
table | True | string |
SharePoint list name. |
Id
|
itemId | True | integer |
Id of the list item the file is attached to. |
File Identifier
|
attachmentId | True | string |
File identifier for the attachment. |
The content of the attachment.
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.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
List Name
|
table | True | string |
SharePoint list name. |
Id
|
itemId | True | string |
Id of the list item to get attachments from. |
Returns information about columns that have changed within a given time window. Note: The list must have Versioning turned on.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
List or Library Name
|
table | True | string |
SharePoint list or library name. |
Id
|
id | True | integer |
Id of the item you want to fetch changes for. |
Since
|
since | True | string |
Trigger Window Start token or an item version label (ex: 3.0) or an ISO 8601 date (YYYY-MM-DDThh:mmZ). |
Until
|
until | string |
Trigger Window End token or an item version label (ex: 3.0) or an ISO 8601 date (YYYY-MM-DDThh:mmZ). If blank, defaults to latest version. |
|
Include Minor Versions
|
includeDrafts | boolean |
Boolean for whether to consider changes from minor (draft) versions. |
|
Limit Columns by View
|
view | string |
Returns only columns defined in a view. |
Gets file contents using the file identifier. The contents can be copied somewhere else, or be used as an attachment.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
File Identifier
|
id | True | string |
Select a file. |
Infer Content Type
|
inferContentType | boolean |
Infer content-type based on extension. |
The content of the file.
Gets file contents using the file path.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
File Path
|
path | True | string |
Select a file. |
Infer Content Type
|
inferContentType | boolean |
Infer content-type based on extension. |
The content of the file.
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.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
File Identifier
|
id | True | string |
Select a file. |
The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized
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.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
File Path
|
path | True | string |
Select a file. |
The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized
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.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Library Name
|
table | True | string |
SharePoint library name |
Id
|
id | True | integer |
Unique identifier of item to be retrieved |
Limit Columns by View
|
view | string |
Avoid column threshold issues by only using columns defined in a view |
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.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Library Name
|
table | True | string |
SharePoint library name |
Filter Query
|
$filter | string |
An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123). |
|
Order By
|
$orderby | string |
An ODATA orderBy query for specifying the order of entries. |
|
Top Count
|
$top | integer |
Total number of entries to retrieve (default = all). |
|
Limit Entries to Folder
|
folderPath | string |
Select a folder, or leave blank for the whole library |
|
Include Nested Items
|
viewScopeOption | string |
Return entries contained in sub-folders (default = true) |
|
Limit Columns by View
|
view | string |
Avoid column threshold issues by only using columns defined in a view |
Gets information about the folder. Uses a file identifier to pick the folder.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
File Identifier
|
id | True | string |
Select a folder. |
The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized
Gets information about the folder. Uses a folder path to pick the folder.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Folder Path
|
path | True | string |
Select a folder. |
The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized
Gets a single item by its id from a SharePoint list.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
List Name
|
table | True | string |
SharePoint list name |
Id
|
id | True | integer |
Unique identifier of item to be retrieved |
Limit Columns by View
|
view | string |
Avoid column threshold issues by only using columns defined in a view |
Gets items from a SharePoint list.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
List Name
|
table | True | string |
SharePoint list name |
Filter Query
|
$filter | string |
An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123). |
|
Order By
|
$orderby | string |
An ODATA orderBy query for specifying the order of entries. |
|
Top Count
|
$top | integer |
Total number of entries to retrieve (default = all). |
|
Limit Entries to Folder
|
folderPath | string |
Select a folder, or leave blank for the whole list |
|
Include Nested Items
|
viewScopeOption | string |
Return entries contained in sub-folders (default = true) |
|
Limit Columns by View
|
view | string |
Avoid column threshold issues by only using columns defined in a view |
Gets views from a SharePoint list.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
List Name
|
table | True | string |
SharePoint list name. |
Gets SharePoint lists from a site.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Represents a list of tables.
Grant access to an item or a folder in SharePoint to specific people.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
List or Library Name
|
table | True | string |
SharePoint list or library name. |
Id
|
id | True | integer |
Unique identifier of the item or folder you want to grant access to. |
Recipients
|
recipients | True |
A collection of recipients who will receive the sharing invitation |
|
Roles
|
roleValue | True | string |
Specify a role that is to be granted to the recipients |
Message
|
emailBody | string |
A plain text formatted message that is included in the sharing invitation |
|
Notify Recipients
|
sendEmail | boolean |
Specify whether recipients should receive an email notification message |
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.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Requesting Site Address
|
dataset | True | string |
Example: |
Hub Site Id
|
hubSiteId | True | string |
Id of the hub site. |
Approval Token
|
approvalToken | string |
Approval token for this request. |
|
Approval Correlation Id
|
approvalCorrelationId | string |
Approval correlation identifier for this request. |
Returns files contained in a SharePoint folder.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
File Identifier
|
id | True | string |
Unique identifier of the folder. |
Returns files in the root SharePoint folder.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Moves a file. Works in a similar way to the "Move to" command in SharePoint libraries. Returns information about the new file after move.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Current Site Address
|
dataset | True | string |
Example: |
File to Move
|
sourceFileId | True | string |
File Identifier |
Destination Site Address
|
destinationDataset | True | string |
Example: |
Destination Folder
|
destinationFolderPath | True | string |
Destination Folder |
If another file is already there
|
nameConflictBehavior | True | integer |
Pick one of the options available |
The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized
Moves a folder. Works in a similar way to the "Move to" command in SharePoint libraries. Returns information about the new folder after move.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Current Site Address
|
dataset | True | string |
Example: |
Folder to Move
|
sourceFolderId | True | string |
File Identifier |
Destination Site Address
|
destinationDataset | True | string |
Example: |
Destination Folder
|
destinationFolderPath | True | string |
Destination Folder |
If another folder is already there
|
nameConflictBehavior | True | integer |
Pick one of the options available |
The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized
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.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
List or Library
|
table | True | string |
Pick the list or library that the column is in. |
Column
|
entityId | True | string |
Pick the column you want to assign the value to. |
Email or name
|
searchValue | True | string |
Use the email address, or the full name of the user. |
Limit Columns by View
|
view | string |
Avoid column threshold issues by only using columns defined in a view. |
SharePoint expanded user field
Construct a SharePoint REST API to invoke. Note – This action may execute any SharePoint REST API you have access to. Please proceed with caution.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Method
|
method | True | string |
Http Method |
Uri
|
uri | True | string |
Example: _api/web/lists/getbytitle('Documents') |
Headers
|
headers | object |
Enter JSON object of request headers |
|
Body
|
body | string |
Enter request content in JSON |
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.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Library Name
|
table | True | string |
SharePoint library name. |
Id
|
id | True | integer |
Id of the item you are setting the status of. |
Action
|
approvalAction | True | string |
Pick the approval action. |
Comments
|
comments | string |
Add the comments from the approver. |
|
ETag
|
entityTag | string |
Add an ETag (required for files and pages). |
SetApprovalStatus output
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.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Requesting Site Address
|
dataset | True | string |
Example: |
Approval Correlation Id
|
approvalCorrelationId | string |
Approval correlation identifier for this request. |
Delete all links giving access to an item or a file and remove all people with direct access except for owners.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
List or Library Name
|
table | True | string |
SharePoint list or library name. |
Id
|
id | True | integer |
Unique identifier of the item or file you want to stop sharing. |
Updates the contents of the file specified by the file identifier.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
File Identifier
|
id | True | string |
Select a file. |
File Content
|
body | True | binary |
Content of the file. |
Represents blob datasets metadata response
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.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Library Name
|
table | True | string |
SharePoint library name |
Id
|
id | True | integer |
Unique identifier of item to be updated |
Item
|
item | True | dynamic |
Item with changed properties |
Limit Columns by View
|
view | string |
Avoid column threshold issues by only using columns defined in a view |
Updates the values stored in library columns for a file analyzed by the model specified by the ModelId.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Library Name
|
table | True | string |
Library Name. |
Id
|
id | True | integer |
Unique identifier of item to be updated. |
ModelId
|
modelId | string |
Enter modelId of the Model which is used for prediction |
|
PredictResult
|
predictResult | string |
Enter request content in JSON |
Updates an item in a SharePoint list.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
List Name
|
table | True | string |
SharePoint list name |
Id
|
id | True | integer |
Unique identifier of item to be updated |
Item
|
item | True | dynamic |
Item with changed properties |
Limit Columns by View
|
view | string |
Avoid column threshold issues by only using columns defined in a view |
For a selected file |
This trigger allows you to start a flow for a selected file. Inputs: Site Address, Library Name. Outputs: Name, Link to Item, ID. (Available only for Power Automate.) |
For a selected item |
This trigger allows you to start a flow for a selected item in a SharePoint list or library. You can use the columns of the list or library as output parameters. For a file, you can use the "identifier" column to get file content. (Available only for Power Automate.) |
When a file is classified by a Microsoft Syntex model |
Triggers a flow when Microsoft Syntex changes the classification date of any file in the library. The date changes when a document processing model classifies or extracts information. |
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. |
When a file is created in a folder (deprecated) |
Triggers when a file is created in a SharePoint folder. The trigger does not fire if a file is added/updated in a subfolder. If it is required to trigger on subfolders, multiple triggers should be created. |
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. |
When a file is created or modified in a folder (deprecated) |
Triggers when a file is created, and also each time it is modified in a SharePoint folder. The trigger does not fire if a file is added/updated in a subfolder. If it is required to trigger on subfolders, multiple triggers should be created. |
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. This can only be used by site collection admins of the site where the list is located. |
When a site has requested to join a hub site |
Triggers a flow upon hub site join approval. (Available only for Power Automate.) |
When an item is created |
Triggers when an item is created. |
When an item is created or modified |
Triggers when an item is created, and also each time it is modified. |
When an item is deleted |
Triggers when an item is deleted in a list. This can only be used by site collection admins of the site where the list is located. |
When an item or a file is modified |
Triggers when an item is modified (but not when it is created). |
This trigger allows you to start a flow for a selected file. Inputs: Site Address, Library Name. Outputs: Name, Link to Item, ID. (Available only for Power Automate.)
Name | Key | Required | Type | Description |
---|---|---|---|---|
operationId
|
operationId | True | string | |
host
|
host | object | ||
parameters
|
parameters | True | object | |
schema
|
schema | True | object | |
headersSchema
|
headersSchema | object |
Name | Path | Type | Description |
---|---|---|---|
rows
|
body.rows | array of object | |
ID
|
body.rows.ID | integer |
File Identifier |
itemUrl
|
body.rows.itemUrl | string |
File Url |
fileName
|
body.rows.fileName | string |
File Name |
User id
|
headers.x-ms-user-id-encoded | guid |
The unique identifier of the user who triggered the flow in AAD. |
User email
|
headers.x-ms-user-email-encoded | byte |
The email address of the user who triggered the flow. |
User name
|
headers.x-ms-user-name-encoded | byte |
The display name of the user who triggered the flow. |
Timestamp
|
headers.x-ms-user-timestamp | string |
The time the flow was triggered. |
This trigger allows you to start a flow for a selected item in a SharePoint list or library. You can use the columns of the list or library as output parameters. For a file, you can use the "identifier" column to get file content. (Available only for Power Automate.)
Name | Key | Required | Type | Description |
---|---|---|---|---|
operationId
|
operationId | True | string | |
host
|
host | object | ||
parameters
|
parameters | True | object | |
schema
|
schema | True | object | |
headersSchema
|
headersSchema | object |
Name | Path | Type | Description |
---|---|---|---|
rows
|
body.rows | array of object | |
ID
|
body.rows.ID | integer |
File Identifier |
itemUrl
|
body.rows.itemUrl | string |
File Url |
fileName
|
body.rows.fileName | string |
File Name |
User id
|
headers.x-ms-user-id-encoded | guid |
The unique identifier of the user who triggered the flow in AAD. |
User email
|
headers.x-ms-user-email-encoded | byte |
The email address of the user who triggered the flow. |
User name
|
headers.x-ms-user-name-encoded | byte |
The display name of the user who triggered the flow. |
Timestamp
|
headers.x-ms-user-timestamp | string |
The time the flow was triggered. |
Triggers a flow when Microsoft Syntex changes the classification date of any file in the library. The date changes when a document processing model classifies or extracts information.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Library Name
|
table | True | string |
SharePoint library name |
Folder
|
folderPath | string |
Select a folder, or leave blank for the whole library |
|
Limit Columns by View
|
view | string |
Avoid column threshold issues by only using columns defined in a view |
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.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Library Name
|
table | True | string |
SharePoint library name |
Folder
|
folderPath | string |
Select a folder, or leave blank for the whole library |
|
Limit Columns by View
|
view | string |
Avoid column threshold issues by only using columns defined in a view |
Triggers when a file is created in a SharePoint folder. The trigger does not fire if a file is added/updated in a subfolder. If it is required to trigger on subfolders, multiple triggers should be created.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Folder Id
|
folderId | True | string |
Select a folder. |
Infer Content Type
|
inferContentType | boolean |
Infer content-type based on extension. |
The content of the file.
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.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Library Name
|
table | True | string |
SharePoint library name |
Folder
|
folderPath | string |
Select a folder, or leave blank for the whole library |
|
Limit Columns by View
|
view | string |
Avoid column threshold issues by only using columns defined in a view |
Triggers when a file is created, and also each time it is modified in a SharePoint folder. The trigger does not fire if a file is added/updated in a subfolder. If it is required to trigger on subfolders, multiple triggers should be created.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Folder Id
|
folderId | True | string |
Select a folder. |
Infer Content Type
|
inferContentType | boolean |
Infer content-type based on extension. |
The content of the file.
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. This can only be used by site collection admins of the site where the list is located.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
Library Name
|
table | True | string |
SharePoint library name |
Folder
|
folderPath | string |
Select a folder, or leave blank for the whole library |
List of Deleted items
Triggers a flow upon hub site join approval. (Available only for Power Automate.)
Name | Key | Required | Type | Description |
---|---|---|---|---|
operationId
|
operationId | True | string | |
host
|
host | object | ||
parameters
|
parameters | True | object | |
schema
|
schema | True | object | |
headersSchema
|
headersSchema | object |
Name | Path | Type | Description |
---|---|---|---|
rows
|
body.rows | array of object | |
RequestingSiteUrl
|
body.rows.RequestingSiteUrl | string |
Requesting Site Url |
RequestingSiteId
|
body.rows.RequestingSiteId | string |
Requesting Site Id |
RequestingSiteTitle
|
body.rows.RequestingSiteTitle | string |
Requesting Site Title |
ApprovalCorrelationId
|
body.rows.ApprovalCorrelationId | string |
Approval Correlation Id |
User id
|
headers.x-ms-user-id-encoded | guid |
The unique identifier of the user who triggered the flow in AAD. |
User email
|
headers.x-ms-user-email-encoded | byte |
The email address of the user who triggered the flow. |
User name
|
headers.x-ms-user-name-encoded | byte |
The display name of the user who triggered the flow. |
Timestamp
|
headers.x-ms-user-timestamp | string |
The time the flow was triggered. |
Triggers when an item is created.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
List Name
|
table | True | string |
SharePoint list name |
Limit Columns by View
|
view | string |
Avoid column threshold issues by only using columns defined in a view |
Triggers when an item is created, and also each time it is modified.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
List Name
|
table | True | string |
SharePoint list name |
Limit Columns by View
|
view | string |
Avoid column threshold issues by only using columns defined in a view |
Triggers when an item is deleted in a list. This can only be used by site collection admins of the site where the list is located.
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
List Name
|
table | True | string |
SharePoint list name |
List of Deleted items
Triggers when an item is modified (but not when it is created).
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Address
|
dataset | True | string |
Example: |
List or Library Name
|
table | True | string |
SharePoint list name |
Folder
|
folderPath | string |
Select a folder, or leave blank for the whole library |
|
Limit Columns by View
|
view | string |
Avoid column threshold issues by only using columns defined in a view |
Output object of the new approval request
Name | Path | Type | Description |
---|---|---|---|
Approval Request ID
|
ApprovalId | string |
The ID of the approval request created |
Result object of ApproveHubSiteJoin action
Name | Path | Type | Description |
---|---|---|---|
ApprovalToken
|
ApprovalToken | string |
Approval Token |
Blob metadata
Name | Path | Type | Description |
---|---|---|---|
Id
|
Id | string |
The unique id of the file or folder. |
Name
|
Name | string |
The name of the file or folder. |
DisplayName
|
DisplayName | string |
The display name of the file or folder. |
Path
|
Path | string |
The path of the file or folder. |
LastModified
|
LastModified | date-time |
The date and time the file or folder was last modified. |
Size
|
Size | integer |
The size of the file or folder. |
MediaType
|
MediaType | string |
The media type of the file or folder. |
IsFolder
|
IsFolder | boolean |
A boolean value (true, false) to indicate whether or not the blob is a folder. |
ETag
|
ETag | string |
The etag of the file or folder. |
FileLocator
|
FileLocator | string |
The filelocator of the file or folder. |
Represents blob datasets metadata response
Name | Path | Type | Description |
---|---|---|---|
Id
|
Id | string |
The unique id of the file or folder. |
Name
|
Name | string |
The name of the file or folder. |
DisplayName
|
DisplayName | string |
The display name of the file or folder. |
Path
|
Path | string |
The path of the file or folder. |
LastModified
|
LastModified | date-time |
The date and time the file or folder was last modified. |
Size
|
Size | integer |
The size of the file or folder. |
MediaType
|
MediaType | string |
The media type of the file or folder. |
IsFolder
|
IsFolder | boolean |
A boolean value (true, false) to indicate whether or not the blob is a folder. |
ETag
|
ETag | string |
The etag of the file or folder. |
FileLocator
|
FileLocator | string |
The filelocator of the file or folder. |
An item deleted from a SharePoint list or library
Name | Path | Type | Description |
---|---|---|---|
ID
|
ID | integer |
List item id |
Name
|
Name | string |
File name of the item in document libraries, display name of the item in lists |
Filename with extension
|
FileNameWithExtension | string |
File name with extension of the item in document libraries, same as Name of the item in lists |
Deleted by
|
DeletedByUserName | string |
The name of the user who deleted this item |
Time deleted
|
TimeDeleted | date-time |
When this item was deleted |
Is folder
|
IsFolder | boolean |
A true/false value to indicate if the item is a folder |
List of Deleted items
Name | Path | Type | Description |
---|---|---|---|
value
|
value | array of DeletedItem |
List of Deleted Items |
Output object of the CheckIfFileIsPublished endpoint on the SPO Connector shim
Name | Path | Type | Description |
---|---|---|---|
IsFilePublished
|
IsFilePublished | boolean |
A boolean value (true, false) to indicate whether the scheduled version of the file has been published |
SetApprovalStatus output
Name | Path | Type | Description |
---|---|---|---|
ETag
|
ETag | string |
ETag of the item after the approval status was set |
ApprovalLink
|
ApprovalLink | string |
A link to the item that needs approval |
PublishStartDate
|
PublishStartDate | string |
Date time at which the item will be Published |
ContentApprovalStatus
|
ContentApprovalStatus | string |
The content approval status of the list item |
ScheduledVersion
|
ScheduledVersion | string |
The version of the item that has been scheduled |
Internal structure for sharing links
Name | Path | Type | Description |
---|---|---|---|
Sharing Link
|
webUrl | string |
A link to the item |
Internal structure for sharing links
Name | Path | Type | Description |
---|---|---|---|
link
|
link | SharingLink |
Internal structure for sharing links |
The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized
Name | Path | Type | Description |
---|---|---|---|
ItemId
|
ItemId | integer |
The value that can be used to Get or Update file properties in libraries. |
Id
|
Id | string |
The unique id of the file or folder. |
Name
|
Name | string |
The name of the file or folder. |
DisplayName
|
DisplayName | string |
The display name of the file or folder. |
Path
|
Path | string |
The path of the file or folder. |
LastModified
|
LastModified | date-time |
The date and time the file or folder was last modified. |
Size
|
Size | integer |
The size of the file or folder. |
MediaType
|
MediaType | string |
The media type of the file or folder. |
IsFolder
|
IsFolder | boolean |
A boolean value (true, false) to indicate whether or not the blob is a folder. |
ETag
|
ETag | string |
The etag of the file or folder. |
FileLocator
|
FileLocator | string |
The filelocator of the file or folder. |
SharePoint expanded user field
Name | Path | Type | Description |
---|---|---|---|
Claims
|
Claims | string |
user claims |
DisplayName
|
DisplayName | string |
user title |
Email
|
string |
user email |
|
Picture
|
Picture | string |
user picture |
Department
|
Department | string |
user department |
JobTitle
|
JobTitle | string |
user job title |
@odata.type
|
@odata.type | string |
SharePoint list item attachment
Name | Path | Type | Description |
---|---|---|---|
Id
|
Id | string |
File identifier |
AbsoluteUri
|
AbsoluteUri | string |
Link to attachment |
DisplayName
|
DisplayName | string |
Name |
Represents a table.
Name | Path | Type | Description |
---|---|---|---|
Name
|
Name | string |
The name of the table. The name is used at runtime. |
DisplayName
|
DisplayName | string |
The display name of the table. |
DynamicProperties
|
DynamicProperties | object |
Additional table properties provided by the connector to the clients. |
Represents a list of tables.
Name | Path | Type | Description |
---|---|---|---|
value
|
value | array of Table |
List of Tables |
This is the basic data type 'binary'.
Ask Learn is an AI assistant that can answer questions, clarify concepts, and define terms using trusted Microsoft documentation.
Please sign in to use Ask Learn.
Sign in