SharePoint

SharePoint helps organizations share and collaborate with colleagues, partners, and customers. You can connect to SharePoint Online or to an on-premises SharePoint 2013 or 2016 farm using the On-Premises Data Gateway to manage documents and list items.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions
Flow Standard All Flow regions
PowerApps Standard All PowerApps regions

To use this connector in PowerApps, learn more here.

PowerApps data type mappings

PowerApps SharePoint
Boolean Yes/No (checkbox)
DateTime Date and Time
Image Hyperlink or Picture
Complex Choice, Lookup, Person or Group, Task Outcome, External Data, Managed Metadata
Number Number, Currency, ID
Text Single line of text, Multiple lines of text, Calculated

Note

SharePoint types that map to PowerApps as complex often have subfields that map to basic types such as text and number.

PowerApps delegable functions and operations for SharePoint

The following PowerApps operations, for a given data type, may be delegated to SharePoint for processing (rather than processing locally within PowerApps).

Item Number Text Boolean DateTime Complex [1]
Filter Yes Yes Yes No [4] Yes
Sort Yes Yes Yes Yes No
SortByColumns Yes Yes Yes Yes No
Lookup Yes Yes Yes No Yes
= Yes Yes Yes No [4] Yes
<, <=,<>, >, >= Yes [2] No No No Yes
StartsWith - Yes - - Yes
IsBlank - No [3] - - No

Note

Expressions that are joined with And or Or are delegable to SharePoint. Not isn't delegable.

  1. SharePoint supports delegation of complex types by deferring the decision for delegation to the subfield involved. Check the type of the subfield being used on the complex type and then check this table for delegation capabilities. Note that only Email and DisplayName are delegable in the Person data type.
  2. The SharePoint ID field for a table is a number field in PowerApps. However, SharePoint only supports the equal ('=') operation for delegation on an ID field.
  3. A formula such as Filter(..., IsBlank(CustomerId)) won't delegate to SharePoint. However, that formula is semantically close to Filter(..., CustomerId = Blank()), which will delegate to SharePoint. These formulas aren't equivalent because the second formula won't treat the empty string ("") as empty. However, the second formula might work for your purposes. On SharePoint, this approach will work for the equals operator ("=") but not the operator for not equals ("<>").
  4. Null assignment is delegable for a DateTime and Date field. Actual DateTime and Date values are not delegable. Filtering a DateTime or Date field for Blank is supported. Filter on not null is not supported. Only the = (not the <>) operator is delegated to SharePoint (the Not operator is not delegated.)

Creating a connection

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

Name Type Description
Authentication Type string

Authentication type to connect to your database

Username securestring

Username credential

Password securestring

Password credential

Gateway gatewaySetting

Throttling Limits

Name Calls Renewal Period
API calls per connection60060 seconds

Actions

Add attachment

Adds a new attachment to the specified list item.

Approve hub site join request

Approve hub site join request. This will return an approval token that can be used to complete the join request using the join hub site action.

Cancel hub site join request

Cancel hub join request. If applicable, you should specify the same Approval Correlation Id as used in the "Set hub site join status to pending" action.

Check in file

Check in a checked out file in a document library, which makes the version of the document available to others.

Check out file

Check out a file in a document library to prevent others from editing the document, and your changes from being visible until the documented is checked in.

Copy file

Copies a file. Works in a similar way to the "Copy to" command in SharePoint libraries. Returns information about the new file after copy.

Copy file (deprecated)

Copies a file to a SharePoint site.

Copy folder

Copies a folder. Works in a similar way to the "Copy to" command in SharePoint libraries. Returns information about the new folder after copy.

Create file

Uploads a file to a SharePoint site. Make sure to pick an existing library.

Create item

Creates a new item in a SharePoint list.

Create new folder

Creates a new folder or folder path.

Create sharing link for a file or folder

Create sharing link for a file or folder.

Delete attachment

Deletes the specified attachment.

Delete file

Deletes the file specified by the file identifier.

Delete item

Deletes an item from a SharePoint list.

Discard check out

If you check out a file and don’t make changes to it, or you make changes that you don’t want to keep, you can simply discard the checkout, rather than saving the file. If your organization tracks versions, a new version is created each time you check a file back into the library. By discarding the checkout, you can avoid making new versions when you haven’t made any changes to the file.

Extract folder

Extracts an archive file into a SharePoint folder (example: .zip).

Get all lists and libraries

Get all lists and libraries.

Get attachment content

Returns file contents using the file identifier. The contents can be copied somewhere else, or be used as an attachment.

Get attachments

Returns the list of attachments for the specified list item. You can add a "Get attachment content" step and use the "File identifier" property returned by this action to get to the contents of the file.

Get file content

Gets file contents using the file identifier. The contents can be copied somewhere else, or be used as an attachment.

Get file content using path

Gets file contents using the file path.

Get file metadata

Gets information about the file such as size, etag, created date, etc. Uses a file identifier to pick the file. Use "Get file properties" action to get to the values stored in the columns in the library.

Get file metadata using path

Gets information about the file such as size, etag, created date, etc. Uses a file path to pick the file. Use "Get file properties" action to get to the values stored in the columns in the library.

Get file properties

Gets the properties saved in the columns in the library for the item specified by the item id.

        You can add a "Get file content" step and use the "File identifier" property returned by this action to get to the contents of the file.

        When using this with the On-Premises Data Gateway, the name of the library to connect to may need to be entered manually.
Get files (properties only)

Gets the properties saved in the columns in the library for all folders and files stored in the library.

        You can also filter down to the items that match a condition. An "Apply to each" section is usually used to work with the output from this action.

        When using this with the On-Premises Data Gateway, the name of the library to connect to may need to be entered manually.
Get folder metadata

Gets information about the folder. Uses a file identifier to pick the folder.

Get folder metadata using path

Gets information about the folder. Uses a folder path to pick the folder.

Get item

Gets a single item by its id from a SharePoint list.

Get items

Gets items from a SharePoint list.

Get list views

Gets views from a SharePoint list.

Get lists

Gets SharePoint lists from a site.

Grant access to an item or a folder

Grant access to an item or a folder in SharePoint to specific people.

Join hub site

Join the requested site to the hub site. An Approval Token is required to complete the join successfully if that hub requires approval. If applicable, you should specify the same Approval Correlation Id as used in the "Set hub site join status to pending" action.

List folder

Returns files contained in a SharePoint folder.

List root folder

Returns files in the root SharePoint folder.

Move file

Moves a file. Works in a similar way to the "Move to" command in SharePoint libraries. Returns information about the new file after move.

Move folder

Moves a folder. Works in a similar way to the "Move to" command in SharePoint libraries. Returns information about the new folder after move.

Resolve person

Returns a single matching user value so it can be assigned to a column of type person. If there are no matches, or multiple matches, this action will error out.

Send an HTTP request to SharePoint

Construct a SharePoint REST API to invoke. Note – This action may execute any SharePoint REST API you have access to. Please proceed with caution.

Set content approval status

Sets the content approval status for an item in a list or library that has content approval turned on. You must provide an ETag for pages and files. You can get the ETag using the Get File Metadata action. This action is only available for SharePoint Online and SharePoint 2019.

Set hub site join status to pending

Set the requested site's hub join request status to pending. The Approval Correlation Id is an optional parameter that helps SharePoint identify a particular hub join request. The requesting site can only have one pending request at a given time.

Stop sharing an item or a folder

Delete all links giving access to an item or a folder and remove all people with direct access except for owners.

Update file

Updates the contents of the file specified by the file identifier.

Update file properties

Updates the properties stored in columns in a library for the item specified by the item id. Use "Update file" action to update file contents.

        When using this with the On-Premises Data Gateway, the name of the library to connect to may need to be entered manually.
Update item

Updates an item in a SharePoint list.

Add attachment

Adds a new attachment to the specified list item.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

List Name
table True string

SharePoint list name.

Id
itemId True integer

Id of the list item to attach the file to.

File Name
displayName True string

File name.

File Content
body True binary

Content of the file.

Returns

SharePoint list item attachment

Approve hub site join request

Approve hub site join request. This will return an approval token that can be used to complete the join request using the join hub site action.

Parameters

Name Key Required Type Description
Hub Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Requesting Site Id
joiningSiteId True string

Id of the requesting site.

Returns

Result object of ApproveHubSiteJoin action

Cancel hub site join request

Cancel hub join request. If applicable, you should specify the same Approval Correlation Id as used in the "Set hub site join status to pending" action.

Parameters

Name Key Required Type Description
Requesting Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Approval Correlation Id
approvalCorrelationId string

Approval correlation identifier for this request.

Check in file

Check in a checked out file in a document library, which makes the version of the document available to others.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Library Name
table True string

SharePoint library name.

Id
id True integer

Id of the list item the file is attached to.

Comments
comment True string

Type comments describing what has changed in this version

Check in type
checkinType True integer

Select the type of version you would like to check in

Check out file

Check out a file in a document library to prevent others from editing the document, and your changes from being visible until the documented is checked in.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Library Name
table True string

SharePoint library name.

Id
id True integer

Id of the list item the file is attached to.

Copy file

Copies a file. Works in a similar way to the "Copy to" command in SharePoint libraries. Returns information about the new file after copy.

Parameters

Name Key Required Type Description
Current Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

File to Copy
sourceFileId True string

File Identifier

Destination Site Address
destinationDataset True string

Example: https://contoso.sharepoint.com/sites/sitename

Destination Folder
destinationFolderPath True string

Destination Folder

If another file is already there
nameConflictBehavior True integer

Pick one of the options available

Returns

The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized

Copy file (deprecated)

Copies a file to a SharePoint site.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Source File Path
source True string

Path to the source file.

Destination File Path
destination True string

Path to the destination file.

Overwrite Flag
overwrite boolean

Whether or not to overwrite the destination file if it exists.

Returns

Blob metadata

Copy folder

Copies a folder. Works in a similar way to the "Copy to" command in SharePoint libraries. Returns information about the new folder after copy.

Parameters

Name Key Required Type Description
Current Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Folder to Copy
sourceFolderId True string

File Identifier

Destination Site Address
destinationDataset True string

Example: https://contoso.sharepoint.com/sites/sitename

Destination Folder
destinationFolderPath True string

Destination Folder

If another folder is already there
nameConflictBehavior True integer

Pick one of the options available

Returns

The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized

Create file

Uploads a file to a SharePoint site. Make sure to pick an existing library.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Folder Path
folderPath True string

Must start with an existing library. Add folders if needed.

File Name
name True string

Name of the file.

File Content
body True binary

Content of the file.

Returns

The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized

Create item

Creates a new item in a SharePoint list.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename

List Name
table True string

SharePoint list name

Item
item True dynamic

Item to create

Limit Columns by View
view string

Avoid column threshold issues by only using columns defined in a view

Returns

The outputs of this operation are dynamic.

Create new folder

Creates a new folder or folder path.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

List or Library
table True string

SharePoint list or library name.

Folder Path
path True string

Example: folder1/folder2/folder3

Limit Columns by View
view string

Avoid column threshold issues by only using columns defined in a view.

Returns

The outputs of this operation are dynamic.

Create sharing link for a file or folder.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Library Name
table True string

SharePoint library name.

Item Id
id True integer

Id of the file or folder item.

Link Type
type True string

The type of sharing link to create

Link Scope
scope True string

Choose who your sharing link gives access to. "Anyone" option will only work if your administrator has enabled it.

Link Expiration
expirationDateTime date-time

The date after which the link will expire in yyyy-MM-dd format. Only applicable for anonymous links.

Returns

Internal structure for sharing links

Delete attachment

Deletes the specified attachment.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

List Name
table True string

SharePoint list name.

Id
itemId True integer

Id of the list item the file is attached to.

File Identifier
attachmentId True string

File identifier for the attachment.

Delete file

Deletes the file specified by the file identifier.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

File Identifier
id True string

Select a file.

Delete item

Deletes an item from a SharePoint list.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename

List Name
table True string

SharePoint list name

Id
id True integer

Unique identifier of item to be deleted

Discard check out

If you check out a file and don’t make changes to it, or you make changes that you don’t want to keep, you can simply discard the checkout, rather than saving the file. If your organization tracks versions, a new version is created each time you check a file back into the library. By discarding the checkout, you can avoid making new versions when you haven’t made any changes to the file.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Library Name
table True string

SharePoint library name.

Id
id True integer

Id of the list item the file is attached to.

Extract folder

Extracts an archive file into a SharePoint folder (example: .zip).

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Source File Path
source True string

Path to the source file.

Destination Folder Path
destination True string

Path to the destination folder.

Overwrite Flag
overwrite boolean

Whether or not to overwrite the destination file if it exists.

Returns

Get all lists and libraries

Get all lists and libraries.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Returns

Represents a list of tables.

Body
TablesList

Get attachment content

Returns file contents using the file identifier. The contents can be copied somewhere else, or be used as an attachment.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

List Name
table True string

SharePoint list name.

Id
itemId True integer

Id of the list item the file is attached to.

File Identifier
attachmentId True string

File identifier for the attachment.

Returns

The content of the attachment.

Attachment Content
binary

Get attachments

Returns the list of attachments for the specified list item. You can add a "Get attachment content" step and use the "File identifier" property returned by this action to get to the contents of the file.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

List Name
table True string

SharePoint list name.

Id
itemId True string

Id of the list item to get attachments from.

Returns

Get file content

Gets file contents using the file identifier. The contents can be copied somewhere else, or be used as an attachment.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

File Identifier
id True string

Select a file.

Infer Content Type
inferContentType boolean

Infer content-type based on extension.

Returns

The content of the file.

File Content
binary

Get file content using path

Gets file contents using the file path.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

File Path
path True string

Select a file.

Infer Content Type
inferContentType boolean

Infer content-type based on extension.

Returns

The content of the file.

File Content
binary

Get file metadata

Gets information about the file such as size, etag, created date, etc. Uses a file identifier to pick the file. Use "Get file properties" action to get to the values stored in the columns in the library.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

File Identifier
id True string

Select a file.

Returns

The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized

Get file metadata using path

Gets information about the file such as size, etag, created date, etc. Uses a file path to pick the file. Use "Get file properties" action to get to the values stored in the columns in the library.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

File Path
path True string

Select a file.

Returns

The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized

Get file properties

Gets the properties saved in the columns in the library for the item specified by the item id.

        You can add a "Get file content" step and use the "File identifier" property returned by this action to get to the contents of the file.

        When using this with the On-Premises Data Gateway, the name of the library to connect to may need to be entered manually.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename

Library Name
table True string

SharePoint library name

Id
id True integer

Unique identifier of item to be retrieved

Limit Columns by View
view string

Avoid column threshold issues by only using columns defined in a view

Returns

The outputs of this operation are dynamic.

Get files (properties only)

Gets the properties saved in the columns in the library for all folders and files stored in the library.

        You can also filter down to the items that match a condition. An "Apply to each" section is usually used to work with the output from this action.

        When using this with the On-Premises Data Gateway, the name of the library to connect to may need to be entered manually.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename

Library Name
table True string

SharePoint library name

Filter Query
$filter string

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

Order By
$orderby string

An ODATA orderBy query for specifying the order of entries.

Top Count
$top integer

Total number of entries to retrieve (default = all).

Limit Columns by View
view string

Avoid column threshold issues by only using columns defined in a view

Returns

The outputs of this operation are dynamic.

Get folder metadata

Gets information about the folder. Uses a file identifier to pick the folder.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

File Identifier
id True string

Select a folder.

Returns

The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized

Get folder metadata using path

Gets information about the folder. Uses a folder path to pick the folder.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Folder Path
path True string

Select a folder.

Returns

The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized

Get item

Gets a single item by its id from a SharePoint list.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename

List Name
table True string

SharePoint list name

Id
id True integer

Unique identifier of item to be retrieved

Limit Columns by View
view string

Avoid column threshold issues by only using columns defined in a view

Returns

The outputs of this operation are dynamic.

Get items

Gets items from a SharePoint list.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename

List Name
table True string

SharePoint list name

Filter Query
$filter string

An ODATA filter query to restrict the entries returned (e.g. stringColumn eq 'string' OR numberColumn lt 123).

Order By
$orderby string

An ODATA orderBy query for specifying the order of entries.

Top Count
$top integer

Total number of entries to retrieve (default = all).

Limit Columns by View
view string

Avoid column threshold issues by only using columns defined in a view

Returns

The outputs of this operation are dynamic.

Get list views

Gets views from a SharePoint list.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

List Name
table True string

SharePoint list name.

Returns

List of Tables
array of Table

Get lists

Gets SharePoint lists from a site.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename

Returns

Represents a list of tables.

Body
TablesList

Grant access to an item or a folder

Grant access to an item or a folder in SharePoint to specific people.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

List or Library Name
table True string

SharePoint list or library name.

Id
id True integer

Unique identifier of the item or folder you want to grant access to.

Recipients
recipients True email

A collection of recipients who will receive the sharing invitation

Roles
roleValue True string

Specify a role that is to be granted to the recipients

Message
emailBody string

A plain text formatted message that is included in the sharing invitation

Notify Recipients
sendEmail boolean

Specify whether recipients should receive an email notification message

Join hub site

Join the requested site to the hub site. An Approval Token is required to complete the join successfully if that hub requires approval. If applicable, you should specify the same Approval Correlation Id as used in the "Set hub site join status to pending" action.

Parameters

Name Key Required Type Description
Requesting Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Hub Site Id
hubSiteId True string

Id of the hub site.

Approval Token
approvalToken string

Approval token for this request.

Approval Correlation Id
approvalCorrelationId string

Approval correlation identifier for this request.

List folder

Returns files contained in a SharePoint folder.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

File Identifier
id True string

Unique identifier of the folder.

Returns

List root folder

Returns files in the root SharePoint folder.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Returns

Move file

Moves a file. Works in a similar way to the "Move to" command in SharePoint libraries. Returns information about the new file after move.

Parameters

Name Key Required Type Description
Current Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

File to Move
sourceFileId True string

File Identifier

Destination Site Address
destinationDataset True string

Example: https://contoso.sharepoint.com/sites/sitename

Destination Folder
destinationFolderPath True string

Destination Folder

If another file is already there
nameConflictBehavior True integer

Pick one of the options available

Returns

The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized

Move folder

Moves a folder. Works in a similar way to the "Move to" command in SharePoint libraries. Returns information about the new folder after move.

Parameters

Name Key Required Type Description
Current Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Folder to Move
sourceFolderId True string

File Identifier

Destination Site Address
destinationDataset True string

Example: https://contoso.sharepoint.com/sites/sitename

Destination Folder
destinationFolderPath True string

Destination Folder

If another folder is already there
nameConflictBehavior True integer

Pick one of the options available

Returns

The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized

Resolve person

Returns a single matching user value so it can be assigned to a column of type person. If there are no matches, or multiple matches, this action will error out.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

List or Library
table True string

Pick the list or library that the column is in.

Column
entityId True string

Pick the column you want to assign the value to.

Email or name
searchValue True string

Use the email address, or the full name of the user.

Limit Columns by View
view string

Avoid column threshold issues by only using columns defined in a view.

Returns

SharePoint expanded user field

Send an HTTP request to SharePoint

Construct a SharePoint REST API to invoke. Note – This action may execute any SharePoint REST API you have access to. Please proceed with caution.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Method
method True string

Http Method

Uri
uri True string

Example: _api/web/lists/getbytitle('Documents')

Body
body string

Enter request content in JSON

Returns

Set content approval status

Sets the content approval status for an item in a list or library that has content approval turned on. You must provide an ETag for pages and files. You can get the ETag using the Get File Metadata action. This action is only available for SharePoint Online and SharePoint 2019.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Library Name
table True string

SharePoint library name.

Id
id True integer

Id of the item you are setting the status of.

Action
approvalAction True string

Pick the approval action.

Comments
comments string

Add the comments from the approver.

ETag
entityTag string

Add an ETag (required for files and pages).

Returns

SetApprovalStatus output

Set hub site join status to pending

Set the requested site's hub join request status to pending. The Approval Correlation Id is an optional parameter that helps SharePoint identify a particular hub join request. The requesting site can only have one pending request at a given time.

Parameters

Name Key Required Type Description
Requesting Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Approval Correlation Id
approvalCorrelationId string

Approval correlation identifier for this request.

Stop sharing an item or a folder

Delete all links giving access to an item or a folder and remove all people with direct access except for owners.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

List or Library Name
table True string

SharePoint list or library name.

Id
id True integer

Unique identifier of the item or folder you want to stop sharing.

Update file

Updates the contents of the file specified by the file identifier.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

File Identifier
id True string

Select a file.

File Content
body True binary

Content of the file.

Returns

Represents blob datasets metadata response

Update file properties

Updates the properties stored in columns in a library for the item specified by the item id. Use "Update file" action to update file contents.

        When using this with the On-Premises Data Gateway, the name of the library to connect to may need to be entered manually.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename

Library Name
table True string

SharePoint library name

Id
id True integer

Unique identifier of item to be updated

Item
item True dynamic

Item with changed properties

Limit Columns by View
view string

Avoid column threshold issues by only using columns defined in a view

Returns

The outputs of this operation are dynamic.

Update item

Updates an item in a SharePoint list.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename

List Name
table True string

SharePoint list name

Id
id True integer

Unique identifier of item to be updated

Item
item True dynamic

Item with changed properties

Limit Columns by View
view string

Avoid column threshold issues by only using columns defined in a view

Returns

The outputs of this operation are dynamic.

Triggers

When a file is created (properties only)

Triggers when an item is created in a library. Returns only the properties stored in the library columns.

        You can add a "Get file content" step and use the "File identifier" property returned by this action to get to the contents of the file.

        When using this with the On-Premises Data Gateway, the name of the library to connect to may need to be entered manually.
When a file is created in a folder

Triggers when a file is created in a SharePoint folder.

When a file is created or modified (properties only)

Triggers when an item is created, or modified in a library. Returns only the properties stored in the library columns.

        You can add a "Get file content" step and use the "File identifier" property returned by this action to get to the contents of the file.

        When using this with the On-Premises Data Gateway, the name of the library to connect to may need to be entered manually.
When a file is created or modified in a folder

Triggers when a file is created, and also each time it is modified in a SharePoint folder.

When a file is deleted

Triggers when a file is deleted in a library. You can optionally specify a folder to watch as well. When a folder is deleted, the trigger will fire only once for the deleted folder

When an item is created

Triggers when an item is created.

When an item is created or modified

Triggers when an item is created, and also each time it is modified.

When an item is deleted

Triggers when an item is deleted in a list

When a file is created (properties only)

Triggers when an item is created in a library. Returns only the properties stored in the library columns.

        You can add a "Get file content" step and use the "File identifier" property returned by this action to get to the contents of the file.

        When using this with the On-Premises Data Gateway, the name of the library to connect to may need to be entered manually.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename

Library Name
table True string

SharePoint library name

Folder
folderPath string

Select a folder, or leave blank for the whole library

Limit Columns by View
view string

Avoid column threshold issues by only using columns defined in a view

Returns

The outputs of this operation are dynamic.

When a file is created in a folder

Triggers when a file is created in a SharePoint folder.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Folder Id
folderId True string

Select a folder.

Infer Content Type
inferContentType boolean

Infer content-type based on extension.

Returns

The content of the file.

File Content
binary

When a file is created or modified (properties only)

Triggers when an item is created, or modified in a library. Returns only the properties stored in the library columns.

        You can add a "Get file content" step and use the "File identifier" property returned by this action to get to the contents of the file.

        When using this with the On-Premises Data Gateway, the name of the library to connect to may need to be entered manually.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename

Library Name
table True string

SharePoint library name

Folder
folderPath string

Select a folder, or leave blank for the whole library

Limit Columns by View
view string

Avoid column threshold issues by only using columns defined in a view

Returns

The outputs of this operation are dynamic.

When a file is created or modified in a folder

Triggers when a file is created, and also each time it is modified in a SharePoint folder.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename.

Folder Id
folderId True string

Select a folder.

Infer Content Type
inferContentType boolean

Infer content-type based on extension.

Returns

The content of the file.

File Content
binary

When a file is deleted

Triggers when a file is deleted in a library. You can optionally specify a folder to watch as well. When a folder is deleted, the trigger will fire only once for the deleted folder

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename

Library Name
table True string

SharePoint library name

Folder
folderPath string

Select a folder, or leave blank for the whole library

Returns

List of Deleted items

When an item is created

Triggers when an item is created.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename

List Name
table True string

SharePoint list name

Limit Columns by View
view string

Avoid column threshold issues by only using columns defined in a view

Returns

The outputs of this operation are dynamic.

When an item is created or modified

Triggers when an item is created, and also each time it is modified.

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename

List Name
table True string

SharePoint list name

Limit Columns by View
view string

Avoid column threshold issues by only using columns defined in a view

Returns

The outputs of this operation are dynamic.

When an item is deleted

Triggers when an item is deleted in a list

Parameters

Name Key Required Type Description
Site Address
dataset True string

Example: https://contoso.sharepoint.com/sites/sitename

List Name
table True string

SharePoint list name

Returns

List of Deleted items

Definitions

Internal structure for sharing links

Name Path Type Description
Sharing Link
webUrl string

A link to the item

SharingLinkPermission

Internal structure for sharing links

Name Path Type Description
link
link SharingLink

Internal structure for sharing links

Table

Represents a table.

Name Path Type Description
Name
Name string

The name of the table. The name is used at runtime.

DisplayName
DisplayName string

The display name of the table.

DynamicProperties
DynamicProperties object

Additional table properties provided by the connector to the clients.

SPBlobMetadataResponse

The SharePoint version of the BlobMetadataResponse extends the object by adding some additional fields that we want serialized

Name Path Type Description
ItemId
ItemId integer

The value that can be used to Get or Update file properties in libraries.

Id
Id string

The unique id of the file or folder.

Name
Name string

The name of the file or folder.

DisplayName
DisplayName string

The display name of the file or folder.

Path
Path string

The path of the file or folder.

LastModified
LastModified date-time

The date and time the file or folder was last modified.

Size
Size integer

The size of the file or folder.

MediaType
MediaType string

The media type of the file or folder.

IsFolder
IsFolder boolean

A boolean value (true, false) to indicate whether or not the blob is a folder.

ETag
ETag string

The etag of the file or folder.

FileLocator
FileLocator string

The filelocator of the file or folder.

TablesList

Represents a list of tables.

Name Path Type Description
value
value array of Table

List of Tables

BlobMetadataResponse

Represents blob datasets metadata response

Name Path Type Description
Id
Id string

The unique id of the file or folder.

Name
Name string

The name of the file or folder.

DisplayName
DisplayName string

The display name of the file or folder.

Path
Path string

The path of the file or folder.

LastModified
LastModified date-time

The date and time the file or folder was last modified.

Size
Size integer

The size of the file or folder.

MediaType
MediaType string

The media type of the file or folder.

IsFolder
IsFolder boolean

A boolean value (true, false) to indicate whether or not the blob is a folder.

ETag
ETag string

The etag of the file or folder.

FileLocator
FileLocator string

The filelocator of the file or folder.

BlobMetadata

Blob metadata

Name Path Type Description
Id
Id string

The unique id of the file or folder.

Name
Name string

The name of the file or folder.

DisplayName
DisplayName string

The display name of the file or folder.

Path
Path string

The path of the file or folder.

LastModified
LastModified date-time

The date and time the file or folder was last modified.

Size
Size integer

The size of the file or folder.

MediaType
MediaType string

The media type of the file or folder.

IsFolder
IsFolder boolean

A boolean value (true, false) to indicate whether or not the blob is a folder.

ETag
ETag string

The etag of the file or folder.

FileLocator
FileLocator string

The filelocator of the file or folder.

SPListExpandedUser

SharePoint expanded user field

Name Path Type Description
Claims
Claims string

user claims

DisplayName
DisplayName string

user title

Email
Email string

user email

Picture
Picture string

user picture

Department
Department string

user department

JobTitle
JobTitle string

user job title

@odata.type
@odata.type string

SetApprovalStatusOutput

SetApprovalStatus output

Name Path Type Description
ETag
ETag string

ETag of the item after the approval status was set

ApprovalLink
ApprovalLink string

A link to the item that needs approval

SPListItemAttachment

SharePoint list item attachment

Name Path Type Description
Id
Id string

File identifier

AbsoluteUri
AbsoluteUri string

Link to attachment

DisplayName
DisplayName string

Name

ApproveHubSiteJoinResponse

Result object of ApproveHubSiteJoin action

Name Path Type Description
ApprovalToken
ApprovalToken string

Approval Token

DeletedItemList

List of Deleted items

Name Path Type Description
value
value array of DeletedItem

List of Deleted Items

DeletedItem

An item deleted from a SharePoint list or library

Name Path Type Description
ID
ID integer

List item id

Name
Name string

File name of the item in document libraries, display name of the item in lists

Filename with extension
FileNameWithExtension string

File name with extension of the item in document libraries, same as Name of the item in lists

Deleted by
DeletedByUserName string

The name of the user who deleted this item

Time deleted
TimeDeleted date-time

When this item was deleted

Is folder
IsFolder boolean

A true/false value to indicate if the item is a folder