Plumsail Actions
Plumsail Actions provides enhanced actions to manage SharePoint, including advanced cross-site operations. It covers all possible permissions, allows you to manage documents, list items and folders, create SharePoint sites, lists or libraries, and manipulate their properties. More information at https://plumsail.com/actions/.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure China regions - US Department of Defense (DoD) |
Power Automate | Standard | All Power Automate regions except the following: - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Standard | All Power Apps regions except the following: - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Support |
URL | https://plumsail.com |
support@plumsail.com |
Connector Metadata | |
---|---|
Publisher | Fuzor LLC |
Website | https://plumsail.com |
Privacy policy | https://plumsail.com/privacy-policy/ |
Categories | Productivity;Content and Files |
SharePoint connector on steroids Standard SharePoint connector for Power Automate and Logic Apps gives basic tools to manage SharePoint. Unfortunately, it doesn’t cover a lot of real-life scenarios including some of cross-site operations. That is where our connector gives you much more power.
First of all, you need to register Plumsail Account. This account is used to manage Plumsail Actions and Plumsail Forms products.
It is better to use your active email address. The subscription will be linked to this address.
If you already have an account, just sign in to account.plumsail.com.
You need to navigate to the "API Keys" section and click "Add new". Then select type of API key according to your needs.
Plumsail Actions will connect to SharePoint using permissions of tenant admin. Fill SharePoint Online address below and grant them by signing in under SharePoint tenant admin user.
Note Though this type of the API key doesn't depand on users' permission level and multi-factor authentication enabled for them, it can't be used with a Create Modern SharePoint Site action.
This type of key allows SharePoint actions to work under account of specific user. You need to fill account name and password for your user:
Note To use this type of the API key, it is necessary to disable multi-factor authentication (MFA) for a user under whose account the key is generated. Actions using the key will have the same level of permissions as the user.
It allows you to execute Plumsail Actions that don’t require access to SharePoint. Use it with Parse CSV, Regular Expression Match and other similar actions.
Once you created an API key, you can see your key right in the "Secret" column. You can also change a name of a key by clicking on it in the "Name" column:
Now you can copy and use it in:
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Shareable |
Applicable: All regions
Parameters for creating connection.
This is shareable connection. If the power app is shared with another user, connection is shared as well. For more information, please see the Connectors overview for canvas apps - Power Apps | Microsoft Docs
Name | Type | Description | Required |
---|---|---|---|
Access Key | securestring | The Access Key for this api | True |
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Activate Share |
Activate a feature with specific ID |
Add Content Type to Share |
Adds the specified content type to a SharePoint list |
Add Share |
Adds a menu item to either the quicklaunch or top navigation |
Add User to Share |
Adds a user to a specific SharePoint group |
Apply Share |
Applies design to target SharePoint site |
Change Share |
Grant, remove and restore permissions for the site, the list, and the item |
Check if Share |
Checks whether a specific SharePoint group exists |
Check In Share |
Check-in the document at the specified URL with the specified comment |
Check Out Share |
Check-out the document at the specified URL |
Copy List Item to Share |
Copies the specified list item to another SharePoint list |
Copy Share |
Copies the document from the document library to the specified URL. You can copy the document to another document library cross-site or to another folder |
Copy Share |
Copies the document set from the document library to the specified URL. You can copy the document sets to another document library cross-site or to another folder |
Copy Share |
Copies the folder from the document library to the specified URL. You can copy the folder to another document library cross-site or to another folder |
Copy Share |
Copies attachments from the SharePoint list item to the library using the specified folder URL |
Create Modern Share |
Creates a modern SharePoint Team or Communication site |
Create Share |
Creates a new document set in the document library by the specified URL |
Create Share |
Creates a new folder in the document library by the specified URL |
Create Share |
Creates a new folder in the document library or list using the specified path |
Create Share |
Creates the SharePoint group with a specified name |
Create Share |
Create list or library by template |
Create Share |
Create a new SharePoint site based on specific template |
Deactivate Share |
Deactivate a feature with specific ID |
Declare Share |
Declares Document in SharePoint Library As Record |
Delete Share |
Deletes the SharePoint site by a specific URL |
Get Members of Share |
Gets members of a specific SharePoint group |
Get Share |
Returns the changes history for the specific field from the SharePoint list item |
Get Share |
Executes a CAML query on a list or on a document library and returns the collection of elements |
Get Share |
Reads a value from SharePoint Site Options (Property Bag) |
Invite External User to Share |
Invites external users with specific permission to an SharePoint site, an specific SharePoint group or an item in a SharePoint list |
Is User Member of Share |
Checks if a user is a member of a specifed SharePoint group |
Move List Item to Share |
Moves the specified list item to another SharePoint list |
Move Share |
Moves the document from the document library to the specified URL. You can copy the document to another document library cross-site or to another folder |
Move Share |
Moves the document set from the document library to the specified URL. You can copy the document sets to another document library cross-site or to another folder |
Move Share |
Moves the folder from the document library to the specified URL. You can move the folder to another document library cross-site or to another folder |
Move Share |
Moves attachments from the SharePoint list item to the library using the specified folder URL |
Parse CSV |
It works like Parse JSON but for CSV file |
Provision PnP Template to Share |
Applies a PnP template to a SharePoint site |
Provision PnP Tenant Template to Share |
Applies a PnP tenant template to SharePoint |
Regular Expression Match |
Searches an input string for all occurrences of a regular expression and returns all the matches. We would recommend you to use Regex Hero to test your expressions. It supports the same syntax as actions |
Regular Expression Replace |
In a specified input string, replaces all strings that match a regular expression pattern with a specified replacement string. We would recommend you to use Regex Hero to test your expressions. It supports the same syntax as actions |
Regular Expression Test |
Indicates whether the regular expression specified in the Regex constructor finds a match in a specified input string. We would recommend you to use Regex Hero to test your expressions. It supports the same syntax as actions |
Remove Share |
Remove the document by a specific URL |
Remove Share |
Removes the folder from the document library or list by the specified URL |
Remove Share |
Removes the SharePoint group by a specified name |
Remove Share |
Removes a menu item from either the quicklaunch or top navigation |
Remove User from Share |
Removes a user from a specific SharePoint group |
Set Default Share |
Configure default groups for a site with the help of Microsoft Flow. It is alternative of the /_layouts/15/permsetup.aspx page in SharePoint UI. |
Start Share |
Starts a SharePoint list level workflow and pass input parameters, if they were specified. The action can run only 2013 workflows |
Start Share |
Starts a SharePoint site level workflow and pass input parameters, if they were specified. The action can run only 2013 workflows |
Undeclare Share |
Undeclares Document in SharePoint Library As Record |
Update Share |
Updates SharePoint group properties like AutoAcceptRequestToJoinLeave, AllowMembersEditMembership or other options described in MSDN |
Update Share |
Updates an item in a SharePoint list or library |
Update Share |
Updates web properties like Title, Description or other string options described in at MSDN |
Activate a feature with specific ID
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Feature ID
|
featureId | True | uuid |
Guid of the feature |
Force
|
force | boolean |
true to force action of the Feature even if there are errors; otherwise, false |
Adds the specified content type to a SharePoint list
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
List URL
|
listUrl | True | string |
List name, URL or Guid |
Content Type Name
|
contentTypeName | True | string |
Name of the content type |
Make It Default
|
makeItDefault | boolean |
Make the content type default for the list |
Adds a menu item to either the quicklaunch or top navigation
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Location
|
location | True | string |
The location of the node to add |
Title
|
title | True | string |
Title of navigation node |
Parent
|
parent | string |
It is the title of a parent navigation item. If there are multiple top-level items with the same title, we will pick only the first. |
|
Url
|
url | string |
Target URL. If the URL is empty, then the top-level navigation item will be created |
|
Prepend
|
prepend | boolean |
Yes or No. The default value is No |
Adds a user to a specific SharePoint group
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Group Name
|
groupName | True | string |
The name of the group |
User
|
userLogin | True | string |
Login or email of the user which will be added to the specific group. Also you can specify multiple items using semicolon ';' delimited |
Send Email
|
sendEmail | boolean |
Disable email notification |
Applies design to target SharePoint site
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
url | True | string |
The full qualified URL (e.g. https://yourtenant.sharepoint.com/sites/team-site) |
Site Design
|
siteDesign | True | string |
The name or identifier of the SharePoint site design |
Returns
- Body
- WebUrlResponse
Grant, remove and restore permissions for the site, the list, and the item
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Action type
|
actionType | True | string |
The type of the operation |
Target
|
target | True | string |
The target of the operation |
request
|
request | True | dynamic |
Checks whether a specific SharePoint group exists
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Group Name
|
groupName | True | string |
The name of the group |
Returns
- Body
- GroupExistResponse
Check-in the document at the specified URL with the specified comment
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Document URL
|
documentUrl | True | string |
The URL of the document to check in |
Comment
|
comment | string |
The comment to accompany document check in |
Returns
- Body
- DocumentInfoResponse
Check-out the document at the specified URL
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Document URL
|
documentUrl | True | string |
The URL of the document to check in |
Returns
- Body
- DocumentInfoResponse
Copies the specified list item to another SharePoint list
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
List URL
|
listUrl | True | string |
List name, URL or Guid |
Item ID
|
itemId | True | string |
The ID of the source item |
Destination List URL
|
destinationListUrl | True | string |
The URL of the destination list. This list must contain same fields like in the source list |
Copy Attachments
|
copyAttachments | boolean |
Copy the item with attached files or not |
Returns
- Body
- ListItemIdResponse
Copies the document from the document library to the specified URL. You can copy the document to another document library cross-site or to another folder
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Source URL
|
sourceUrl | True | string |
The URL of the document to be copied. You can use full URL as well as domain relative URL |
Destination URL
|
destinationUrl | True | string |
The URL where the source document will be copied. You can use full URL as well as domain relative URL |
Returns
- Body
- DocumentInfoResponse
Copies the document set from the document library to the specified URL. You can copy the document sets to another document library cross-site or to another folder
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Source URL
|
sourceUrl | True | string |
The URL of the document set to be copied. You can use full URL as well as domain relative URL |
Destination URL
|
destinationUrl | True | string |
The URL where the source document set will be copied. You can use full URL as well as domain relative URL. If the URL ends with slash '/' the document sets will be placed in this folder without name changes. Otherwise the document set will be renamed |
Returns
Copies the folder from the document library to the specified URL. You can copy the folder to another document library cross-site or to another folder
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Source URL
|
sourceUrl | True | string |
The URL of the folder to be copied. You can use full URL as well as domain relative URL |
Destination URL
|
destinationUrl | True | string |
The URL where the source folder will be copied. You can use full URL as well as domain relative URL |
Returns
- Body
- FolderInfoResponse
Copies attachments from the SharePoint list item to the library using the specified folder URL
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
List URL
|
listUrl | True | string |
List name, URL or Guid |
Item ID
|
itemId | True | integer |
The ID of the source item |
Destination Folder URL
|
destinationUrl | True | string |
The URL of the folder where the attachments will be copied |
Overwrite
|
overwrite | boolean |
Overwrite if a file with the same name already exists |
Returns
- Body
- ListFileUrlsResponse
Creates a modern SharePoint Team or Communication site
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Site Type
|
siteType | True | string |
The type of the site for create |
request
|
request | True | dynamic |
Returns
- Body
- WebUrlResponse
Creates a new document set in the document library by the specified URL
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
DocumentSet Name
|
documentSetName | True | string |
The name of the document set |
Target List
|
targetListUrl | True | string |
The name or the URL of a library or a list where the document set will be created. You can use full URL as well as domain relative URL |
Content Type
|
contentType | string |
Specify Content-Type by name or id |
Returns
Creates a new folder in the document library by the specified URL
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Folder URL
|
folderUrl | True | string |
The URL of the folder. If you specify full path, you can create several folders |
Returns
- Body
- FolderInfoResponse
Creates a new folder in the document library or list using the specified path
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Target List
|
targetListUrl | True | string |
The name or the URL of a library or a list where the folder will be created. You can use full URL as well as domain relative URL |
Folder Path
|
folderPath | True | string |
The path where the folder will be created. The action will create all folders included into the path |
Returns
- Body
- FolderInfoResponse
Creates the SharePoint group with a specified name
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Group Name
|
groupName | True | string |
The name of the group |
Group Description
|
groupDescription | string |
The description of the group |
|
Group Owner
|
userLogin | string |
The owner of the group, can be email or the user login |
Create list or library by template
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Title
|
title | True | string |
Title of the list |
Template
|
template | True | string |
Title of the template that will be used for this list |
Partial URL
|
partialUrl | string |
Partial url of the list |
|
Description
|
description | string |
Description of the list |
|
On Quick Launch
|
onQuickLaunch | boolean |
Display this list on the Quick Launch |
Create a new SharePoint site based on specific template
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Title
|
title | True | string |
Title of new site |
Template
|
template | True | string |
Title of the site template that will be used for the new site |
Leaf URL
|
leafUrl | True | string |
A string that represents the URL leaf name |
Description
|
description | string |
Description of the web |
|
Lcid
|
lcid | integer |
LCID of the new web |
|
Inherit Permissions
|
inheritPermissions | boolean |
Specifies whether the new site will inherit permissions from its parent site |
|
Inherit Navigation
|
inheritNavigation | boolean |
Specifies whether the site inherits navigation |
|
On Top Navigation
|
onTopNav | boolean |
Display this site on the top link bar of the parent site. Default value is Yes |
|
On Quick Launch
|
onQuickLaunch | boolean |
Display this site on the Quick Launch of the parent site. Default value is No |
Returns
- Body
- WebUrlResponse
Deactivate a feature with specific ID
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Feature ID
|
featureId | True | uuid |
Guid of the feature |
Force
|
force | boolean |
true to force action of the Feature even if there are errors; otherwise, false |
Declares Document in SharePoint Library As Record
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
List Name
|
listName | True | string |
Title of the list or library |
Item ID or URL
|
itemId | True | string |
The item Id or Url of document |
Deletes the SharePoint site by a specific URL
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Gets members of a specific SharePoint group
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Group Name
|
groupName | True | string |
The name of the group |
Returns
Returns the changes history for the specific field from the SharePoint list item
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
List URL
|
listUrl | True | string |
List name, URL or Guid |
Item ID
|
itemId | True | integer |
Item ID of the item for which you want to get the version history |
Field Name
|
fieldName | True | string |
Name of the field for which you want to get the version history |
Returns
Executes a CAML query on a list or on a document library and returns the collection of elements
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
List URL
|
listUrl | True | string |
List name, URL or Guid |
Folder URL
|
folderUrl | string |
The server relative URL of a list folder from which results will be returned |
|
CAML Query
|
camlQuery | True | string |
CAML query that will be run |
Returns
Reads a value from SharePoint Site Options (Property Bag)
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Option Name
|
optionName | True | string |
Name of the option |
Returns
Invites external users with specific permission to an SharePoint site, an specific SharePoint group or an item in a SharePoint list
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Target
|
target | True | string |
The target of the operation |
request
|
request | True | dynamic |
Checks if a user is a member of a specifed SharePoint group
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Group Name
|
groupName | True | string |
The name of the group |
User
|
userLogin | True | string |
Login or email of a user for checking if he is a member in the specified group |
Returns
- Body
- UserExistsResponse
Moves the specified list item to another SharePoint list
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
List URL
|
listUrl | True | string |
List name, URL or Guid |
Item ID
|
itemId | True | string |
The ID of the source item |
Destination List URL
|
destinationListUrl | True | string |
The URL of the destination list. This list must contain same fields like in the source list |
Move Attachments
|
copyAttachments | boolean |
Move the item with attached files or not |
Returns
- Body
- ListItemIdResponse
Moves the document from the document library to the specified URL. You can copy the document to another document library cross-site or to another folder
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Source URL
|
sourceUrl | True | string |
The URL of the document to be moved. You can use full URL as well as domain relative URL |
Destination URL
|
destinationUrl | True | string |
The URL where the source document will be moved. You can use full URL as well as domain relative URL |
Returns
- Body
- DocumentInfoResponse
Moves the document set from the document library to the specified URL. You can copy the document sets to another document library cross-site or to another folder
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Source URL
|
sourceUrl | True | string |
The URL of the document set to be moved. You can use full URL as well as domain relative URL |
Destination URL
|
destinationUrl | True | string |
The URL where the source document set will be moved. You can use full URL as well as domain relative URL. If the URL ends with slash '/' the document sets will be placed in this folder without name changes. Otherwise the Document set will be renamed |
Returns
Moves the folder from the document library to the specified URL. You can move the folder to another document library cross-site or to another folder
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Source URL
|
sourceUrl | True | string |
The URL of the folder to be moved. You can use full URL as well as domain relative URL |
Destination URL
|
destinationUrl | True | string |
The URL where the source folder will be moved. You can use full URL as well as domain relative URL |
Returns
- Body
- FolderInfoResponse
Moves attachments from the SharePoint list item to the library using the specified folder URL
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
List URL
|
listUrl | True | string |
List name, URL or Guid |
Item ID
|
itemId | True | integer |
The ID of the source item |
Destination Folder URL
|
destinationUrl | True | string |
The URL of the folder where the attachments will be moved |
Overwrite
|
overwrite | boolean |
Overwrite if a file with the same name already exists |
Returns
- Body
- ListFileUrlsResponse
It works like Parse JSON but for CSV file
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Content of CSV document
|
content | True | byte |
Content of CSV document |
Delimiter
|
delimiter | string |
Delimiter of columns (by default it is just comma) |
|
Locale
|
locale | string |
The locale that will be applyed to the document |
|
Limit
|
limit | integer |
Returns the first "n" rows |
|
Headers
|
headers | True | string |
Comma separated list of headers in the same order as CSV columns |
Skip first line
|
skipFirstLine | boolean |
Select "Yes" if your CSV has headers as a first line. |
Returns
Applies a PnP template to a SharePoint site
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Template Content
|
xmlTemplateContent | True | byte |
The content of an XML or PnP template |
Overwrite System PropertyBag Values
|
overwriteSystemPropertyBagValues | boolean |
Specify this parameter if you want to overwrite and/or create properties that are known to be system entries (starting with vti_, dlc_, etc.) |
|
Ignore Duplicate Data Row Errors
|
ignoreDuplicateDataRowErrors | boolean |
Ignore duplicate data row errors when the data row in the template already exists. |
|
Clear Navigation
|
clearNavigation | boolean |
If you specify this value the navigation nodes will always be removed before adding the nodes in the template |
|
Provision Content Types To SubWebs
|
provisionContentTypesToSubWebs | boolean |
If set content types will be provisioned if the target web is a subweb. |
|
Provision Fields To SubWebs
|
provisionFieldsToSubWebs | boolean |
If set fields will be provisioned if the target web is a subweb. |
|
Handlers
|
handlers | string |
Allows you to only process a specific part of the template. Notice that this might fail, as some of the handlers require other artifacts in place if they are not part of what your applying. Visit https://docs.microsoft.com/dotnet/api/officedevpnp.core.framework.provisioning.model.handlers for possible values. |
|
Exclude Handlers
|
excludeHandlers | string |
Allows you to run all handlers, excluding the ones specified. |
|
Parameters
|
parameters | string |
Allows you to specify parameters that can be referred to in the template by means of the =; token |
Applies a PnP tenant template to SharePoint
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Template Content
|
xmlTemplateContent | True | byte |
The content of an XML or PnP template |
Overwrite System PropertyBag Values
|
overwriteSystemPropertyBagValues | boolean |
Specify this parameter if you want to overwrite and/or create properties that are known to be system entries (starting with vti_, dlc_, etc.) |
|
Ignore Duplicate Data Row Errors
|
ignoreDuplicateDataRowErrors | boolean |
Ignore duplicate data row errors when the data row in the template already exists. |
|
Clear Navigation
|
clearNavigation | boolean |
If you specify this value the navigation nodes will always be removed before adding the nodes in the template |
|
Provision Content Types To SubWebs
|
provisionContentTypesToSubWebs | boolean |
If set content types will be provisioned if the target web is a subweb. |
|
Provision Fields To SubWebs
|
provisionFieldsToSubWebs | boolean |
If set fields will be provisioned if the target web is a subweb. |
|
Handlers
|
handlers | string |
Allows you to only process a specific part of the template. Notice that this might fail, as some of the handlers require other artifacts in place if they are not part of what your applying. Visit https://docs.microsoft.com/dotnet/api/officedevpnp.core.framework.provisioning.model.handlers for possible values. |
|
Exclude Handlers
|
excludeHandlers | string |
Allows you to run all handlers, excluding the ones specified. |
|
Parameters
|
parameters | string |
Allows you to specify parameters that can be referred to in the template by means of the =; token |
Searches an input string for all occurrences of a regular expression and returns all the matches. We would recommend you to use Regex Hero to test your expressions. It supports the same syntax as actions
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Pattern
|
pattern | True | string |
Regular expression pattern |
Text
|
text | True | string |
String to search for matches |
Returns
In a specified input string, replaces all strings that match a regular expression pattern with a specified replacement string. We would recommend you to use Regex Hero to test your expressions. It supports the same syntax as actions
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Pattern
|
pattern | True | string |
Regular expression pattern |
Text
|
text | True | string |
String to search for matches |
Replacement
|
replacement | string |
Replacement string |
Returns
- Body
- StringResultResponse
Indicates whether the regular expression specified in the Regex constructor finds a match in a specified input string. We would recommend you to use Regex Hero to test your expressions. It supports the same syntax as actions
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Pattern
|
pattern | True | string |
Regular expression pattern |
Text
|
text | True | string |
String to search for matches |
Returns
Remove the document by a specific URL
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Document URL
|
sourceUrl | True | string |
The URL of the document to be removed. You can use full URL as well as domain relative URL |
Removes the folder from the document library or list by the specified URL
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Folder URL
|
sourceUrl | True | string |
The URL of the library where the source folder will be removed. You can use full URL as well as domain relative URL |
Removes the SharePoint group by a specified name
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Group Name
|
groupName | True | string |
The name of the group |
Removes a menu item from either the quicklaunch or top navigation
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Location
|
location | True | string |
The location of the node to add |
Title
|
title | True | string |
Title of navigation node |
Parent
|
parent | string |
It is the title of a parent navigation item. If there are multiple top-level items with the same title, we will pick only the first. |
Removes a user from a specific SharePoint group
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Group Name
|
groupName | True | string |
The name of the group |
User
|
userLogin | True | string |
Login or email of the user which will be removed from the specific group. Also you can specify multiple items using semicolon ';' delimited |
Configure default groups for a site with the help of Microsoft Flow. It is alternative of the /_layouts/15/permsetup.aspx page in SharePoint UI.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Group Type
|
groupType | True | string |
Type of the group |
Group Name
|
groupName | True | string |
Name of the group |
Starts a SharePoint list level workflow and pass input parameters, if they were specified. The action can run only 2013 workflows
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Workflow Name
|
workflowName | True | string |
Name of the workflow which will be started |
Input Parameters
|
inputParameters | object |
JSON string that contains input parameters for workflow |
|
List URL
|
listUrl | True | string |
List name, URL or Guid |
Item ID
|
itemId | True | integer |
Item ID of the item for which you want to start the list workflow |
Returns
- Body
- WorkflowGuidResponse
Starts a SharePoint site level workflow and pass input parameters, if they were specified. The action can run only 2013 workflows
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Workflow Name
|
workflowName | True | string |
Name of the workflow which will be started |
Input Parameters
|
inputParameters | object |
JSON string that contains input parameters for workflow |
Returns
- Body
- WorkflowGuidResponse
Undeclares Document in SharePoint Library As Record
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
List Name
|
listName | True | string |
Title of the list or library |
Item ID or URL
|
itemId | True | string |
The item Id or Url of document |
Updates SharePoint group properties like AutoAcceptRequestToJoinLeave, AllowMembersEditMembership or other options described in MSDN
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Group Name
|
groupName | True | string |
The name of the group |
Title
|
title | string |
The title for the group |
|
Description
|
description | string |
The description for the group |
|
Owner
|
owner | string |
The owner for the group, which can be a user or another group |
|
Allow Members Edit Membership
|
allowMembersEditMembership | boolean |
A value that specifies whether group members can modify membership in the group |
|
Allow Request to Join Leave
|
allowRequestToJoinLeave | boolean |
A value that specifies whether to allow users to request membership in the group and to allow users to request to leave the group |
|
Auto Accept Request to Join Leave
|
autoAcceptRequestToJoinLeave | boolean |
A value that specifies whether users are automatically added or removed when they make a request |
|
Only Allow Members View Membership
|
onlyAllowMembersViewMembership | boolean |
A value that specifies whether only group members are allowed to view the list of members in the group |
|
Request to Join Leave Email Setting
|
requestToJoinLeaveEmailSetting | string |
The e-mail address to which membership requests are sent |
Updates an item in a SharePoint list or library
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
List Name
|
listName | True | string |
Title of the list or library |
Item ID or URL
|
itemId | True | string |
The item Id or Url of document/folder |
Field values
|
data | True | object |
JSON object like { "InternalFieldName": "FieldValue" } |
Updates web properties like Title, Description or other string options described in at MSDN
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
SharePoint Site URL
|
spUrl | True | string |
The action will be executed on the specified SharePoint site |
Title
|
title | string |
The title for the website |
|
Description
|
description | string |
The description for the site |
|
Quick Launch Enabled
|
quickLaunchEnabled | boolean |
A value that specifies whether the Quick Launch area is enabled on the website |
|
Tree View Enabled
|
treeViewEnabled | boolean |
A value that specifies whether the SharePoint Foundation TreeView is enabled in the left navigational area of website pages |
|
Site Logo URL
|
siteLogoUrl | string |
The absolute URL of the website logo |
|
Alternate Css URL
|
alternateCssUrl | string |
The URL for an alternate cascading style sheet (CSS) to use in the website |
|
Associated Member Group
|
associatedMemberGroup | string |
The users who have been given contribute permissions to the website |
|
Associated Owner Group
|
associatedOwnerGroup | string |
The associated owner groups of the website |
|
Associated Visitor Group
|
associatedVisitorGroup | string |
The associated visitor group of the website |
|
Contains Confidential Info
|
containsConfidentialInfo | boolean |
A value that specifies whether the SharePoint site contain a confidential information |
|
Custom Master URL
|
customMasterUrl | string |
The URL for a custom master page file to apply to the website |
|
Enable Minimal Download
|
enableMinimalDownload | boolean |
A value that specifies whether the Web site should use Minimal Download Strategy |
|
Is Multilingual
|
isMultilingual | boolean |
A value that indicates whether a multilingual user interface is enabled for the website |
|
Master URL
|
masterUrl | string |
The URL of the master page that is used for the website |
|
Members Can Share
|
membersCanShare | boolean |
Allow Members to share the site and invite others |
|
No Crawl
|
noCrawl | boolean |
A value that specifies whether searching is enabled for the website |
|
Overwrite Translations on Change
|
overwriteTranslationsOnChange | boolean |
A value that indicates whether changes made to user-specified text in the default language should automatically overwrite existing translations made in all alternate languages |
|
Request Access Email
|
requestAccessEmail | string |
The e-mail address to which requests for access are sent |
|
Save Site as Template Enabled
|
saveSiteAsTemplateEnabled | boolean |
A value that specifies whether the Web site can be saved as a site template |
|
Server Relative URL
|
serverRelativeUrl | string |
The server-relative URL for the website |
|
Syndication Enabled
|
syndicationEnabled | boolean |
A value that specifies whether Really Simple Syndication (RSS) is enabled in the website |
|
UI Version
|
uiVersion | integer |
The current version number of the user interface |
Name | Path | Type | Description |
---|---|---|---|
IsSuccess
|
isSuccess | boolean |
Name | Path | Type | Description |
---|---|---|---|
Document ID
|
id | integer | |
Document URL
|
url | string |
Name | Path | Type | Description |
---|---|---|---|
Document set ID
|
id | integer | |
Document set URL
|
url | string |
Name | Path | Type | Description |
---|---|---|---|
Folder ID
|
id | integer | |
Folder URL
|
url | string |
Name | Path | Type | Description |
---|---|---|---|
Users
|
users | array of SharePointUserResponse |
Name | Path | Type | Description |
---|---|---|---|
Group Exists
|
groupExists | boolean |
Name | Path | Type | Description |
---|---|---|---|
File URLs
|
fileUrls | array of string |
Name | Path | Type | Description |
---|---|---|---|
Result Item ID
|
resultItemId | integer |
Name | Path | Type | Description |
---|---|---|---|
Option Value
|
optionValue | string |
Name | Path | Type | Description |
---|---|---|---|
User ID
|
id | integer | |
User Name
|
loginName | string | |
User Email
|
string | ||
User Claims
|
claims | string |
Name | Path | Type | Description |
---|---|---|---|
editor
|
editor | SharePointUserResponse | |
Modified
|
modified | date-time | |
Value
|
value | string |
Name | Path | Type | Description |
---|---|---|---|
Result
|
result | string |
Name | Path | Type | Description |
---|---|---|---|
User Exists
|
userExists | boolean |
Name | Path | Type | Description |
---|---|---|---|
Count Versions
|
countVersions | integer | |
Versions
|
versions | array of SharePointVersionResponse |
Name | Path | Type | Description |
---|---|---|---|
Web URL
|
url | string |
Name | Path | Type | Description |
---|---|---|---|
Workflow GUID
|
workflowGuid | string |