SharePoint.BuildingBlocks.Lists

Building blocks to manage list and libaries.

Delete List

Deletes a list on the specified site. Multiple lists can be deleted by giving multiple titles in the 'List' field separated by a semicolon.

Input Fields

Name	Required?	Description
Action When Not Empty	optional	Action to do when the list is not empty. Default the deletion will be skipped when not empty.
List	required	The title or GUID of the list.
Skip Recycle	optional	If enabled the list will skip the recycle bin and will be permanently removed. Be aware that skipping the recycle bin makes it unrecoverable!
Url	optional	The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'.

Delete Remote Event Receiver

Deletes a remote event receiver if it exists on the given list with the given parameters.

Input Fields

Name	Required?	Description
List	required	The title or GUID of the list.
Name	required	The name of the remove event receiver to remove.
Url	optional	The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'.

Ensure ContentType Field Settings

Ensures the settings of an existing field within an existing content type.

Input Fields

Name	Required?	Description
Field	required	The name of the field within the specified content type.
List	required	The title or GUID of the list.
Name	required	The name of the existing content type.
Required	optional	Specifies whether the field specified is required or not.
Url	optional	The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'.

Ensure ContentType To List

Adds an existing content type to an existing list. Multiple content types can be ensured by giving multiple names separated by a semicolon.

Input Fields

Name	Required?	Description
List	required	The title or GUID of the list.
Name	required	The name(s) of the existing content type(s). Multiple content types can be ensured by giving multiple names separated by a semicolon.
Read Only	optional	Specifies whether the content type will be attached to the list as read only.
Synchronise From Content Type Hub	optional	Synchronise the content type(s) from the content type hub to the current SharePoint site. The url in the profile is used as the content type hub url, this can be the admin tenant url. If you are working with a lot of libraries with content types on the site, consider using the building block 'Synchronise ContentType From Hub' to synchronise all content types at once. Synchronising the content types for each library will have a severe performance impact!
Url	optional	The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'.

Ensure List

Ensures a list on the specified site based on the given parameters. Multiple lists can be ensured by giving multiple titles in the 'List' field separated by a semicolon.

Input Fields

Name	Required?	Description
Allow Deletion	optional	Allow deletion of the list via the SharePoint list settings of the administrator role. Only supported in SharePoint Online and SharePoint 2019.
Allow Item Downloads	optional	Specify whether items can be downloaded to offline clients. Only supported in SharePoint Online and SharePoint 2019.
Allow Quick Editing	optional	Specify whether Quick Edit and Details Pane can be used on this list to bulk edit data. Only supported in SharePoint Online.
Crawl Non Default Views	optional	Specify whether non-default views of this list should be indexed. Only supported in SharePoint Online, SharePoint 2019 and SharePoint 2016.
Description	optional	Description of the list.
Draft Version Visibility	optional	Specifies the minimum permission required to view minor versions and drafts within the list. In order to set "Only users who can approve items(and the author of the item)" "Enable Content Approval" must be set to true. In order to set "Any user who can read items" or "Only users who can edit items" "Enable Versioning" and "Enable Minor Versions" must be set to true or "Enable Content Approval".
Enable Assign To Email	optional	Send e-mail when ownership on a task is assigned or when an item has been changed. Property is ignored if type isn't a task list. Only supported in SharePoint Online and SharePoint 2019.
Enable Attachments	optional	Specify whether users can attach files to items in this list. Property is ignored if type is a document library.
Enable Content Approval	optional	Specifies whether content approval is enabled for the list.
Enable Content Types	optional	Specifies whether content types are enabled on the list.
Enable Folder Creation	optional	Specifies whether new list folders can be added to the list.
Enable Minor Versions	optional	Specifies whether minor versions are enabled for the list.
Enable Versioning	optional	Specifies whether historical versions of list items and documents will be created in the list.
Force Checkout	optional	Specifies whether documents need to be checked out before they can be edited.
Hidden	optional	Whether the list is shown in the site contents of the site.
Internal Name	optional	The internal name of the list. When working with multiple titles the internal names can also be split using a semicolon. If left empty the title will be converted to an internal name: 'Work Documents' -> 'Work_x0020_Documents'. https://learn.microsoft.com/en-us/microsoft-365/community/sharepoint-naming-guidelines#internal-names
List	required	The title or GUID of the list.
List Template Type	required	The template of the list.
Major Version Limit	optional	Specifies the maximum amount of major versions that can be created. If left 0 the default will be used (500).
Major Versions With Drafts Limit	optional	Specifies the maximum number of major versions for which drafts will be kept. This property is ignored when minor versions are disabled. If left 0 no limit is set on the drafts to keep.
No Crawl	optional	Specifies whether the crawler must crawl the list. If set to true the list won't be crawled and the list won't appear in the search results of the site.
On Quick Launch	optional	Specifies whether the list appears on the quick launch of the site.
Url	optional	The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'.
Validation Formula	optional	Specifies the data validation criteria for a list item.
Validation Message	optional	Specifies the error message returned when data validation fails for a list item.

Ensure Navigation List

Ensures a navigation list which only works with the Ometa Quick Links Web Part from the Ometa Framework. At the moment only supported for SharePoint Online.

Input Fields

Name	Required?	Description
Navigation Items	required	A JSON structure of the items to display. [{ "Title":"The title to display", "Url":"Best practice to use relative URLs e.g.: /sites/home.aspx", "ImageUrl":"Image URL of Fabrics UI Icon Friendly Name e.g.: Globe", "LaunchBehaviour":"New Tab / Same Tab", "TileOrder":1 }]
Navigation List	required	The name of the navigation list.
Recreate Navigation Items	optional	Recreate the navigation items by removing all the items and recreate with the specified navigation items.
Url	optional	The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'.

Ensure Page Library

Ensures a library specific for storing Web Part & Wiki Pages.

Input Fields

Name	Required?	Description
Description	optional	Description of the list.
List	required	The title or GUID of the list.
On Quick Launch	optional	Specifies whether the list appears on the quick launch of the site.
Url	optional	The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'.

Ensure Remote Event Receiver

Ensures that a remote event receiver on the given list with the given parameters. If the event reciever already exists it will be updated.

Input Fields

Name	Required?	Description
Event Synchronisation	required	Indicates to run the event receiver in the specified state (default, synchronous or asynchronous).
Event Type	required	Specifies the type of event that is handled by the Microsoft SharePoint Foundation event receiver. E.g. 'ItemAdding' or 'ItemDeleted'. Accepted values: https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.client.eventreceivertype.aspx.
List	required	The title or GUID of the list.
Name	required	The name of the remote event receiver to add.
REST Url	optional	Specifies the URL of a web service that is used for receiving events.
Url	optional	The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'.

Get All Lists

Retrieves all lists from the given SharePoint site.

Input Fields

Name	Required?	Description
Include From Subsites	optional	Include the lists from the subsites.
List Template Type	required	The template of the list.
SPWeb.Url	optional	Current Site Url
Url	optional	The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'.

Output Fields

Name	Description
Description	optional
Parent Site Title	Parent Site Title
Parent Site Url	Parent Site Url
Server Relative Url	Server Relative Url
Title	Title

Remove ContentType From List

Removes a content type from an existing list. Only content types which are configured as 'not read only' can be removed from a list. Multiple content types can be removed by giving multiple names separated by a semicolon.

Input Fields

Name	Required?	Description
List	required	The title or GUID of the list.
Name	required	The name of an existing content type. Multiple content types can be removed by giving multiple names separated by a semicolon.
Url	optional	The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'.