Connectors Reference
This connector provides a set of SharePoint related actions. For example, permissions, documents, folders, document sets management. Visit official site for more information https://plumsail.com/actions/
|
Status: Production |
Tier: Standard |
Version: v1 |
|
Name |
Summary |
Summary: ChangePermissionsSchema
Description: System
Syntax:
PlumsailSP.FlowV1SharePointFlowSchemaChangePermissionsPost (string actionType, string target)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
actionType |
string (Action type)Values: [Grant, Remove, RemoveAll, RestoreInheritance] |
The type of the operation |
True |
|
|
target |
string (Target)Values: [Site, List, Item, Folder, Document] |
The target of the operation |
True |
Returns:
Summary: GetRoleTypesSchema
Description: System
Syntax:
PlumsailSP.FlowV1SharePointFlowSchemaGetRoleTypesPost ()
Returns:
Summary: CreateModernSiteSchema
Description: System
Syntax:
PlumsailSP.FlowV1SharePointFlowSchemaCreateModernSitePost (string siteType)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
siteType |
string (Site Type)Values: [TeamSite, CommunicationSite, TeamSiteWithoutGroup] |
The type of the site for create |
True |
Returns:
Summary: GetItemsByCAMLQueryResponseSchema
Description: System
Syntax:
PlumsailSP.FlowV1SharePointFlowSchemaGetItemsByCAMLQueryPost (string camlQuery)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
camlQuery |
string (CAML Query) |
CAML query |
True |
Returns:
Summary: InviteExternalUserSchema
Description: System
Syntax:
PlumsailSP.FlowV1SharePointFlowSchemaInviteExternalUserPost (string target)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
target |
string (Target)Values: [Site, Item, Group] |
The target of the operation |
True |
Returns:
Summary: GetModernSiteDesignsSchema
Description: System
Syntax:
PlumsailSP.FlowV1SharePointFlowSchemaGetModernSiteDesignsPost ([Optional]string type)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
type |
string
|
|
False |
Returns:
Summary: RegexMatchSchema
Description: System
Syntax:
PlumsailSP.FlowV1SharePointFlowSchemaRegExpMatchPost (string pattern)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
pattern |
string (Pattern) |
pattern |
True |
Returns:
Summary: ParseCsv
Description: System
Syntax:
PlumsailSP.FlowV1SharePointFlowSchemaParseCsvPost (string headers)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
headers |
string
|
|
True |
Returns:
Summary: Create SharePoint Subsite from Template
Description: Create a new SharePoint site based on specific template
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsCreateSiteFromTemplatePost (CreateSiteFromTemplateRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:WebUrlResponse
Summary: Change SharePoint permissions
Description: Grant, remove and restore permissions for the site, the list, and the item
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsChangePermissionsPost (string actionType, string target, FlowV1SharePointFlowJobsChangePermissionsPostParameterRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
actionType |
string (Action type)Values: [Grant, Remove, RemoveAll, RestoreInheritance] |
The type of the operation |
True |
|
|
target |
string (Target)Values: [Site, List, Item, Folder, Document] |
The target of the operation |
True |
|
|
request |
FlowV1SharePointFlowJobsChangePermissionsPostParameterRequest
|
|
True |
Returns:
Summary: Activate SharePoint Feature
Description: Activate a feature with specific ID
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsActivateFeaturePost (FeatureActivationRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Summary: Deactivate SharePoint Feature
Description: Deactivate a feature with specific ID
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsDeactivateFeaturePost (FeatureActivationRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Summary: Create SharePoint List or Library
Description: Create list or library by template
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsCreateListOrLibraryPost (CreateListOrLibraryRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Summary: Set Default SharePoint Site Group
Description: Configure default groups for a site with the help of Microsoft Flow. It is alternative of the <site URL>/_layouts/15/permsetup.aspx page in SharePoint UI.
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsSetDefaultSiteGroupPost (SetDefaultSiteGroupRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Summary: Copy SharePoint Document from Library
Description: 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
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsCopyDocumentFromLibraryPost (CopyDocumentRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:DocumentInfoResponse
Summary: Move SharePoint Document from Library
Description: 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
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsMoveDocumentFromLibraryPost (MoveDocumentRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:DocumentInfoResponse
Summary: Remove SharePoint Document by URL
Description: Remove the document by a specific URL
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsRemoveDocumentByUrlPost (RemoveDocumentRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Summary: Create SharePoint Document Set
Description: Creates a new document set in the document library by the specified URL
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsCreateDocumentSetPost (CreateDocumentSetRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Summary: Copy SharePoint Document Set
Description: 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
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsCopyDocumentSetPost (CopyDocumentSetRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Summary: Move SharePoint Document Set
Description: 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
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsMoveDocumentSetPost (MoveDocumentSetRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Summary: Create SharePoint Folder by URL
Description: Creates a new folder in the document library by the specified URL
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsCreateFolderByUrlPost (CreateFolderByUrlRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:FolderInfoResponse
Summary: Create SharePoint Folder in List
Description: Creates a new folder in the document library or list using the specified path
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsCreateFolderInListPost (CreateFolderInListRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:FolderInfoResponse
Summary: Remove SharePoint Folder by URL
Description: Removes the folder from the document library or list by the specified URL
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsRemoveFolderByUrlPost (RemoveFolderByUrlRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Summary: Copy SharePoint Folder from Library
Description: 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
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsCopyFolderFromLibraryPost (CopyFolderRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:FolderInfoResponse
Summary: Move SharePoint Folder from Library
Description: 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
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsMoveFolderFromLibraryPost (MoveFolderRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:FolderInfoResponse
Summary: Check In SharePoint Document
Description: Check-in the document at the specified URL with the specified comment
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsCheckInDocumentPost (CheckInDocumentRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:DocumentInfoResponse
Summary: Check Out SharePoint Document
Description: Check-out the document at the specified URL
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsCheckOutDocumentPost (CheckOutDocumentRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:DocumentInfoResponse
Summary: Create Modern SharePoint Site
Description: Creates a modern SharePoint Team or Communication site
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsCreateModernSitePost (string siteType, FlowV1SharePointFlowJobsCreateModernSitePostParameterRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
siteType |
string (Site Type)Values: [TeamSite, CommunicationSite, TeamSiteWithoutGroup] |
The type of the site for create |
True |
|
|
request |
FlowV1SharePointFlowJobsCreateModernSitePostParameterRequest
|
|
True |
Returns:
Type:WebUrlResponse
Summary: Apply SharePoint Site Design
Description: Applies design to target SharePoint site
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsApplySiteDesignPost (ApplySiteDesignRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:WebUrlResponse
Summary: Create SharePoint Group
Description: Creates the SharePoint group with a specified name
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsCreateSharePointGroupPost (CreateSPGroupRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Summary: Remove SharePoint Group
Description: Removes the SharePoint group by a specified name
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsRemoveSharePointGroupPost (RemoveSPGroupRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Summary: Update SharePoint Group Properties
Description: Updates SharePoint group properties like AutoAcceptRequestToJoinLeave, AllowMembersEditMembership or other options described in MSDN
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsUpdateSharePointGroupPropertiesPost (UpdateSPGroupPropertiesRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
UpdateSPGroupPropertiesRequest
|
|
True |
Returns:
Summary: Add User to SharePoint Group
Description: Adds a user to a specific SharePoint group
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsAddUserToSharePointGroupPost (AddUserToSPGroupRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Summary: Remove User from SharePoint Group
Description: Removes a user from a specific SharePoint group
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsRemoveUserFromSharePointGroupPost (RemoveUserFromSPGroupRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Summary: Get Members of SharePoint Group
Description: Gets members of a specific SharePoint group
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsGetSharePointGroupMembersPost (GetUsersFromGroupRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:GetSPGroupMembersResponse
Summary: Is User Member of SharePoint Group
Description: Checks if a user is a member of a specifed SharePoint group
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsUserExistInSharePointGroupPost (UserExistsInGroupRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:UserExistsResponse
Summary: Update SharePoint Site Properties
Description: Updates web properties like Title, Description or other string options described in at MSDN
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsUpdateSharePointSitePropertiesPost (UpdateSitePropertiesRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Summary: Delete SharePoint Site
Description: Deletes the SharePoint site by a specific URL
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsDeleteSharePointSitePost (BaseSPRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Summary: Get SharePoint Site Option Value
Description: Reads a value from SharePoint Site Options (Property Bag)
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsGetSharePointSiteOptionValueAsStringPost (GetSiteOptionValueRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:SPSiteOptionValueResponse
Summary: Invite External User to SharePoint
Description: Invites external users with specific permission to an SharePoint site, an specific SharePoint group or an item in a SharePoint list
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsInviteExternalUserToSharePointPost (string target, FlowV1SharePointFlowJobsInviteExternalUserToSharePointPostParameterRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
target |
string (Target)Values: [Site, Item, Group] |
The target of the operation |
True |
|
|
request |
FlowV1SharePointFlowJobsInviteExternalUserToSharePointPostParameterRequest
|
|
True |
Returns:
Summary: Copy SharePoint Item Attachments to URL
Description: Copies attachments from the SharePoint list item to the library using the specified folder URL
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsCopyAttachmentsToUrlPost (CopyAttachmentsToUrlRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:ListFileUrlsResponse
Summary: Move SharePoint Item Attachments to URL
Description: Moves attachments from the SharePoint list item to the library using the specified folder URL
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsMoveAttachmentsToUrlPost (MoveAttachmentsToUrlRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:ListFileUrlsResponse
Summary: Add Content Type to SharePoint List
Description: Adds the specified content type to a SharePoint list
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsAddContentTypeToSharePointListPost (AddContentTypeToListRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Summary: Copy List Item to SharePoint List
Description: Copies the specified list item to another SharePoint list
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsCopyListItemToSharePointListPost (CopyListItemToListRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:ListItemIdResponse
Summary: Move List Item to SharePoint List
Description: Moves the specified list item to another SharePoint list
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsMoveListItemToSharePointListPost (MoveListItemToListRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:ListItemIdResponse
Summary: Start SharePoint List Workflow (2013)
Description: Starts a SharePoint list level workflow and pass input parameters, if they were specified. The action can run only 2013 workflows
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsStartListWorkflowPost (StartListWorkflowRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:WorkflowGuidResponse
Summary: Start SharePoint Site Workflow (2013)
Description: Starts a SharePoint site level workflow and pass input parameters, if they were specified. The action can run only 2013 workflows
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsStartSiteWorkflowPost (StartSiteWorkflowRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:WorkflowGuidResponse
Summary: Get SharePoint Items By CAML Query
Description: Executes a CAML query on a list or on a document library and returns the collection of elements
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsGetItemsByCamlQueryPost (GetItemsByCAMLQueryRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:GetItemsByCAMLQuerySchemaResponseClass
Summary: Get SharePoint Item Versions History
Description: Returns the changes history for the specific field from the SharePoint list item
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsGetVersionsHistoryPost (GetListItemVersionsHistoryRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
GetListItemVersionsHistoryRequest
|
|
True |
Returns:
Summary: Provision PnP Template to SharePoint
Description: Applies a PnP template to a SharePoint site
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsProvisionPnPTemplatePost (ProvisionPnPTemplateRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Summary: Provision PnP Tenant Template to SharePoint
Description: Applies a PnP tenant template to SharePoint
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsProvisionPnPTenantTemplatePost (ProvisionPnPTemplateRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Summary: Add SharePoint Site Navigation Node
Description: Adds a menu item to either the quicklaunch or top navigation
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsAddSiteNavigationPost (AddSiteNavigationRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Summary: Remove SharePoint Site Navigation Node
Description: Removes a menu item from either the quicklaunch or top navigation
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsRemoveSiteNavigationPost (RemoveSiteNavigationRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Summary: Update SharePoint Item
Description: Updates an item in a SharePoint list or library
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsUpdateListItemPost (UpdateListItemRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Summary: Declare SharePoint Document as Record
Description: Declares Document in SharePoint Library As Record
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsDeclareDocumentAsRecordPost (DeclareDocumentAsRecordRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
DeclareDocumentAsRecordRequest
|
|
True |
Returns:
Summary: Undeclare SharePoint Document as Record
Description: Undeclares Document in SharePoint Library As Record
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsUndeclareDocumentAsRecordPost (UndeclareDocumentAsRecordRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
UndeclareDocumentAsRecordRequest
|
|
True |
Returns:
Summary: Parse CSV
Description: It works like Parse JSON but for CSV file
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsParseCsvPost (ParseCsvFlowRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:ParseCsvFlowSchemaResponse
Summary: Regular Expression Match
Description: 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
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsRegExpMatchPost (RegExpMatchRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:RegExpMatchFlowSchemaResponseClass
Summary: Regular Expression Replace
Description: 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
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsRegExpReplacePost (RegExpReplaceRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Type:StringResultResponse
Summary: Regular Expression Test
Description: 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
Syntax:
PlumsailSP.FlowV1SharePointFlowJobsRegExpTestPost (RegExpTestRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
|
True |
Returns:
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
listUrl |
string List URL |
List name, URL or Guid |
|
contentTypeName |
string Content Type Name |
Name of the content type |
|
makeItDefault |
boolean Make It Default |
Make the content type default for the list |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
url |
string Url |
Target URL. If the URL is empty, then the top-level navigation item will be created |
|
location |
string Location |
The location of the node to add Values: [Top, QuickLaunch] |
|
prepend |
boolean Prepend |
Yes or No. The default value is No |
|
title |
string Title |
Title of navigation node |
|
parent |
string Parent |
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. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
groupName |
string Group Name |
The name of the group |
|
userLogin |
string User |
Login or email of the user which will be added to the specific group. Also you can specify multiple items using semicolon ';' delimited |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string SharePoint Site URL |
The full qualified URL (e.g. https://yourtenant.sharepoint.com/sites/team-site) |
|
siteDesign |
string Site Design |
The name or identifier of the SharePoint site design |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
isSuccess |
boolean IsSuccess |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
comment |
string Comment |
The comment to accompany document check in |
|
documentUrl |
string Document URL |
The URL of the document to check in |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
documentUrl |
string Document URL |
The URL of the document to check in |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
listUrl |
string List URL |
List name, URL or Guid |
|
itemId |
integer(int32) Item ID |
The ID of the source item |
|
destinationUrl |
string Destination Folder URL |
The URL of the folder where the attachments will be copied |
|
overwrite |
boolean Overwrite |
Overwrite if a file with the same name already exists |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
sourceUrl |
string Source URL |
The URL of the document to be copied. You can use full URL as well as domain relative URL |
|
destinationUrl |
string Destination URL |
The URL where the source document will be copied. You can use full URL as well as domain relative URL |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
sourceUrl |
string Source URL |
The URL of the document set to be copied. You can use full URL as well as domain relative URL |
|
destinationUrl |
string Destination URL |
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 |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
sourceUrl |
string Source URL |
The URL of the folder to be copied. You can use full URL as well as domain relative URL |
|
destinationUrl |
string Destination URL |
The URL where the source folder will be copied. You can use full URL as well as domain relative URL |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
listUrl |
string List URL |
List name, URL or Guid |
|
itemId |
string Item ID |
The ID of the source item |
|
destinationListUrl |
string Destination List URL |
The URL of the destination list. This list must contain same fields like in the source list |
|
copyAttachments |
boolean Copy Attachments |
Copy the item with attached files or not |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
documentSetName |
string DocumentSet Name |
The name of the document set |
|
targetListUrl |
string Target List |
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 |
|
contentType |
string Content Type |
Specify Content-Type by name or id |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
folderUrl |
string Folder URL |
The URL of the folder. If you specify full path, you can create several folders |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
targetListUrl |
string Target List |
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 |
|
folderPath |
string Folder Path |
The path where the folder will be created. The action will create all folders included into the path |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
title |
string Title |
Title of the list |
|
template |
string Template |
Title of the template that will be used for this list |
|
partialUrl |
string Partial URL |
Partial url of the list |
|
description |
string Description |
Description of the list |
|
onQuickLaunch |
boolean On Quick Launch |
Display this list on the Quick Launch |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
title |
string Title |
Title of new site |
|
template |
string Template |
Title of the site template that will be used for the new site |
|
leafUrl |
string Leaf URL |
A string that represents the URL leaf name |
|
description |
string Description |
Description of the web |
|
lcid |
integer(int32) Lcid |
LCID of the new web |
|
inheritPermissions |
boolean Inherit Permissions |
Specifies whether the new site will inherit permissions from its parent site |
|
inheritNavigation |
boolean Inherit Navigation |
Specifies whether the site inherits navigation |
|
onTopNav |
boolean On Top Navigation |
Display this site on the top link bar of the parent site. Default value is Yes |
|
onQuickLaunch |
boolean On Quick Launch |
Display this site on the Quick Launch of the parent site. Default value is No |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
groupName |
string Group Name |
The name of the group |
|
groupDescription |
string Group Description |
The description of the group |
|
userLogin |
string Group Owner |
The owner of the group, can be email or the user login |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
listName |
string List Name |
Title of the list or library |
|
itemId |
string Item ID or URL |
The item Id or Url of document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Document ID |
|
|
url |
string Document URL |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Document set ID |
|
|
url |
string Document set URL |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
featureId |
string(uuid) Feature ID |
Guid of the feature |
|
force |
boolean Force |
true to force action of the Feature even if there are errors; otherwise, false |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Folder ID |
|
|
url |
string Folder URL |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
listUrl |
string List URL |
List name, URL or Guid |
|
folderUrl |
string Folder URL |
The server relative URL of a list folder from which results will be returned |
|
camlQuery |
string CAML Query |
CAML query that will be run |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
listUrl |
string List URL |
List name, URL or Guid |
|
itemId |
integer(int32) Item ID |
Item ID of the item for which you want to get the version history |
|
fieldName |
string Field Name |
Name of the field for which you want to get the version history |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
optionName |
string Option Name |
Name of the option |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
users |
array of (SharePointUserResponse) Users |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
groupName |
string Group Name |
The name of the group |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
fileUrls |
array of (string) File URLs |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
resultItemId |
integer(int32) Result Item ID |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
listUrl |
string List URL |
List name, URL or Guid |
|
itemId |
integer(int32) Item ID |
The ID of the source item |
|
destinationUrl |
string Destination Folder URL |
The URL of the folder where the attachments will be moved |
|
overwrite |
boolean Overwrite |
Overwrite if a file with the same name already exists |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
sourceUrl |
string Source URL |
The URL of the document to be moved. You can use full URL as well as domain relative URL |
|
destinationUrl |
string Destination URL |
The URL where the source document will be moved. You can use full URL as well as domain relative URL |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
sourceUrl |
string Source URL |
The URL of the document set to be moved. You can use full URL as well as domain relative URL |
|
destinationUrl |
string Destination URL |
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 |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
sourceUrl |
string Source URL |
The URL of the folder to be moved. You can use full URL as well as domain relative URL |
|
destinationUrl |
string Destination URL |
The URL where the source folder will be moved. You can use full URL as well as domain relative URL |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
listUrl |
string List URL |
List name, URL or Guid |
|
itemId |
string Item ID |
The ID of the source item |
|
destinationListUrl |
string Destination List URL |
The URL of the destination list. This list must contain same fields like in the source list |
|
copyAttachments |
boolean Move Attachments |
Move the item with attached files or not |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
content |
string(byte) Content of CSV document |
Content of CSV document |
|
headers |
string Headers |
Comma separated list of headers in the same order as CSV columns |
|
delimiter |
string Delimiter |
Delimiter of columns (by default it is just comma) Values: [Comma, Semicolon, Tab] |
|
skipFirstLine |
boolean Skip first line |
Select "Yes" if your CSV has headers as a first line. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
xmlTemplateContent |
string(byte) Template Content |
The content of an XML or PnP template |
|
overwriteSystemPropertyBagValues |
boolean Overwrite System PropertyBag Values |
Specify this parameter if you want to overwrite and/or create properties that are known to be system entries (starting with vti_, dlc_, etc.) |
|
ignoreDuplicateDataRowErrors |
boolean Ignore Duplicate Data Row Errors |
Ignore duplicate data row errors when the data row in the template already exists. |
|
clearNavigation |
boolean Clear Navigation |
If you specify this value the navigation nodes will always be removed before adding the nodes in the template |
|
provisionContentTypesToSubWebs |
boolean Provision Content Types To SubWebs |
If set content types will be provisioned if the target web is a subweb. |
|
provisionFieldsToSubWebs |
boolean Provision Fields To SubWebs |
If set fields will be provisioned if the target web is a subweb. |
|
handlers |
string Handlers |
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. |
|
excludeHandlers |
string Exclude Handlers |
Allows you to run all handlers, excluding the ones specified. |
|
parameters |
string Parameters |
Allows you to specify parameters that can be referred to in the template by means of the <Key>=<Value>; token |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
pattern |
string Pattern |
Regular expression pattern |
|
text |
string Text |
String to search for matches |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
replacement |
string Replacement |
Replacement string |
|
pattern |
string Pattern |
Regular expression pattern |
|
text |
string Text |
String to search for matches |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
pattern |
string Pattern |
Regular expression pattern |
|
text |
string Text |
String to search for matches |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
sourceUrl |
string Document URL |
The URL of the document to be removed. You can use full URL as well as domain relative URL |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
sourceUrl |
string Folder URL |
The URL of the library where the source folder will be removed. You can use full URL as well as domain relative URL |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
location |
string Location |
The location of the node to add Values: [Top, QuickLaunch] |
|
title |
string Title |
Title of navigation node |
|
parent |
string Parent |
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. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
groupName |
string Group Name |
The name of the group |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
groupName |
string Group Name |
The name of the group |
|
userLogin |
string User |
Login or email of the user which will be removed from the specific group. Also you can specify multiple items using semicolon ';' delimited |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
groupType |
string Group Type |
Type of the group Values: [Owner, Member, Visitor] |
|
groupName |
string Group Name |
Name of the group |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) User ID |
|
|
loginName |
string User Name |
|
|
|
string User Email |
|
|
claims |
string User Claims |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
editor |
|
|
|
modified |
string(date-time) Modified |
|
|
value |
string Value |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
title |
string Title |
The title for the group |
|
description |
string Description |
The description for the group |
|
owner |
string Owner |
The owner for the group, which can be a user or another group |
|
allowMembersEditMembership |
boolean Allow Members Edit Membership |
A value that specifies whether group members can modify membership in the group |
|
allowRequestToJoinLeave |
boolean Allow Request to Join Leave |
A value that specifies whether to allow users to request membership in the group and to allow users to request to leave the group |
|
autoAcceptRequestToJoinLeave |
boolean Auto Accept Request to Join Leave |
A value that specifies whether users are automatically added or removed when they make a request |
|
onlyAllowMembersViewMembership |
boolean Only Allow Members View Membership |
A value that specifies whether only group members are allowed to view the list of members in the group |
|
requestToJoinLeaveEmailSetting |
string Request to Join Leave Email Setting |
The e-mail address to which membership requests are sent |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
optionValue |
string Option Value |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
title |
string Title |
The title for the website |
|
description |
string Description |
The description for the site |
|
quickLaunchEnabled |
boolean Quick Launch Enabled |
A value that specifies whether the Quick Launch area is enabled on the website |
|
treeViewEnabled |
boolean Tree View Enabled |
A value that specifies whether the SharePoint Foundation TreeView is enabled in the left navigational area of website pages |
|
siteLogoUrl |
string Site Logo URL |
The absolute URL of the website logo |
|
alternateCssUrl |
string Alternate Css URL |
The URL for an alternate cascading style sheet (CSS) to use in the website |
|
associatedMemberGroup |
string Associated Member Group |
The users who have been given contribute permissions to the website |
|
associatedOwnerGroup |
string Associated Owner Group |
The associated owner groups of the website |
|
associatedVisitorGroup |
string Associated Visitor Group |
The associated visitor group of the website |
|
containsConfidentialInfo |
boolean Contains Confidential Info |
A value that specifies whether the SharePoint site contain a confidential information |
|
customMasterUrl |
string Custom Master URL |
The URL for a custom master page file to apply to the website |
|
enableMinimalDownload |
boolean Enable Minimal Download |
A value that specifies whether the Web site should use Minimal Download Strategy |
|
isMultilingual |
boolean Is Multilingual |
A value that indicates whether a multilingual user interface is enabled for the website |
|
masterUrl |
string Master URL |
The URL of the master page that is used for the website |
|
membersCanShare |
boolean Members Can Share |
Allow Members to share the site and invite others |
|
noCrawl |
boolean No Crawl |
A value that specifies whether searching is enabled for the website |
|
overwriteTranslationsOnChange |
boolean Overwrite Translations on Change |
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 |
|
requestAccessEmail |
string Request Access Email |
The e-mail address to which requests for access are sent |
|
saveSiteAsTemplateEnabled |
boolean Save Site as Template Enabled |
A value that specifies whether the Web site can be saved as a site template |
|
serverRelativeUrl |
string Server Relative URL |
The server-relative URL for the website |
|
syndicationEnabled |
boolean Syndication Enabled |
A value that specifies whether Really Simple Syndication (RSS) is enabled in the website |
|
uiVersion |
integer(int32) UI Version |
The current version number of the user interface |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
listUrl |
string List URL |
List name, URL or Guid |
|
workflowName |
string Workflow Name |
Name of the workflow which will be started |
|
itemId |
integer(int32) Item ID |
Item ID of the item for which you want to start the list workflow |
|
inputParameters |
Input Parameters |
JSON string that contains input parameters for workflow |
Summary: Input Parameters
Description: JSON string that contains input parameters for workflow
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
workflowName |
string Workflow Name |
Name of the workflow which will be started |
|
inputParameters |
Input Parameters |
JSON string that contains input parameters for workflow |
Summary: Input Parameters
Description: JSON string that contains input parameters for workflow
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
result |
string Result |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
listName |
string List Name |
Title of the list or library |
|
itemId |
string Item ID or URL |
The item Id or Url of document |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
listName |
string List Name |
Title of the list or library |
|
itemId |
string Item ID or URL |
The item Id or Url of document/folder |
|
data |
Field values |
JSON object like { "InternalFieldName": "FieldValue" } |
Summary: Field values
Description: JSON object like { "InternalFieldName": "FieldValue" }
Properties:
|
Name |
Type |
Summary |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
properties |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
groupName |
string Group Name |
The name of the group |
|
properties |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
spUrl |
string SharePoint Site URL |
The action will be executed on the specified SharePoint site |
|
groupName |
string Group Name |
The name of the group |
|
userLogin |
string User |
Login or email of a user for checking if he is a member in the specified group |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
userExists |
boolean User Exists |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
countVersions |
integer(int32) Count Versions |
|
|
versions |
array of (SharePointVersionResponse) Versions |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
url |
string Web URL |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
workflowGuid |
string Workflow GUID |
|