Plumsail SP (Preview)

Plumsail SP (Preview)

To know more please visit 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 Government regions
     -   Azure China regions
Flow Standard All Flow regions
PowerApps Standard All PowerApps regions

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Creating a connection

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

Access Key
securestring
The Access Key for this api

Actions

Activate SharePoint Feature

Activate a feature with specific ID

Required Parameters

Feature ID
uuid
Guid of the feature
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Optional Parameters

Force
boolean
true to force activation of the Feature even if there are errors; otherwise, false

Add Content Type to SharePoint List

Adds the specified content type to a SharePoint list

Required Parameters

List URL
string
List name, URL or Guid
Content Type Name
string
Name of the content type
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Optional Parameters

Make It Default
boolean
Make the content type default for the list

Add User to SharePoint Group

Adds a user to a specific SharePoint group

Required Parameters

Group Name
string
The name of the group
User
string
Login or email of the user which will be added to the specific group. Also you can specify multiple items using semicolon ';' delimited
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Change SharePoint permissions

Grant, remove and restore permissions for the site, the list, and the item

Required Parameters

Action type
string
The type of the operation
Target
string
The target of the operation
request
dynamic

Check In SharePoint Document

Check-in the document at the specified URL with the specified comment

Required Parameters

Document URL
string
The URL of the document to check in
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Optional Parameters

Comment
string
The comment to accompany document check in

Returns

Check Out SharePoint Document

Check-out the document at the specified URL

Required Parameters

Document URL
string
The URL of the document to check in
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Copy List Item to SharePoint List

Copies the specified list item to another SharePoint list

Required Parameters

List URL
string
List name, URL or Guid
Item ID
integer
The ID of the source item
Destination List URL
string
The URL of the destination list. This list must contain same fields like in the source list
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Optional Parameters

Copy Attachments
boolean
Copy the item with attached files or not

Returns

Copy SharePoint Document Set

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

Required Parameters

Source URL
string
The URL of the document set to be copied. You can use full URL as well as domain relative URL
Destination URL
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
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Copy SharePoint Document from Library

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

Required Parameters

Source URL
string
The URL of the document to be copied. You can use full URL as well as domain relative URL
Destination URL
string
The URL where the source document will be copied. You can use full URL as well as domain relative URL
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Copy SharePoint Folder from Library

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

Required Parameters

Source URL
string
The URL of the folder to be copied. You can use full URL as well as domain relative URL
Destination URL
string
The URL where the source folder will be copied. You can use full URL as well as domain relative URL
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Copy SharePoint Item Attachments to URL

Copies attachments from the SharePoint list item to the library using the specified folder URL

Required Parameters

List URL
string
List name, URL or Guid
Item ID
integer
The ID of the source item
Destination Folder URL
string
The URL of the folder where the attachments will be copied
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Optional Parameters

Overwrite
boolean
Overwrite if a file with the same name already exists

Returns

Create Modern SharePoint Site

Creates a modern SharePoint Team or Communication site

Required Parameters

Site Type
string
The type of the site for create
request
dynamic

Returns

Create SharePoint Document Set

Creates a new document set in the document library by the specified URL

Required Parameters

DocumentSet Name
string
The name of the document set
Target List
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
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Create SharePoint Folder by URL

Creates a new folder in the document library by the specified URL

Required Parameters

Folder URL
string
The URL of the folder. If you specify full path, you can create several folders
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Create SharePoint Folder in List

Creates a new folder in the document library or list using the specified path

Required Parameters

Target List
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
string
The path where the folder will be created. The action will create all folders included into the path
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Create SharePoint Group

Creates the SharePoint group with a specified name

Required Parameters

Group Name
string
The name of the group
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Optional Parameters

Group Description
string
The description of the group
Group Owner
string
The owner of the group, can be email or the user login

Create SharePoint List or Library

Create list or library by template

Required Parameters

Title
string
Title of the list
Template
string
Title of the template that will be used for this list
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Optional Parameters

Partial URL
string
Partial url of the list
Description
string
Description of the list
On Quick Launch
boolean
Display this list on the Quick Launch

Create SharePoint Site from Template

Create a new SharePoint site based on specific template

Required Parameters

Title
string
Title of new site
Template
string
Title of the site template that will be used for the new site
Leaf URL
string
A string that represents the URL leaf name
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Optional Parameters

Description
string
Description of the web
Lcid
integer
LCID of the new web
Inherit Permissions
boolean
Specifies whether the new site will inherit permissions from its parent site
Inherit Navigation
boolean
Specifies whether the site inherits navigation
On Top Navigation
boolean
Display this site on the top link bar of the parent site. Default value is Yes
On Quick Launch
boolean
Display this site on the Quick Launch of the parent site. Default value is No

Returns

Delete SharePoint Site

Deletes the SharePoint site by a specific URL

Required Parameters

SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Get Members of SharePoint Group

Gets members of a specific SharePoint group

Required Parameters

Group Name
string
The name of the group
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Get SharePoint Item Versions History

Returns the changes history for the specific field from the SharePoint list item

Required Parameters

List URL
string
List name, URL or Guid
Item ID
integer
Item ID of the item for which you want to get the version history
Field Name
string
Name of the field for which you want to get the version history
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Get SharePoint Items By CAML Query

Executes a CAML query on a list or on a document library and returns the collection of elements

Required Parameters

List URL
string
List name, URL or Guid
CAML Query
string
CAML query that will be run
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Optional Parameters

Folder URL
string
The server relative URL of a list folder from which results will be returned

Returns

The outputs of this operation are dynamic.

Get SharePoint Site Option Value

Reads a value from SharePoint Site Options (Property Bag)

Required Parameters

Option Name
string
Name of the option
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Invite External User to SharePoint

Invites external users with specific permission to an SharePoint site, an specific SharePoint group or an item in a SharePoint list

Required Parameters

Target
string
The target of the operation
request
dynamic

Is User Member of SharePoint Group

Checks if a user is a member of a specifed SharePoint group

Required Parameters

Group Name
string
The name of the group
User
string
Login or email of a user for checking if he is a member in the specified group
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Move List Item to SharePoint List

Moves the specified list item to another SharePoint list

Required Parameters

List URL
string
List name, URL or Guid
Item ID
integer
The ID of the source item
Destination List URL
string
The URL of the destination list. This list must contain same fields like in the source list
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Optional Parameters

Move Attachments
boolean
Move the item with attached files or not

Returns

Move SharePoint Document Set

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

Required Parameters

Source URL
string
The URL of the document set to be moved. You can use full URL as well as domain relative URL
Destination URL
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
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Move SharePoint Document from Library

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

Required Parameters

Source URL
string
The URL of the document to be moved. You can use full URL as well as domain relative URL
Destination URL
string
The URL where the source document will be moved. You can use full URL as well as domain relative URL
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Move SharePoint Folder from Library

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

Required Parameters

Source URL
string
The URL of the folder to be moved. You can use full URL as well as domain relative URL
Destination URL
string
The URL where the source folder will be moved. You can use full URL as well as domain relative URL
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Move SharePoint Item Attachments to URL

Moves attachments from the SharePoint list item to the library using the specified folder URL

Required Parameters

List URL
string
List name, URL or Guid
Item ID
integer
The ID of the source item
Destination Folder URL
string
The URL of the folder where the attachments will be moved
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Optional Parameters

Overwrite
boolean
Overwrite if a file with the same name already exists

Returns

Provision PnP Template to SharePoint

Applies a PnP template to a SharePoint site

Required Parameters

Xml Template Content
byte
The content of an XML template
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Remove SharePoint Document by URL

Remove the document by a specific URL

Required Parameters

Document URL
string
The URL of the document to be removed. You can use full URL as well as domain relative URL
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Remove SharePoint Folder by URL

Removes the folder from the document library or list by the specified URL

Required Parameters

Folder URL
string
The URL of the library where the source folder will be removed. You can use full URL as well as domain relative URL
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Remove SharePoint Group

Removes the SharePoint group by a specified name

Required Parameters

Group Name
string
The name of the group
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Remove User from SharePoint Group

Removes a user from a specific SharePoint group

Required Parameters

Group Name
string
The name of the group
User
string
Login or email of the user which will be removed from the specific group. Also you can specify multiple items using semicolon ';' delimited
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Set Default SharePoint Site Group

Configure default groups for the site it is analog of the permsetup.aspx page

Required Parameters

Group Type
string
Type of the group
Group Name
string
Name of the group
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Start SharePoint List Workflow (2013)

Starts a SharePoint list level workflow and pass input parameters, if they were specified. The action can run only 2013 workflows

Required Parameters

List URL
string
List name, URL or Guid
Item ID
integer
Item ID of the item for which you want to start the list workflow
Workflow Name
string
Name of the workflow which will be started
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Start SharePoint Site Workflow (2013)

Starts a SharePoint site level workflow and pass input parameters, if they were specified. The action can run only 2013 workflows

Required Parameters

Workflow Name
string
Name of the workflow which will be started
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Returns

Update SharePoint Group Properties

Updates SharePoint group properties like AutoAcceptRequestToJoinLeave, AllowMembersEditMembership or other options described in MSDN

Required Parameters

Group Name
string
The name of the group
SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Optional Parameters

Title
string
The title for the group
Description
string
The description for the group
Owner
string
The owner for the group, which can be a user or another group
Allow Members Edit Membership
boolean
A value that specifies whether group members can modify membership in the group
Allow Request to Join Leave
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
boolean
A value that specifies whether users are automatically added or removed when they make a request
Only Allow Members View Membership
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
string
The e-mail address to which membership requests are sent

Update SharePoint Site Properties

Updates web properties like Title, Description or other string options described in at MSDN

Required Parameters

SharePoint Site URL
string
This property defines the context of the action. The action will be executed on specified SharePoint site

Optional Parameters

Title
string
The title for the website
Description
string
The description for the site
Quick Launch Enabled
boolean
A value that specifies whether the Quick Launch area is enabled on the website
Tree View Enabled
boolean
A value that specifies whether the SharePoint Foundation TreeView is enabled in the left navigational area of website pages
Site Logo URL
string
The absolute URL of the website logo
Alternate Css URL
string
The URL for an alternate cascading style sheet (CSS) to use in the website
Associated Member Group
string
The users who have been given contribute permissions to the website
Associated Owner Group
string
The associated owner groups of the website
Associated Visitor Group
string
The associated visitor group of the website
Contains Confidential Info
boolean
A value that specifies whether the SharePoint site contain a confidential information
Custom Master URL
string
The URL for a custom master page file to apply to the website
Enable Minimal Download
boolean
A value that specifies whether the Web site should use Minimal Download Strategy
Is Multilingual
boolean
A value that indicates whether a multilingual user interface is enabled for the website
Master URL
string
The URL of the master page that is used for the website
Members Can Share
boolean
Allow Members to share the site and invite others
No Crawl
boolean
A value that specifies whether searching is enabled for the website
Overwrite Translations on Change
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
string
The e-mail address to which requests for access are sent
Save Site as Template Enabled
boolean
A value that specifies whether the Web site can be saved as a site template
Server Relative URL
string
The server-relative URL for the website
Syndication Enabled
boolean
A value that specifies whether Really Simple Syndication (RSS) is enabled in the website
UI Version
integer
The current version number of the user interface

Definitions

WebUrlResponse

Web URL
string

DocumentInfoResponse

Document ID
integer
Document URL
string

DocumentSetInfoResponse

Document set ID
integer
Document set URL
string

FolderInfoResponse

Folder ID
integer
Folder URL
string

GetSPGroupMembersResponse

Users
array of SharePointUserResponse

SharePointUserResponse

User Claims
string
User Email
string
User ID
integer
User Name
string

UserExistsResponse

User Exists
boolean

SPSiteOptionValueResponse

Option Value
string

ListFileUrlsResponse

File URLs
array of string

ListItemIdResponse

Result Item ID
integer

WorkflowGuidResponse

Workflow GUID
string

VersionsHistoryResponse

Count Versions
integer
Versions
array of SharePointVersionResponse

SharePointVersionResponse

Modified
date-time
Value
string
editor
SharePointUserResponse