Connectors Reference

Plumsail SP

To know more please visit https://plumsail.com/actions/

 

Status: Preview

Tier: Standard

Version: v1

 

Actions:

Name

Summary

FlowV1SharePointFlowJobsCreateSiteFromTemplatePost (CreateSiteFromTemplateRequest request)

Create SharePoint Site from Template

FlowV1SharePointFlowJobsChangePermissionsPost (string actionType, string target, FlowV1SharePointFlowJobsChangePermissionsPostParameterRequest request)

Change SharePoint permissions

FlowV1SharePointFlowJobsActivateFeaturePost (ActivateFeatureRequest request)

Activate SharePoint Feature

FlowV1SharePointFlowJobsCreateListOrLibraryPost (CreateListOrLibraryRequest request)

Create SharePoint List or Library

FlowV1SharePointFlowJobsSetDefaultSiteGroupPost (SetDefaultSiteGroupRequest request)

Set Default SharePoint Site Group

FlowV1SharePointFlowJobsCopyDocumentFromLibraryPost (CopyDocumentRequest request)

Copy SharePoint Document from Library

FlowV1SharePointFlowJobsMoveDocumentFromLibraryPost (MoveDocumentRequest request)

Move SharePoint Document from Library

FlowV1SharePointFlowJobsRemoveDocumentByUrlPost (RemoveDocumentRequest request)

Remove SharePoint Document by URL

FlowV1SharePointFlowJobsCopyDocumentSetPost (CopyDocumentSetRequest request)

Copy SharePoint Document Set

FlowV1SharePointFlowJobsMoveDocumentSetPost (MoveDocumentSetRequest request)

Move SharePoint Document Set

FlowV1SharePointFlowJobsCreateFolderByUrlPost (CreateFolderByUrlRequest request)

Create SharePoint Folder by URL

FlowV1SharePointFlowJobsCreateFolderInListPost (CreateFolderInListRequest request)

Create SharePoint Folder in List

FlowV1SharePointFlowJobsRemoveFolderByUrlPost (RemoveFolderByUrlRequest request)

Remove SharePoint Folder by URL

FlowV1SharePointFlowJobsCopyFolderFromLibraryPost (CopyFolderRequest request)

Copy SharePoint Folder from Library

FlowV1SharePointFlowJobsMoveFolderFromLibraryPost (MoveFolderRequest request)

Move SharePoint Folder from Library

FlowV1SharePointFlowJobsCheckInDocumentPost (CheckInDocumentRequest request)

Check In SharePoint Document

FlowV1SharePointFlowJobsCheckOutDocumentPost (CheckOutDocumentRequest request)

Check Out SharePoint Document

FlowV1SharePointFlowSchemaChangePermissionsPost (string actionType, string target)

 

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

ActivateFeatureRequest

 

CheckInDocumentRequest

 

CheckOutDocumentRequest

 

CopyDocumentRequest

 

CopyDocumentSetRequest

 

CopyFolderRequest

 

CreateFolderByUrlRequest

 

CreateFolderInListRequest

 

CreateListOrLibraryRequest

 

CreateSiteFromTemplateRequest

 

DocumentInfoResponse

 

DocumentSetInfoResponse

 

FlowV1SharePointFlowJobsChangePermissionsPostParameterRequest

 

FolderInfoResponse

 

MoveDocumentRequest

 

MoveDocumentSetRequest

 

MoveFolderRequest

 

RemoveDocumentRequest

 

RemoveFolderByUrlRequest

 

SetDefaultSiteGroupRequest

 

WebUrlResponse

 

 

Actions:

FlowV1SharePointFlowJobsCreateSiteFromTemplatePost

Summary: Create SharePoint Site 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

CreateSiteFromTemplateRequest

 

 

True

 

Returns:

          Type:WebUrlResponse

 

FlowV1SharePointFlowJobsChangePermissionsPost

Summary: Change SharePoint permissions

Description: Create a new SharePoint site based on specific template

 

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]

The target of the operation

True

request

FlowV1SharePointFlowJobsChangePermissionsPostParameterRequest

 

 

True

 

Returns:

 

FlowV1SharePointFlowJobsActivateFeaturePost

Summary: Activate SharePoint Feature

Description: Activate a feature with specific ID

 

Syntax:

PlumsailSP.FlowV1SharePointFlowJobsActivateFeaturePost (ActivateFeatureRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

ActivateFeatureRequest

 

 

True

 

Returns:

 

FlowV1SharePointFlowJobsCreateListOrLibraryPost

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

CreateListOrLibraryRequest

 

 

True

 

Returns:

 

FlowV1SharePointFlowJobsSetDefaultSiteGroupPost

Summary: Set Default SharePoint Site Group

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

 

Syntax:

PlumsailSP.FlowV1SharePointFlowJobsSetDefaultSiteGroupPost (SetDefaultSiteGroupRequest request)

 

Parameters:

Name

Type

Summary

Required

Related Action

request

SetDefaultSiteGroupRequest

 

 

True

 

Returns:

 

FlowV1SharePointFlowJobsCopyDocumentFromLibraryPost

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

CopyDocumentRequest

 

 

True

 

Returns:

          Type:DocumentInfoResponse

 

FlowV1SharePointFlowJobsMoveDocumentFromLibraryPost

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

MoveDocumentRequest

 

 

True

 

Returns:

          Type:DocumentInfoResponse

 

FlowV1SharePointFlowJobsRemoveDocumentByUrlPost

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

RemoveDocumentRequest

 

 

True

 

Returns:

 

FlowV1SharePointFlowJobsCopyDocumentSetPost

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

CopyDocumentSetRequest

 

 

True

 

Returns:

          Type:DocumentSetInfoResponse

 

FlowV1SharePointFlowJobsMoveDocumentSetPost

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

MoveDocumentSetRequest

 

 

True

 

Returns:

          Type:DocumentSetInfoResponse

 

FlowV1SharePointFlowJobsCreateFolderByUrlPost

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

CreateFolderByUrlRequest

 

 

True

 

Returns:

          Type:FolderInfoResponse

 

FlowV1SharePointFlowJobsCreateFolderInListPost

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

CreateFolderInListRequest

 

 

True

 

Returns:

          Type:FolderInfoResponse

 

FlowV1SharePointFlowJobsRemoveFolderByUrlPost

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

RemoveFolderByUrlRequest

 

 

True

 

Returns:

 

FlowV1SharePointFlowJobsCopyFolderFromLibraryPost

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

CopyFolderRequest

 

 

True

 

Returns:

          Type:FolderInfoResponse

 

FlowV1SharePointFlowJobsMoveFolderFromLibraryPost

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

MoveFolderRequest

 

 

True

 

Returns:

          Type:FolderInfoResponse

 

FlowV1SharePointFlowJobsCheckInDocumentPost

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

CheckInDocumentRequest

 

 

True

 

Returns:

          Type:DocumentInfoResponse

 

FlowV1SharePointFlowJobsCheckOutDocumentPost

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

CheckOutDocumentRequest

 

 

True

 

Returns:

          Type:DocumentInfoResponse

 

FlowV1SharePointFlowSchemaChangePermissionsPost

Summary:

Description:

 

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]

The target of the operation

True

 

Returns:

 


 

ActivateFeatureRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

featureId

string(uuid)

Feature ID

Guid of the feature

force

boolean

Force

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

spUrl

string

SharePoint Site URL

URL of the current SharePoint site. This property defines context of the workflow action. All actions performed by workflow action will be executed on specified SharePoint site. If this property is blank it will use current SharePoint site by default


 

CheckInDocumentRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

comment

string

Comment

The comment to accompany document check in

documentUrl

string

Document URL

The URL of the document to check in

spUrl

string

SharePoint Site URL

URL of the current SharePoint site. This property defines context of the workflow action. All actions performed by workflow action will be executed on specified SharePoint site. If this property is blank it will use current SharePoint site by default


 

CheckOutDocumentRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

documentUrl

string

Document URL

The URL of the document to check in

spUrl

string

SharePoint Site URL

URL of the current SharePoint site. This property defines context of the workflow action. All actions performed by workflow action will be executed on specified SharePoint site. If this property is blank it will use current SharePoint site by default


 

CopyDocumentRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

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

spUrl

string

SharePoint Site URL

URL of the current SharePoint site. This property defines context of the workflow action. All actions performed by workflow action will be executed on specified SharePoint site. If this property is blank it will use current SharePoint site by default


 

CopyDocumentSetRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

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

spUrl

string

SharePoint Site URL

URL of the current SharePoint site. This property defines context of the workflow action. All actions performed by workflow action will be executed on specified SharePoint site. If this property is blank it will use current SharePoint site by default


 

CopyFolderRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

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

spUrl

string

SharePoint Site URL

URL of the current SharePoint site. This property defines context of the workflow action. All actions performed by workflow action will be executed on specified SharePoint site. If this property is blank it will use current SharePoint site by default


 

CreateFolderByUrlRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

folderUrl

string

Folder URL

The URL of the folder. If you specify full path, you can create several folders

spUrl

string

SharePoint Site URL

URL of the current SharePoint site. This property defines context of the workflow action. All actions performed by workflow action will be executed on specified SharePoint site. If this property is blank it will use current SharePoint site by default


 

CreateFolderInListRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

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

spUrl

string

SharePoint Site URL

URL of the current SharePoint site. This property defines context of the workflow action. All actions performed by workflow action will be executed on specified SharePoint site. If this property is blank it will use current SharePoint site by default


 

CreateListOrLibraryRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

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

spUrl

string

SharePoint Site URL

URL of the current SharePoint site. This property defines context of the workflow action. All actions performed by workflow action will be executed on specified SharePoint site. If this property is blank it will use current SharePoint site by default


 

CreateSiteFromTemplateRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

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

spUrl

string

SharePoint Site URL

URL of the current SharePoint site. This property defines context of the workflow action. All actions performed by workflow action will be executed on specified SharePoint site. If this property is blank it will use current SharePoint site by default


 

DocumentInfoResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Document ID

 

url

string

Document URL

 


 

DocumentSetInfoResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Document set ID

 

url

string

Document set URL

 


 

FlowV1SharePointFlowJobsChangePermissionsPostParameterRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

FolderInfoResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer(int32)

Folder ID

 

url

string

Folder URL

 


 

MoveDocumentRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

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

spUrl

string

SharePoint Site URL

URL of the current SharePoint site. This property defines context of the workflow action. All actions performed by workflow action will be executed on specified SharePoint site. If this property is blank it will use current SharePoint site by default


 

MoveDocumentSetRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

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

spUrl

string

SharePoint Site URL

URL of the current SharePoint site. This property defines context of the workflow action. All actions performed by workflow action will be executed on specified SharePoint site. If this property is blank it will use current SharePoint site by default


 

MoveFolderRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

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

spUrl

string

SharePoint Site URL

URL of the current SharePoint site. This property defines context of the workflow action. All actions performed by workflow action will be executed on specified SharePoint site. If this property is blank it will use current SharePoint site by default


 

RemoveDocumentRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

sourceUrl

string

Document URL

The URL of the document to be removed. You can use full URL as well as domain relative URL

spUrl

string

SharePoint Site URL

URL of the current SharePoint site. This property defines context of the workflow action. All actions performed by workflow action will be executed on specified SharePoint site. If this property is blank it will use current SharePoint site by default


 

RemoveFolderByUrlRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

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

spUrl

string

SharePoint Site URL

URL of the current SharePoint site. This property defines context of the workflow action. All actions performed by workflow action will be executed on specified SharePoint site. If this property is blank it will use current SharePoint site by default


 

SetDefaultSiteGroupRequest

Summary:

Description:

 

          Properties:

Name

Type

Summary

groupType

string

Group Type

Type of the group  Values: [Owner, Member, Visitor]

groupName

string

Group Name

Name of the group

spUrl

string

SharePoint Site Url

URL of the current SharePoint site. This property defines context of the workflow action. All actions performed by workflow action will be executed on specified SharePoint site. If this property is blank it will use current SharePoint site by default


 

WebUrlResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

url

string

Web URL