CData Cloud offers access to Microsoft SharePoint across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a SQL Server database can connect to Microsoft SharePoint through CData Cloud.
CData Cloud allows you to standardize and configure connections to Microsoft SharePoint as though it were any other OData endpoint or standard SQL Server.
This page provides a guide to Establishing a Connection to Microsoft SharePoint in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to Microsoft SharePoint and configure any necessary connection properties to create a database in CData Cloud
Accessing data from Microsoft SharePoint through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to Microsoft SharePoint by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
Setting URL:
Microsoft SharePoint works with all Lists and Documents in the global Microsoft SharePoint site, or all Lists and Documents at individual sites.
To work with all Lists and Documents in the global Microsoft SharePoint site, set the URL connection property to your Site Collection URL. For example:
https://teams.contoso.com
To work with all Lists and Documents at an individual site, set the URL connection property to your individual site URL. For example:
https://teams.contoso.com/TeamA
The following sections describe how to set the appropriate authentication properties for your working environment. For information about how to create a custom OAuth application (required for use with AzureAD in a Web application; optional for AzureAD access via a Desktop application or a Headless Server), see Creating a Custom Entra ID (Azure AD) Application.
Set SharePointEdition to "SharePoint Online" and set the User and Password to the credentials you use to log onto SharePoint, for example, the credentials to your Microsoft Online Services account.
Microsoft SharePoint online supports a number of cloud-based architectures, each of which supports a different set of authentication schemes:
If the user account domain is different from the domain configured with the identity provider, set SSODomain to the latter. This property may be required for any SSO.
Note: Microsoft has rebranded Azure AD as Entra ID. In topics that require the user to interact with the Entra ID Admin site, we use the same names Microsoft does. However, there are still CData connection properties whose names or values reference "Azure AD".
Microsoft Entra ID (Azure AD) is a connection type that leverages OAuth to authenticate. OAuth requires the authenticating user to interact with Microsoft SharePoint using an internet browser. The driver facilitates this in several ways as described below.
Your organization may require Admin Consent when authorizing a new AzureAD application for your Azure Tenant. In all AzureAD flows, any initial installation and use of an AzureAD application requires that an administrator approve the application for their Azure Tenant. For details, see Creating a Custom Entra ID (Azure AD) Application.
Set the AuthScheme to ADFS. You must set the following connection properties:
AuthScheme=ADFS;User=ADFSUserName;Password=ADFSPassword;URL='http://sharepointserver/mysite';
Set the AuthScheme to Okta. The following connection properties are used to connect to Okta:
Example connection string:
AuthScheme=Okta;User=oktaUserName;Password=oktaPassword;URL='http://sharepointserver/mysite';
Set the AuthScheme to OneLogin. The following connection properties are used to connect to OneLogin:
Example connection string:
AuthScheme=OneLogin;User=OneLoginUserName;Password=OneLoginPassword;URL='http://sharepointserver/mysite';
Set the AuthScheme to PingFederate. The following connection properties are used to connect to PingFederate:
Example connection string:
AuthScheme=PingFederate;User=PingFederateUserName;Password=PingFederatePassword;URL='http://sharepointserver/mysite';
If you are running Microsoft SharePoint on an Azure VM, you can leverage Azure Managed Service Identity (MSI) credentials to connect:
The MSI credentials are automatically obtained for authentication.
Set the AuthScheme to OAUTHJWT. The following connection properties are used to connect to Microsoft SharePoint:
Set the AuthScheme to SharePointOAuth. The following connection properties are used to connect to SharePointOAuth:
Example connection string:
SharePointEdition='SharePointOnline';URL=https://contoso.sharepoint.com;Schema=REST;AuthScheme=SharePointOAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=11111111-1111-1111-1111-111111111111;OAuthClientSecret=1111111111111/11111111111111/11111111111111=;This AuthScheme works with the SharePoint app-only principal. Refer to Creating a Custom Entra ID (Azure AD) Application for instructions on how to set up and grant access to the app-only principal. The only section that applies to this AuthScheme is the SharePoint App section.
On April 2, 2026, Azure Access Control Services (ACS) will be retired for SharePoint in Microsoft 365. Existing users will no longer be able to create or use Azure ACS principals to access SharePoint. Additionally, as of November 1, 2024, Azure ACS was no longer available for new tenants. This change applied to all environments, including Government Clouds and the Department of Defense.
Microsoft recommends switching to a more secure authentication method, such as AzureAD or OAuthJWT.
To authenticate to Microsoft SharePoint with Kerberos, set AuthScheme to NEGOTIATE.
Authenticating to Microsoft SharePoint via Kerberos requires you to define authentication properties and to choose how Kerberos should retrieve authentication tickets.
The Cloud provides three ways to retrieve the required Kerberos ticket, depending on whether or not the KRB5CCNAME and/or KerberosKeytabFile variables exist in your environment.
MIT Kerberos Credential Cache File
This option enables you to use the MIT Kerberos Ticket Manager or kinit command to get tickets. With this option there is no need to set the User or Password connection properties.
This option requires that KRB5CCNAME has been created in your system.
To enable ticket retrieval via MIT Kerberos Credential Cache Files:
If the ticket is successfully obtained, the ticket information appears in Kerberos Ticket Manager and is stored in the credential cache file.
The Cloud uses the cache file to obtain the Kerberos ticket to connect to Microsoft SharePoint.
Note: If you would prefer not to edit KRB5CCNAME, you can use the KerberosTicketCache property to set the file path manually. After this is set, the Cloud uses the specified cache file to obtain the Kerberos ticket to connect to Microsoft SharePoint.
Keytab File
If your environment lacks the KRB5CCNAME environment variable, you can retrieve a Kerberos ticket using a Keytab File.
To use this method, set the User property to the desired username, and set the KerberosKeytabFile property to a file path pointing to the keytab file associated with the user.
User and Password
If your environment lacks the KRB5CCNAME environment variable and the KerberosKeytabFile property has not been set, you can retrieve a ticket using a user and password combination.
To use this method, set the User and Password properties to the user/password combination that you use to authenticate with Microsoft SharePoint.
To enable this kind of cross-realm authentication, set the KerberosRealm and KerberosKDC properties to the values required for user authentication. Also, set the KerberosServiceRealm and KerberosServiceKDC properties to the values required to obtain the service ticket.
To make it easier to access data in advanced integrations, use the following connection properties to control column name identifiers and other aspects of data access:
To enable TLS, set the following:
With this configuration, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
The Microsoft SharePoint Cloud also supports setting client certificates. Set the following to connect using a client certificate.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
The CData Cloud models Microsoft SharePoint data as an easy-to-use SQL database with tables, views, and stored procedures. Live connectivity to these objects means that any changes to your Microsoft SharePoint account are immediately reflected in the Cloud.
The Cloud can expose custom lists from Microsoft SharePoint that are not mentioned in the Tables. The data model illustrates a sample of what your SharePoint site might look like. The actual data model will be obtained dynamically based on your user credentials and SharePoint site.
Common tables include:
| Table | Description |
| Attachments | Manages attachments for SharePoint list items, allowing retrieval and deletion. Essential for users who frequently handle file attachments within SharePoint. |
| Groups | Allows the creation, modification, deletion, and retrieval of SharePoint security groups. Essential for managing user permissions and access control. |
| Roles | Allows the creation, modification, deletion, and retrieval of SharePoint roles and permission assignments. Useful for customizing access control. |
| Users | Manages SharePoint users, allowing updates, deletions, and retrieval of user details. Important for keeping SharePoint user management up-to-date. |
| Views | Lists all subsites within a SharePoint site, including hierarchy details. Helps with site navigation and organization. |
Typically, entities that cannot be modified are represented as Views, or read-only tables.
Common views include:
| Table | Description |
| FileVersions | Lists all available versions of a document stored in SharePoint, including version history details. Useful for tracking changes and restoring previous document versions. |
| GetValidTerms | Retrieves a list of valid managed metadata terms associated with a specific column in a SharePoint list. Helps enforce consistent categorization and tagging of SharePoint content. |
| Lists | Retrieves metadata about all SharePoint lists available on the site, including properties and settings. Useful for understanding the structure and usage of SharePoint lists. |
| Permissions | The permissions for a site or list. Note: If ItemId is empty, set the ObjectType to List or Web (an ObjectName must be specified when the ObjectType is List). If not, you must specify the ObjectName along with the ItemID. |
| Subsites | Allows the creation, modification, deletion, and retrieval of SharePoint roles and permission assignments. Useful for customizing access control. |
You can also access custom views of a list as relational views. To get data from a custom view of a list, you can set the ViewID pseudo column in the WHERE clause.
SELECT * FROM ListName WHERE ViewID='ID of the view'You can get the ID of the view from the Views list. You must specify the List pseudo column to get a list of views for that list. For instance:
SELECT * FROM Views WHERE List ='ListName'
Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including managing users, documents, and attachments.
The Cloud sets defaults to facilitate the maximum number of integrations; however, the following connection properties allow a greater granularity of customization, which is useful in advanced integrations:
The Cloud maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.
| Microsoft SharePoint | CData Schema |
| Choice (menu) | string |
| Currency | float |
| Date and Time | datetime |
| Hyperlink or Picture | string |
| Lookup | string |
| Multiple lines of text | string |
| Number | float |
| Person or Group | string |
| Single line of text | string |
| Task Outcome | string |
| Yes/No | bool |
The Cloud models the data in Microsoft SharePoint as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| Attachments | Manages attachments for SharePoint list items, allowing retrieval and deletion. Essential for users who frequently handle file attachments within SharePoint. |
| Groups | Allows the creation, deletion and retrieval of SharePoint security groups. Essential for managing user permissions and access control. |
| Roles | Allows the creation, deletion and retrieval of SharePoint roles. Useful for customizing access control. |
| Users | Manage SharePoint users, allowing updates, deletions, and retrieval of user details. Important for keeping SharePoint user management up-to-date. |
| Views | Retrieves, creates, updates, or deletes views in SharePoint lists, allowing customization of displayed data. Useful for tailoring list views to specific business needs. |
Manages attachments for SharePoint list items, allowing retrieval and deletion. Essential for users who frequently handle file attachments within SharePoint.
The List and ItemId columns are required to return Attachments.
The following query retrieves attachments from the list named MyAttachmentList for the item with ItemId = 4:
SELECT * FROM Attachments WHERE List = 'MyAttachmentList' AND ItemId = 4;
Call the AddAttachment stored procedure to add new attachments to a list item.
| Name | Type | ReadOnly | Description |
| Url [KEY] | String | True |
The URL path to the attachment file. Useful for accessing or downloading the attachment. |
| List | String | True |
The internal name of the SharePoint list containing the attachment. Helps identify the source list for the attachment. |
| ListDisplayName | String | True |
The display name of the SharePoint list containing the attachment. Useful for user-friendly identification of the list. |
| ItemID | String | True |
The unique identifier of the item in the list to which the attachment is linked. Helps track associated files. |
| Name | String | True |
The name of the attachment file. Useful for displaying file names and managing attachments. |
Allows the creation, deletion and retrieval of SharePoint security groups. Essential for managing user permissions and access control.
SELECT * FROM Groups
Retrieve all groups with the specified names in your SharePoint Account:
SELECT * FROM Groups WHERE [Name] = 'Group1'
SELECT * FROM Groups WHERE [Name] IN ('Group1', 'Group2')
Retrieve the groups in which a specific user belongs.
SELECT * FROM Groups WHERE [UserLoginName] = "LoginName"
Retrieve the groups which have a specific role assigned to them.
SELECT * FROM Groups WHERE [RoleName] = "RoleName"
INSERT INTO Groups(Name, Description, DefaultUserLoginName, OwnerName, OwnerType) VALUES('Testing Group 5', 'Testing Group 5.', 'RIDDLERSP2013\\administrator', 'Testing Group 4', 'group')
DELETE FROM Groups WHERE Name = 'Group1'
| Name | Type | ReadOnly | Description |
| Name [KEY] | String | False |
The name of the group. Helps identify the group within SharePoint. |
| Id | String | True |
The unique identifier of the group. |
| Description | String | False |
A brief description of the group. Useful for understanding its purpose and membership. |
| OwnerId | String | True |
The unique identifier of the group owner. |
| OwnerType | String | False |
Specifies whether the owner is a user or another group. Helps define group management hierarchy. The allowed values are user, group. |
| UserLoginName | String | True |
A filter for reading the groups in which a specific user belongs. If this column is not specified in the criteria, it will have null values. |
| RoleName | String | True |
A filter for reading the groups which have a specific role assigned to them. If this column is not specified in the criteria, it will have null values. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| OwnerName | String |
The name of the user or group who should be the owner of the group to create. This is a write-only column which should be used only in 'INSERT' statements. |
| DefaultUserLoginName | String |
The user name of the default user for the group. This value should be in the format DOMAIN\\username. This is a write-only column which should be used only in 'INSERT' statements. |
Allows the creation, deletion and retrieval of SharePoint roles. Useful for customizing access control.
SELECT * FROM Roles
Retrieve all roles with the specified names in your SharePoint Account:
SELECT * FROM Roles WHERE [Name] = 'Role1'
SELECT * FROM Roles WHERE [Name] IN ('Role1', 'Role2')
Retrieve the roles assigned to a specific group.
SELECT * FROM Roles WHERE [GroupName] = "GroupName"
Retrieve the roles assigned to a specific user.
SELECT * FROM Roles WHERE [UserLoginName] = "LoginName"
INSERT INTO Roles (Name, Description, Permissions) VALUES ('Testing Role 3', 'Role for testing.', '1073741826')
DELETE FROM Roles WHERE Name = 'ReadOnly'
| Name | Type | ReadOnly | Description |
| Name [KEY] | String | False |
The name of the role. Helps identify the permission level assigned to users or groups. |
| Id | String | True |
The unique identifier of the role. |
| Description | String | False |
A brief description of the role. Useful for understanding its purpose and the permissions it grants. |
| Permissions | String | False |
The mask of permissions granted to the role. Helps define access control levels. To learn more about permission masks, check out the 'Permission Masks' section in Permissions. |
| RoleType | String | True |
Specifies the type of role. Useful for differentiating between built-in roles and custom roles. |
| IsHidden | Boolean | True |
Indicates whether the role is hidden from the user interface. Helps manage roles that are system-defined or restricted. |
| UserLoginName | String | True |
A filter for reading the roles assigned to a specific user. If this column is not specified in the criteria, it will have null values. |
| GroupName | String | True |
A filter for reading the roles assigned to a specific group. If this column is not specified in the criteria, it will have null values. |
Manage SharePoint users, allowing updates, deletions, and retrieval of user details. Important for keeping SharePoint user management up-to-date.
SELECT * FROM Users
Retrieve all users with the specified login names in your SharePoint Account:
SELECT * FROM Users WHERE [LoginName] = 'DOMAIN\\User1'
SELECT * FROM Users WHERE [LoginName] IN ('DOMAIN\\User1', 'DOMAIN\\User2')
Retrieve users that belong to a specific group:
SELECT * FROM Users WHERE [GroupName] = "GroupName"
Retrieve users that have a specific role assigned to them:
SELECT * FROM Users WHERE [RoleName] = "RoleName"
UPDATE Users SET Notes = 'User 1 notes.' WHERE LoginName = 'DOMAIN\\User1'
DELETE FROM Users WHERE LoginName = 'DOMAIN\\User1'
| Name | Type | ReadOnly | Description |
| LoginName [KEY] | String | True |
The login name of the user, typically in DOMAIN\\username format. Helps authenticate and identify users within SharePoint. |
| Id | String | True |
A unique identifier assigned to the user. Useful for referencing users in queries and permission management. |
| Name | String | False |
The display name of the user. Useful for showing user-friendly names in SharePoint interfaces. |
| String | False |
The primary email address associated with the user. Used for communication and notifications. | |
| IsInDomainGroup | Boolean | True |
Indicates whether the user is a member of a domain group. Helps manage group-based access control. |
| IsSiteAdmin | Boolean | True |
Indicates whether the user has administrative privileges for the SharePoint site. Helps identify high-level access users. |
| Notes | String | False |
Optional notes or additional information related to the user. Useful for internal documentation and tracking. |
| SecurityId | String | True |
The security identifier (SID) assigned to the user. Helps in managing and tracking user permissions. |
| GroupName | String | False |
A filter for reading the users in a specific group. If this column is not specified in the criteria, it will have null values. |
| RoleName | String | False |
A filter for reading the users which are assigned a specific role. If this column is not specified in the criteria, it will have null values. |
Retrieves, creates, updates, or deletes views in SharePoint lists, allowing customization of displayed data. Useful for tailoring list views to specific business needs.
Views is a special table. It may be used to get, update, insert, and delete views from a specified List.
Using the List column:
SELECT * FROM Views WHERE List = 'MyListName';
Using the ID column:
SELECT * FROM Views WHERE ID = 'list1|{24676099-47E8-4C07-BABE-47EB9BEBA2F9}';
The List, Name, and Fields columns are required to insert to this table.
| Name | Type | ReadOnly | Description |
| ID [KEY] | String | True |
A unique identifier for the view. Used to reference and manage specific views in SharePoint. |
| List | String | True |
The name of the list associated with the view. A list must be specified in SELECT statements if the view ID is not provided. |
| ViewID | String | True |
The unique identifier of the view within a specific list. Useful for managing multiple views within a list. |
| Name | String | False |
The display name of the view. Helps users easily identify and select views. |
| Type | String | False |
The type of view, such as Standard, Calendar, or Datasheet. This value is required for inserts and updates. The allowed values are CALENDAR, GRID, HTML. The default value is HTML. |
| Fields | String | False |
A comma-separated list of fields included in the view. Space-sensitive; ensure proper formatting for queries. |
| IsDefault | Boolean | False |
Indicates whether the view is the default view for the list. Helps determine the primary view for users. |
| Query | String | False |
The query used to filter or sort data in the view. Helps customize list display based on specific conditions. |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| FileVersions | Lists all available versions of a document stored in SharePoint, including version history details. Useful for tracking changes and restoring previous document versions. |
| GetValidTerms | Retrieves a list of valid managed metadata terms associated with a specific column in a SharePoint list. Helps enforce consistent categorization and tagging of SharePoint content. |
| Lists | Retrieves metadata about all SharePoint lists available on the site, including properties and settings. Useful for understanding the structure and usage of SharePoint lists. |
| Permissions | Retrieves permission information for a SharePoint site, list, or item. |
| Subsites | Lists all subsites within a SharePoint site, including hierarchy details. Helps with site navigation and organization. |
Lists all available versions of a document stored in SharePoint, including version history details. Useful for tracking changes and restoring previous document versions.
To return results from this view, you must specify both the Library and File columns.
The following query retrieves all versions of the file MyExcelFile.xlsx located in the Documents/testd library:
SELECT * FROM FileVersions WHERE Library = 'Documents/testd' AND File = 'MyExcelFile.xlsx';
| Name | Type | Description |
| ID [KEY] | String | A unique identifier for the file version. Useful for tracking and managing version history. |
| Comments | String | User-provided comments about the particular file version. Helps document changes or provide context for modifications. |
| CreateBy | String | The username of the SharePoint user who modified this version of the file. Useful for tracking authorship and accountability. |
| Date | Datetime | The date and time when this version of the file was created. Helps monitor file updates and changes over time. |
| Size | String | The size of this specific version of the file. Useful for storage management and version comparison. |
| Url | String | The URL path to access this specific version of the file. Helps users retrieve or download older versions. |
| Library | String | The name of the SharePoint document library where the file is stored. A library must be specified to retrieve file versions.
The default value is Shared Documents. |
| File | String | The name of the file for which versions are being listed. A file must be specified to retrieve its version history. |
Retrieves a list of valid managed metadata terms associated with a specific column in a SharePoint list. Helps enforce consistent categorization and tagging of SharePoint content.
GetValidTerms is a special view used to retrieve valid terms for a taxonomy or managed metadata column in a given Microsoft SharePoint list. To query this view, you must provide both the List and ColumnName columns.
The following query retrieves valid terms for the TermsC column in the list1 list:
SELECT * FROM GetValidTerms WHERE List = 'list1' AND ColumnName = 'TermsC';
| Name | Type | Description |
| ID [KEY] | String | A unique identifier for the term. Useful for referencing and managing taxonomy terms in SharePoint. |
| TermLabelValue | String | The label assigned to the term. Helps users identify and apply terms to content. |
| Description | String | A brief description of the term set. Useful for understanding the purpose and usage of the term set. |
| NameInRequestedLang | String | The name of the term set in the language requested by the client. Helps with multilingual support. |
| IsOpen | Boolean | Indicates whether the term set is open for adding new terms. Useful for managing controlled vocabularies. |
| Deprecated | Boolean | Indicates whether the term is deprecated. Helps prevent usage of outdated or obsolete terms. |
| InternalId | String | An internal identifier for the term. Useful for system-level term management. |
| TermSetContact | String | The contact person or group responsible for managing the term set. Useful for governance and support. |
| ContainerDesc | String | A container node that holds metadata descriptions. Helps structure taxonomy information. |
| SingleTermLabelDesc | String | A detailed description of a single term label. Useful for providing additional context. |
| IsDefaultLabel | Boolean | Indicates whether the term label is the default for the term. Helps standardize term usage. |
| BelongsTo | String | The term set to which this term belongs. Useful for managing hierarchical taxonomies. |
| IsTaggingAvailable | Boolean | Indicates whether the term set is available for tagging. Helps control content classification. |
| TermPath | String | The hierarchical path of the term with term labels. Useful for navigating term relationships. |
| TermpathoftermwithIds | String | The hierarchical path of the term with its unique identifiers. Helps track term lineage. |
| ChildTerms | String | A custom sort order for child terms within the term hierarchy. Useful for organizing terms. |
| HasChildTerms | Boolean | Indicates whether the term has child terms. Helps manage nested taxonomy structures. |
| PertainingToTerm | String | The identifier of the term that this term set information pertains to. Useful for hierarchical organization. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| List | String | The name of the SharePoint list for which valid terms are being retrieved. Helps with taxonomy integration. |
| ColumnName | String | The column in the list for which valid terms are being retrieved. Useful for metadata enforcement. |
| LocaleId | String | The locale ID for the term. Defaults to 1033 (English). Helps support multilingual taxonomy. |
Retrieves metadata about all SharePoint lists available on the site, including properties and settings. Useful for understanding the structure and usage of SharePoint lists.
Lists can be used to list the tables in SharePoint. This will only return actual lists in SharePoint and not any special tables associated with the Cloud.
The following columns can be used in the WHERE clause: Title and BaseTemplate.
| Name | Type | Description |
| ID [KEY] | String | A unique identifier for the SharePoint list. Useful for referencing lists in queries and workflows. |
| Title | String | The display name of the list. Can be used in the WHERE clause with wildcard (*) for filtering. |
| Description | String | A brief summary of the list’s purpose and contents. Helps users understand the list's function. |
| BaseTemplate | String | Indicates the template type used to create the list. Can be used in WHERE clause for filtering list types. |
| Version | Double | The current version number of the list. Useful for tracking updates and changes. |
| Url | String | The default URL of the list. Helps users navigate to the list directly. |
| EmailAlias | String | The email alias assigned to the list. Useful for enabling email-based list interactions. |
| ImageUrl | String | The URL of the image associated with the list. Helps visually identify lists. |
| ItemCount | Integer | The total number of items currently stored in the list. Useful for reporting and analytics. |
| Item_Deleted | Datetime | The date and time when the last item was deleted from the list. Helps track data modifications. |
| Item_Modified | Datetime | The date and time when the last item was modified in the list. Useful for monitoring recent activity. |
| SendToUrl | String | The URL where list items are sent when using Send To functionality. Useful for document routing. |
| Created | Datetime | The date and time when the list was originally created. Useful for tracking list history. |
| AllowDeletion | String | Indicates whether items in the list can be deleted. Helps manage data retention policies. |
| AllowMultiResponses | Boolean | Indicates whether multiple responses are allowed for surveys. Useful for feedback collection. |
| Direction | String | Specifies text reading order: 'LTR' for left-to-right, 'RTL' for right-to-left, or 'None' for no directionality. |
| EnableAssignedToEmail | Boolean | Indicates whether automatic email notifications are sent to assigned users. Applicable to issue tracking lists. |
| EnableAttachments | Boolean | Indicates whether attachments are allowed on list items. Not applicable to document libraries. |
| EnableModeration | Boolean | Indicates whether content approval is enabled for the list. Helps enforce content review policies. |
| EnableVersioning | Boolean | Indicates whether versioning is enabled for the list. Useful for tracking changes to list items. |
| Hidden | Boolean | Indicates whether the list is hidden from the Documents and Lists page, Quick Launch bar, and other navigation menus. |
| MultipleDataList | Boolean | Indicates whether a meeting workspace site contains data for multiple meeting instances within the site. |
| Ordered | Boolean | Indicates whether list items can be manually ordered on the Edit View page. Useful for prioritized lists. |
| Showuser | Boolean | Indicates whether user names are displayed in survey results. Helps identify respondents. |
Retrieves permission information for a SharePoint site, list, or item.
The Permissions view returns permission information for a Microsoft SharePoint site or list.
If ItemId is not specified, you must provide both ObjectType (either 'List' or 'Web') and ObjectName. If ItemId is specified, then ObjectName must also be provided.
Using ObjectType and ObjectName:
SELECT * FROM Permissions WHERE ObjectType = 'List' AND ObjectName = 'TestList' AND MemberID = '4';
Using ItemId and ObjectName:
SELECT * FROM Permissions WHERE ItemId = 1 AND ObjectName = 'list1';
To learn more about SharePoint permissions and permission masks, refer to the following SharePoint resources:
| Name | Type | Description |
| MemberID [KEY] | String | A unique identifier for the permission entry. Used to reference and manage specific user or group permissions. |
| Mask | Long | A 32-bit integer in 0x00000000 format representing Microsoft.SharePoint.SPRights values. Defines the permission level; multiple values can be combined using the pipe symbol ('|') in C# or 'Or' in Visual Basic. |
| MemberIsUser | Bool | Indicates whether the permission applies to an individual user. Helps differentiate between user and group permissions. |
| MemberGlobal | Bool | Indicates whether the permission applies to a group. Useful for managing role-based access control. |
| RoleName | String | The name of the site group, cross-site group, or individual user (formatted as DOMAIN\\User_Alias) to whom the permission applies. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| ObjectName | String | The name of the SharePoint list or site where the permission is applied. Helps identify the scope of the permission. |
| ObjectType | String | Specifies whether the permission applies to a 'List' or 'Web'. Useful for managing permissions at different levels. |
| ItemID | String | The unique identifier of the item associated with the permission. Helps track specific item-level permissions. |
Lists all subsites within a SharePoint site, including hierarchy details. Helps with site navigation and organization.
| Name | Type | Description |
| Title | String | The display name of the subsite. Helps users identify and navigate to the subsite within SharePoint. |
| Url | String | The full URL of the subsite. Useful for direct access and linking within the SharePoint environment. |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Microsoft SharePoint.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Microsoft SharePoint, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
| AddAttachment | Adds an attachment to a SharePoint list item. Useful for linking supplementary files to SharePoint records. |
| AddList | Creates a new SharePoint list with specified properties. Helps automate the setup of structured data storage. |
| AddListColumn | Adds a new column to a SharePoint list. Useful for dynamically modifying list structures. |
| AddUserToGroup | Adds a user to a specified SharePoint group. Helps in managing user access and permissions. |
| AddUserToRole | Assigns a user to a specified role in SharePoint. Useful for controlling access levels within the site. |
| CheckInDocument | Checks in a document, unlocking it for other users to modify. Ensures document updates are properly tracked. |
| CheckOutDocument | Checks out a document from a SharePoint library, locking it for editing. Prevents conflicts when multiple users need to work on the same file. |
| CopyDocument | Copies a document to a specified destination within SharePoint. Helps in content duplication and archiving. |
| CreateFolder | Creates a new folder within a SharePoint document library. Useful for keeping files organized in logical structures. |
| DeleteAttachment | Removes an attachment from a SharePoint list item. Helps manage file storage and remove outdated or unnecessary attachments. |
| DeleteDocument | Deletes a document from a SharePoint document library. Useful for content lifecycle management and ensuring obsolete documents are removed. |
| DeleteList | Permanently removes a SharePoint list from a site. Helps in decluttering SharePoint environments by removing deprecated lists. |
| DeleteListColumn | Removes a column from a SharePoint list. Useful for refining list structures and eliminating redundant fields. |
| DeleteUserFromGroup | Removes a user from a specified SharePoint group. Useful for revoking access when user roles change. |
| DeleteUserFromRole | Removes a user from a specified SharePoint role. Helps maintain security by adjusting permissions as needed. |
| DiscardCheckOutDocument | Reverts a checked-out document to its last saved state, canceling any unsaved changes. Useful for preventing unintended modifications. |
| MoveAttachmentOrDocument | Moves an attachment or document from one folder to another within SharePoint. Useful for reorganizing content and maintaining a structured document library. |
| RenameAttachmentOrDocument | Renames an attachment or document stored in a SharePoint list or document library. Useful for standardizing naming conventions without affecting file content. |
| UpdateGroup | Update a group in your SharePoint site collection. |
| UpdateList | Modifies properties or settings of a SharePoint list. Helps in dynamically adjusting list configurations. |
| UpdateListColumn | Updates the properties of an existing column in a SharePoint list. Useful for modifying column attributes without recreating the structure. |
| UpdateRole | Update a role in your SharePoint site collection. |
Adds an attachment to a SharePoint list item. Useful for linking supplementary files to SharePoint records.
| Name | Type | Required | Description |
| File | String | False | The full path of the local file to be uploaded as an attachment. |
| List | String | True | The name of the SharePoint list where the attachment will be added. |
| ItemID | String | True | The unique identifier of the list item to which the attachment will be added. |
| FileName | String | False | The name of the file to be uploaded as an attachment, including the file extension (such as 'document.pdf'). This is used if 'Content' is not null. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the attachment was successfully added. Returns 'true' for success and 'false' for failure. |
| URL | String | The URL of the newly created attachment in SharePoint. |
Creates a new SharePoint list with specified properties. Helps automate the setup of structured data storage.
| Name | Type | Required | Description |
| Name | String | True | The name of the new list to be created on the SharePoint server. |
| Template | String | True | The name or ID of the template to use when creating the list (such as 'Custom List' or 'Document Library').
The allowed values are GenericList, DocumentLibrary, Survey, Links, Announcements, Contacts, Events, Tasks, DiscussionBoard, PictureLibrary, DataSources, WebTemplateCatalog, UserInformation, WebPartCatalog, ListTemplateCatalog, XMLForm, MasterPageCatalog, NoCodeWorkflows, WorkflowProcess, WebPageLibrary, CustomGrid, DataConnectionLibrary, WorkflowHistory, GanttTasks, Meetings, Agenda, MeetingUser, Decision, MeetingObjective, TextBox, ThingsToBring, HomePageLibrary, Posts, Comments, Categories, IssueTracking, AdminTasks. The default value is GenericList. |
| Description | String | False | A brief description of the list to provide context about its purpose. |
| Columns | String | False | The definition of the columns to be added to the list. Accepts JSON, XML, or a temporary table format. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the list creation was successful. Returns 'true' for success and 'false' for failure. |
Adds a new column to a SharePoint list. Useful for dynamically modifying list structures.
| Name | Type | Required | Description |
| List | String | True | The name of the SharePoint list where the column will be added. |
| ColumnName | String | True | The internal name of the column to be created in the SharePoint list. |
| DisplayName | String | False | The display name of the column as it will appear in the SharePoint UI. |
| DefaultValue | String | False | The default value assigned to the column if no value is provided. |
| ColumnType | String | True | The data type of the column to be created. The valid options are defined by the SharePoint API FieldTypes. Allowed values include Integer, Text, Note, DateTime, Counter, Choice, Lookup, Boolean, Number, Currency, URL, Computed, Threading, Guid, MultiChoice, GridChoice, Calculated, File, Attachments, User, Recurrence, CrossProjectLink, ModStat, Error, ContentTypeId, PageSeparator, ThreadIndex, WorkflowStatus, AllDayEvent, WorkflowEventType, Geolocation, OutcomeChoice.
The default value is Text. |
| MaxLength | Integer | False | The maximum length allowed for the column value, applicable to text-based column types. |
| PrimaryKey | Boolean | False | A Boolean value indicating whether the column should be used as the primary key for the list. |
| ReadOnly | Boolean | False | A Boolean value indicating whether the column is read-only and cannot be modified by users. |
| Required | Boolean | False | A Boolean value indicating whether the column is mandatory for each list item. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the column creation operation was successful. Returns 'true' for success and 'false' for failure. |
Adds a user to a specified SharePoint group. Helps in managing user access and permissions.
| Name | Type | Required | Description |
| LoginName | String | True | The login name of the user to be added to the SharePoint group. This should be in the format 'DOMAIN\\username' for Active Directory users or an email address for Azure AD users. |
| Group | String | True | The name of the SharePoint group to which the user will be added. This must be specified when adding a user. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the operation to add the user to the group was successful. Returns 'true' for success and 'false' for failure. |
Assigns a user to a specified role in SharePoint. Useful for controlling access levels within the site.
| Name | Type | Required | Description |
| LoginName | String | True | A comma-separated list of login names of the users to be assigned a role. Use the format 'DOMAIN\\username' for Active Directory users or email addresses for Azure AD users. Example: 'Domain\\user1,Domain\\user2'. |
| Role | String | True | The name of the SharePoint role (permission level) to assign to the specified users. Examples include 'Full Control', 'Edit', 'Read'. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the operation to assign the role was successful. Returns 'true' for success and 'false' for failure. |
Checks in a document, unlocking it for other users to modify. Ensures document updates are properly tracked.
| Name | Type | Required | Description |
| File | String | False | The local path of the file that will overwrite the existing document in SharePoint upon check-in. Example: 'C:/myfolder/myfile.txt'. |
| Library | String | True | The name of the document library on the SharePoint site where the file resides. Example: 'Shared Documents'. |
| Comment | String | False | An optional comment describing the changes made before checking the document in. |
| RemoteFile | String | True | The relative or full URL of the file in the SharePoint document library. If only the file name is provided, the latest version will be checked in. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the document check-in operation was successful. Returns 'true' for success and 'false' for failure. |
Checks out a document from a SharePoint library, locking it for editing. Prevents conflicts when multiple users need to work on the same file.
| Name | Type | Required | Description |
| Library | String | True | The name of the document library on the SharePoint site where the file resides. Example: 'Shared Documents'. |
| RemoteFile | String | True | The relative or full URL of the file in the SharePoint document library that you want to check out. If only the file name is provided, it is checked out from the default location. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the document check-out operation was successful. Returns 'true' for success and 'false' for failure. |
Copies a document to a specified destination within SharePoint. Helps in content duplication and archiving.
If the NewDocumentName parameter is not specified, the value specified in DocumentName will be used as the destination path. If the NewDocumentLibrary parameter is not specified, the value specified in DocumentLibrary will be used as the new library. In any case, at least one of these two parameters must be specified (they can't both be unspecified at the same time). The DocumentLibrary and DocumentName parameters on the other hand are always required. Refer to the query examples below:
EXEC CopyDocument DocumentLibrary = 'Documents', DocumentName = 'Source Folder/Subfolder/Source Document.txt', NewDocumentName = 'Destination Document.txt'; EXEC CopyDocument DocumentLibrary = 'Documents', DocumentName = 'Source Document.txt', NewDocumentLibrary = 'Destination Library'; EXEC CopyDocument DocumentLibrary = 'Documents', DocumentName = 'Source Folder/Subfolder/Source Document.txt', NewDocumentLibrary = 'Destination Library', NewDocumentName = 'Destination Document.txt';If the NewDocumentName parameter is a folder (ends with a '/'), the document name from DocumentName will be used as the new file name instead. Refer to the query example below:
EXEC CopyDocument DocumentLibrary = 'Documents', DocumentName = 'Source Folder/Subfolder/Source Document.txt', NewDocumentLibrary = 'Destination Library', NewDocumentName = 'Destination Folder/Subfolder/';
Additionally, you can copy the document to a different site in your SharePoint instance by specifying its full URL. In this scenario, NewDocumentLibrary is required. Refer to the query example below:
EXEC CopyDocument DocumentLibrary = 'Documents', DocumentName = '/Source Folder/Subfolder/Source Document.txt', NewDocumentLibrary = 'Destination Library', NewDocumentName = 'https://mysite.sharepoint.com/sites/Destination%20Site/Destination%20Library/Destination%20Folder/Subfolder/Destination%20Document.txt';
| Name | Type | Required | Description |
| DocumentName | String | True | The relative path of the original document within its document library. Example: 'Folder1/OriginalFile.docx'. |
| DocumentLibrary | String | True | The display name of the SharePoint document library where the original document is stored. Example: 'Shared Documents'. |
| NewDocumentLibrary | String | False | The display name of the target document library where the copied document will be stored. If left blank, the document remains in the same library as the original. |
| NewDocumentName | String | False | The relative path and file name for the copied document in the new library. If left blank, the document retains the same name as the original. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the document copy operation was successful. Returns 'true' for success and 'false' for failure. |
| Id | String | The unique identifier assigned to the copied document after completion. |
| DocumentId | String | The document ID assigned to the copied file. |
| DocumentIdUrl | String | The URL where the copied document can be accessed via its document ID. |
| FileRef | String | The SharePoint file reference path of the copied document. |
Creates a new folder within a SharePoint document library. Useful for keeping files organized in logical structures.
| Name | Type | Required | Description |
| Library | String | True | The display name of the document library in which the new folder will be created. Example: 'Shared Documents'. |
| Name | String | True | The name of the folder to be created within the specified document library. Example: 'Project Files'. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the folder creation operation was successful. Returns 'true' for success and 'false' for failure. |
Removes an attachment from a SharePoint list item. Helps manage file storage and remove outdated or unnecessary attachments.
| Name | Type | Required | Description |
| URL | String | True | The full URL of the attachment to be deleted. Example: 'https://company.sharepoint.com/sites/documents/attachment1.jpg'. |
| List | String | False | The name of the SharePoint list where the attachment is stored. Example: 'ProjectFiles'. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the deletion operation was successful. Returns 'true' if the attachment was deleted successfully, otherwise 'false'. |
Deletes a document from a SharePoint document library. Useful for content lifecycle management and ensuring obsolete documents are removed.
| Name | Type | Required | Description |
| Library | String | True | The name of the document library on the SharePoint server where the file or folder is stored. Example: 'Shared Documents'. |
| Path | String | True | The relative path of the file or folder to be deleted within the specified document library. Example: 'ProjectFiles/Report.pdf' or 'ProjectFiles/OldFolder/'. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the deletion operation was successful. Returns 'true' if the document or folder was deleted successfully, otherwise 'false'. |
Permanently removes a SharePoint list from a site. Helps in decluttering SharePoint environments by removing deprecated lists.
| Name | Type | Required | Description |
| List | String | True | The name of the list to be deleted from the SharePoint server. Example: 'ProjectTasks' or 'EmployeeRecords'. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the deletion operation was successful. Returns 'true' if the list was deleted successfully, otherwise 'false'. |
Removes a column from a SharePoint list. Useful for refining list structures and eliminating redundant fields.
| Name | Type | Required | Description |
| List | String | True | The name of the SharePoint list from which the column should be deleted. Example: 'EmployeeRecords' or 'ProjectTasks'. |
| ColumnName | String | True | The name of the column to delete from the specified list. Example: 'StartDate' or 'ProjectStatus'. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the column deletion was successful. Returns 'true' if the column was deleted successfully, otherwise 'false'. |
Removes a user from a specified SharePoint group. Useful for revoking access when user roles change.
| Name | Type | Required | Description |
| LoginName | String | True | The login name of the user to be removed from the specified SharePoint group. Example: 'DOMAIN\\JohnDoe' or '[email protected]'. |
| Group | String | True | The name of the SharePoint group from which the user should be removed. Example: 'Project Managers' or 'Site Admins'. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the user was successfully removed from the group. Returns 'true' if the operation was successful, otherwise 'false'. |
Removes a user from a specified SharePoint role. Helps maintain security by adjusting permissions as needed.
| Name | Type | Required | Description |
| LoginName | String | True | A comma-separated list of login names for the users who should be removed from the specified role. Example: 'Domain\\user1,Domain\\user2'. |
| Role | String | True | The name of the SharePoint role to unassign from the specified users. Example: 'Contributors', 'Site Owners', or 'Read-Only'. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the operation was successful. Returns 'true' if the users were successfully removed from the role, otherwise 'false'. |
Reverts a checked-out document to its last saved state, canceling any unsaved changes. Useful for preventing unintended modifications.
| Name | Type | Required | Description |
| Library | String | True | The name of the SharePoint document library where the file is stored. Example: 'Shared Documents'. |
| RemoteFile | String | True | The path of the file to discard the checkout for. This can be the full URL (such as 'https://yoursharepointsite.com/Shared Documents/report.docx') or the relative file name within the library. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the checkout was successfully discarded. Returns 'true' if the operation succeeded, otherwise 'false'. |
Moves an attachment or document from one folder to another within SharePoint. Useful for reorganizing content and maintaining a structured document library.
| Name | Type | Required | Description |
| List | String | True | The name of the SharePoint list or document library from which the document or attachment will be moved. |
| SourceFileURL | String | True | The relative URL of the source file, based on the site URL in the connection properties. Example formats: Root Directory file:/Shared Documents/filename.txt Sub-directory file:/Shared Documents/MyFolder/filename.txt If the connection property points to a site collection, the relative URL corresponds to a path within the base site. If it points to a specific site, the relative URL is relative to that site. |
| DestinationFolderURL | String | True | The relative URL of the destination folder where the document or attachment should be moved. Example formats: Root Directory:/Shared Documents/ Sub-directory:/Shared Documents/MyFolder/ As with SourceFileURL, the relative URL depends on whether the connection property is set to a site collection or a specific site. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the operation was successful. Returns 'true' if the move was completed successfully, otherwise 'false'. |
Renames an attachment or document stored in a SharePoint list or document library. Useful for standardizing naming conventions without affecting file content.
| Name | Type | Required | Description |
| List | String | True | The name of the SharePoint list or document library containing the document or attachment to be renamed. |
| SourceFileURL | String | True | The relative URL of the file you want to rename, based on the site URL in the connection properties. Example formats: Root Directory file:/Shared Documents/filename.txt Sub-directory file:/Shared Documents/MyFolder/filename.txt If the connection property is set to a site collection, the relative URL corresponds to a path within the base site. If it points to a specific site, the relative URL is relative to that site. |
| NewFileName | String | True | The new name for the file, including the file extension (such as 'UpdatedFilename.docx'). |
| Name | Type | Description |
| Success | Boolean | Indicates whether the operation was successful. Returns 'true' if the file was renamed successfully, otherwise 'false'. |
Update a group in your SharePoint site collection.
| Name | Type | Required | Description |
| Name | String | True | The current name of the group. |
| NewName | String | False | The new name of the group. |
| Description | String | True | The description of the group. |
| OwnerName | String | True | The login name/name of the user or group who should be the owner of the group. |
| OwnerType | String | True | The type of the group's owner.
The allowed values are user, group. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the group was successfully updated. Returns 'true' for success and 'false' for failure. |
Modifies properties or settings of a SharePoint list. Helps in dynamically adjusting list configurations.
| Name | Type | Required | Description |
| List | String | True | The name or globally unique identifier (GUID) of the SharePoint list to be updated. |
| AllowMultiResponses | String | False | Set to 'true' to allow multiple responses to a survey list. |
| Description | String | False | A text description of the list, providing additional context or purpose. |
| Direction | String | False | Defines the text reading order for the list interface: 'LTR' for left-to-right, 'RTL' for right-to-left, or 'None' for no specific direction.
The allowed values are LTR, RTL, None. |
| EnableAssignedToEmail | String | False | Set to 'true' to enable assigned-to email notifications for issue tracking lists. |
| EnableAttachments | String | False | Set to 'true' to allow items in the list to have attachments. This setting does not apply to document libraries. |
| EnableModeration | String | False | Set to 'true' to enable content approval for items in the list, requiring administrator review before they become visible. |
| EnableVersioning | String | False | Set to 'true' to enable version tracking for list items, allowing for historical changes and rollbacks. |
| Hidden | String | False | Set to 'true' to hide the list from user interfaces such as the Documents and Lists page, Quick Launch, and site content settings. |
| MultipleDataList | String | False | Set to 'true' to indicate that the list in a Meeting Workspace site contains data for multiple meeting instances. |
| Ordered | String | False | Set to 'true' to allow users to manually reorder items within the list using the Edit View page. |
| ShowUser | String | False | Set to 'true' to display user names in survey responses instead of keeping them anonymous. |
| Title | String | False | The display name of the list, which appears in SharePoint user interfaces. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the operation was successful. Returns 'true' if the update was applied successfully, otherwise 'false'. |
Updates the properties of an existing column in a SharePoint list. Useful for modifying column attributes without recreating the structure.
| Name | Type | Required | Description |
| List | String | True | The name or globally unique identifier (GUID) of the SharePoint list that contains the column to be updated. |
| ColumnName | String | True | The internal name of the column that you want to update. |
| DisplayName | String | False | The new display name for the column, which appears in SharePoint interfaces. |
| DefaultValue | String | False | The new default value assigned to the column if no other value is specified. |
| ColumnType | String | False | The new data type of the column. The valid options are defined by the FieldTypes available in the SharePoint API: https://learn.microsoft.com/en-us/previous-versions/office/sharepoint-csom/ee540543(v=office.15). Allowed values include Integer, Text, Note, DateTime, Counter, Choice, Lookup, Boolean, Number, Currency, URL, Computed, Threading, Guid, MultiChoice, GridChoice, Calculated, File, Attachments, User, Recurrence, CrossProjectLink, ModStat, Error, ContentTypeId, PageSeparator, ThreadIndex, WorkflowStatus, AllDayEvent, WorkflowEventType, Geolocation, and OutcomeChoice. |
| MaxLength | Integer | False | The new maximum number of characters allowed for the column (applies to text-based fields). |
| PrimaryKey | Boolean | False | Set to 'true' if the column should be designated as the primary key for the list. |
| ReadOnly | Boolean | False | Set to 'true' if the column should be marked as read-only, preventing users from editing its value in New or Edit forms. |
| Required | Boolean | False | Set to 'true' if the column must have a value before an item can be saved. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the column update was successful. Returns 'true' if the operation was successful, otherwise 'false'. |
Update a role in your SharePoint site collection.
| Name | Type | Required | Description |
| Name | String | True | The current name of the role. |
| NewName | String | False | The new name of the role. |
| Description | String | False | The description of the role. |
| Permissions | String | False | The mask of permissions to grant to the role. To learn more about permission masks, check out the 'Permission Masks' section in Permissions. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the role was successfully updated. Returns 'true' for success and 'false' for failure. |
The CData Cloud models Microsoft SharePoint data as an easy-to-use SQL database with tables, views, and stored procedures. Live connectivity to these objects means that any changes to your Microsoft SharePoint account are immediately reflected in the Cloud.
Because tables are dynamically generated, documentation on specific tables is not available.
Typically, entities that cannot be modified are represented as Views, or read-only tables.
Common views include:
| Table | Description |
| AllFiles | Retrieves all files and folders across all document libraries on a SharePoint site, including metadata details. Useful for auditing, bulk processing, and data migration. |
| AllLists | Lists all available SharePoint lists within the domain, including system fields and metadata. Essential for identifying and managing lists across the SharePoint environment. |
| Attachments | Retrieves attachments associated with a specific list item in a SharePoint list. Helps manage and track attached files related to SharePoint items. |
| Comments | Contains details about comments made on SharePoint items, including authorship, content, replies, and metadata. Useful for monitoring discussions and user interactions. |
| Files | Retrieves file attachments associated with a specific SharePoint list item. Facilitates file management and ensures access to necessary attachments. |
| Groups | Retrieves group details from a SharePoint site, including membership, permissions, and ownership settings. Essential for managing access control and security within SharePoint. |
| Lists | Retrieves metadata for available lists within a SharePoint site, including list types and settings. Important for understanding the structure of SharePoint lists and their usage. |
| ListItems | Represents all items within SharePoint lists, including standard columns applicable across different lists. Useful for bulk data extraction and reporting. |
| RoleAssignmentMember | Retrieves details about members assigned to specific roles within SharePoint site permissions. Helps in auditing and managing user access rights. |
| RoleAssignments | Retrieves role assignments configured on a SharePoint site, including users and groups with access. Useful for reviewing and managing SharePoint security policies. |
| RoleDefinitionBindings | Lists role definitions bound to specific security groups or users within a SharePoint site. Helps administrators enforce permission policies. |
| Roles | Provides details about available role definitions, including permission levels within a SharePoint site collection. Essential for setting up and modifying security roles. |
| Sites | Retrieves a list of all available sites within the SharePoint server, including metadata and site details. Useful for managing and navigating large SharePoint deployments. |
| Subsites | Lists all subsites under a specified SharePoint site, including hierarchy and metadata. Helps in structuring and organizing content within a SharePoint environment. |
| Users | Retrieves a list of users and their assigned roles within a SharePoint site or group. Important for managing permissions and user activity tracking. |
Stored Procedures are actions that are invoked via SQL queries. They perform tasks beyond standard CRUD operations, including searching, updating, and modifying information.
The Cloud maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.
| Microsoft SharePoint | CData Schema |
| Choice (menu) | string |
| Currency | float |
| Date and Time | datetime |
| Hyperlink or Picture | string |
| Lookup | string |
| Multiple lines of text | string |
| Number | float |
| Person or Group | string |
| Single line of text | string |
| Task Outcome | string |
| Yes/No | bool |
Since the REST API is OData based, server-side filters are done using the OData standard. The driver does most of the server filtering by reading the metadata file and determing which filters can be done on the server.
NOTE: When executing "SELECT *" queries, the Microsoft SharePoint REST API response does not return all the available fields. To avoid too many null values, the provider selects all the columns explicitly using the
$select filter. However, to avoid an error from Microsoft SharePoint REST API regarding the URL length, the provider only does this if the $select filter's length is 1500 or less. This is a limitation of the Microsoft SharePoint REST API. In this situation, the only way to see the actual value of some columns is to explicitly select them in your query.
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| AllEvents | Presents a comprehensive collection of SharePoint event records, detailing timing, location, attendees, and associated metadata for effective event management. |
| AllFiles | Retrieves all files and folders across all document libraries on a SharePoint site, including metadata details. Useful for auditing, bulk processing, and data migration. |
| AllLists | Lists all available SharePoint lists within the domain, including system fields and metadata. Essential for identifying and managing lists across the SharePoint environment. |
| AllPages | Presents a comprehensive collection of SharePoint site pages, providing details about content, layout, creation information, permissions, and associated metadata for effective page management. |
| Attachments | Retrieves attachments associated with a specific list item in a SharePoint list. Helps manage and track attached files related to SharePoint items. |
| Comments | Contains details about comments made on SharePoint items, including authorship, content, replies, and metadata. Useful for monitoring discussions and user interactions. |
| Files | Retrieves file attachments associated with a specific SharePoint list item. Facilitates file management and ensures access to necessary attachments. |
| Groups | Retrieves group details from a SharePoint site, including membership, permissions, and ownership settings. Essential for managing access control and security within SharePoint. |
| Lists | Returns SharePoint lists. |
| ListItems | Represents all items within SharePoint lists, including standard columns applicable across different lists. Useful for bulk data extraction and reporting. |
| RoleAssignmentMember | Retrieves details about members assigned to specific roles within SharePoint site permissions. Helps in auditing and managing user access rights. |
| RoleAssignments | Retrieves role assignments configured on a SharePoint site, including users and groups with access. Useful for reviewing and managing SharePoint security policies. |
| RoleDefinitionBindings | Lists role definitions bound to specific security groups or users within a SharePoint site. Helps administrators enforce permission policies. |
| Roles | Provides details about available role definitions, including permission levels within a SharePoint site collection. Essential for setting up and modifying security roles. |
| Sites | Retrieves a list of all available sites within the SharePoint server, including metadata and site details. Useful for managing and navigating large SharePoint deployments. |
| Subsites | Lists all subsites under a specified SharePoint site, including hierarchy and metadata. Helps in structuring and organizing content within a SharePoint environment. |
| Users | Retrieves a list of users and their assigned roles within a SharePoint site or group. Important for managing permissions and user activity tracking. |
Presents a comprehensive collection of SharePoint event records, detailing timing, location, attendees, and associated metadata for effective event management.
| Name | Type | References | Description |
| SiteURL [KEY] | String |
Sites.SiteURL | The URL of the SharePoint site where the event list resides. |
| EventListId [KEY] | String | The unique identifier of the library. | |
| EventId [KEY] | Int | The unique identifier for the event item. | |
| Category | String | The classification category of the event. | |
| Title | String | The title or subject of the event. | |
| Name | String | The display name of the event item. | |
| Attendees | String | The collection of attendee identifiers for the event. | |
| StartTime | Datetime | The starting time of the event. | |
| EndTime | Datetime | The ending time of the event. | |
| IsAllDayEvent | Bool | Indicates whether the event is scheduled to last the entire day. | |
| Availability | String | The event's availability status (free or busy). | |
| Attachments | Bool | Indicates whether the event item has any attachments. | |
| EventCancelled | Bool | Indicates whether the event has been cancelled. | |
| EventType | Int | The classification type of the event. | |
| Duration | Int | The duration of the event, typically in minutes. | |
| EncodedAbsoluteURL | String | The encoded absolute URL for accessing the event item. | |
| ServerRelativeURL | String | The server-relative URL to access the event item. | |
| Path | String | The server file path of the event item within SharePoint. | |
| CreatedBy | Int | The identifier of the user who created the event item. | |
| ModifiedBy | Int | The identifier of the user who last modified the event record. | |
| Created | Datetime | The timestamp when the event item was created. | |
| Modified | Datetime | The timestamp when the event record was last updated. | |
| Description | String | The detailed description of the event. | |
| ContentTypeID | String | The unique identifier for the content type applied to the event item. | |
| ItemType | Int | The SharePoint item type (for example, file, folder) 0: File; 1: Folder. | |
| FileName | String | The display name of the file associated with the event record. | |
| Resources | String | The associated resources or facilities reserved for the event. | |
| Location | String | The physical or virtual location where the event takes place. | |
| ApproverComments | String | The comments provided by the approver regarding the event item. | |
| ApprovalStatus | Int | The current approval status of the event item. 0: Approved; 1: Rejected; 2: Pending; 3: Draft. | |
| CheckDoubleBooking | String | The indicator used to flag potential double bookings for events. | |
| HiddenParticipants | String | The list of participants hidden from the event's public participant list. | |
| EffectivePermissionsMask | String | The permissions mask representing the effective rights for the event item. | |
| PrincipalCount | String | The number of principals (users or groups) associated with the event item permissions. | |
| IsRecurring | Bool | Indicates whether the event is recurring. | |
| RecurrenceData | String | The XML data defining the recurrence pattern for the event. | |
| TimeZone | Int | The time zone identifier applicable to the event timings. | |
| GUID | String | The globally unique identifier (GUID) for the event item. | |
| UniqueId | String | The read-only GUID for the event record. | |
| BannerImageURL | String | The URL of the banner image associated with the event for visual representation | |
| BannerURL | String | The hyperlink URL for the event's banner image. | |
| BannerDescription | String | The descriptive text for the banner hyperlink of the event. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| ItemCount | Int | The filter that is propagated to the AllLists view. |
Retrieves all files and folders across all document libraries on a SharePoint site, including metadata details. Useful for auditing, bulk processing, and data migration.
Retrieve all items from sites listed in the [Sites] table.
SELECT [*] FROM [AllFiles];
Retrieve all items from the specified site URL.
SELECT [*] FROM [AllFiles] WHERE [SiteURL] = 'https://yourdomain.sharepoint.com/';
Retrieve all items from a specific library within a given site.
SELECT [*] FROM [AllFiles] WHERE [SiteURL] = 'https://yourdomain.sharepoint.com/sites/YourSite' AND [LibraryId] = 'YourLibraryId';
Retrieve specific columns for a file within a specific library and site.
SELECT [SiteURL], [LibraryId], [FileId], [Name] FROM [AllFiles] WHERE [SiteURL] = 'https://yourdomain.sharepoint.com/sites/YourSite' AND [Name] = 'YourFileName.txt';
Retrieve all items from specific libraries in a given site.
SELECT [*]
FROM [AllFiles]
WHERE [SiteURL] = 'https://yourdomain.sharepoint.com/sites/YourSite'
AND [LibraryId] IN ('LibraryId1', 'LibraryId2', 'LibraryId3');
| Name | Type | References | Description |
| SiteURL [KEY] | String |
Sites.SiteURL | The full URL of the SharePoint site where the file is located. Useful for identifying the site context of the file. |
| LibraryId [KEY] | String | The unique identifier of the document library containing the file. Helps in filtering files based on specific libraries. | |
| FileId [KEY] | Int | A unique numeric identifier assigned to the file within SharePoint. Useful for referencing files programmatically. | |
| Name | String | The name of the file, including its extension. Important for identifying and organizing files. | |
| Title | String | The title metadata of the file, which may be different from the file name. Often used for user-friendly file descriptions. | |
| FileSize | String | The size of the file in bytes. Useful for tracking storage usage and managing large files. | |
| FileType | String | The file extension or type, such as .docx, .pdf, or .xlsx. Helps in categorizing and filtering files by format. | |
| ItemType | Int | Indicates the type of SharePoint item. Possible values: Invalid (-1), File (0), Folder (1), Web (2). Helps differentiate between files and folders. | |
| Description | String | A more detailed description of the file, if provided. Useful for adding context to files beyond their name and title. | |
| Path | String | The file path within the SharePoint library. Helps in locating files in a structured hierarchy. | |
| ServerRelativeURL | String | The URL of the file relative to the SharePoint site root. Useful for internal linking within SharePoint. | |
| EncodedAbsoluteURL | String | The full absolute URL of the file, encoded for use in web applications. Essential for accessing files externally. | |
| CheckedOutTo | Int | The user ID of the person who has checked out the file. Helps track document ownership and editing control. | |
| CheckInComment | String | A comment provided when the file was last checked in. Useful for tracking version history and changes. | |
| Version | String | The version number of the file. Helps in managing document revisions and retrieving previous versions. | |
| ContentTypeID | String | The unique identifier of the content type associated with the file. Important for metadata management and workflow automation. | |
| UniqueId | String | A SharePoint-generated unique identifier for the file. Useful for referencing files in workflows and API requests. | |
| GUID | String | The global unique identifier (GUID) assigned to the file. Ensures distinct identification across SharePoint environments. | |
| Created | Datetime | The date and time when the file was initially created. Useful for tracking document lifecycle and auditing purposes. | |
| CreatedBy | String | The username of the person who created the file. Important for monitoring authorship and accountability. | |
| Modified | Datetime | The date and time when the file was last modified. Helps track recent changes and updates. | |
| ModifiedBy | String | The username of the person who last modified the file. Useful for tracking recent contributions. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| ItemCount | Int | Serves as a filter that will be propagated to the AllLists view. |
Lists all available SharePoint lists within the domain, including system fields and metadata. Essential for identifying and managing lists across the SharePoint environment.
| Name | Type | References | Description |
| SiteURL [KEY] | String |
Sites.SiteURL | The full URL of the SharePoint site where the list is located. Useful for identifying the site context of the list. |
| Id [KEY] | String | A unique identifier for the list. Helps in distinguishing lists when working with APIs or automation scripts. | |
| Title | String | The display name of the list. Useful for user-friendly identification of lists. | |
| BaseTemplate | Int | The template type used to create the list, such as a document library, task list, or calendar. Helps determine the list’s functionality. | |
| BaseType | Int | Indicates the base type of the list, such as a generic list or a library. Useful for categorizing lists. | |
| Description | String | A brief description of the list, providing context about its purpose and usage. | |
| Hidden | Bool | Indicates whether the list is hidden from standard SharePoint views. Helps determine if a list is meant for background processes. | |
| AllowDeletion | Bool | Indicates whether the list can be deleted. Useful for protecting critical lists from accidental deletion. | |
| ItemCount | Int | The total number of items stored in the list. Helps in monitoring list usage and performance. | |
| Created | Datetime | The date and time when the list was originally created. Useful for tracking its lifespan. | |
| LastItemDeletedDate | Datetime | The date and time when the most recent item was deleted from the list. Useful for tracking recent deletions. | |
| LastItemModifiedDate | Datetime | The date and time when the last modification was made to any item in the list. Helps identify recent activity. | |
| LastItemUserModifiedDate | Datetime | The date and time when the last modification was made by a user. Useful for differentiating between system and user changes. | |
| HasUniqueRoleAssignments | Bool | Indicates whether the list has custom permission settings instead of inheriting them from the parent site. Important for security management. | |
| DefaultDisplayFormUrl | String | The URL of the default display form for viewing list items. Useful for navigation and form customization. | |
| DefaultEditFormUrl | String | The URL of the default edit form for modifying list items. Helps in linking to the correct edit page. | |
| DefaultNewFormUrl | String | The URL of the default form for creating new list items. Useful for directing users to item creation pages. | |
| DefaultViewPath_DecodedUrl | String | The decoded URL of the default view path for the list. Helps in accessing the list’s standard view. | |
| DefaultViewUrl | String | The URL of the default view of the list. Useful for quick access to the main list view. | |
| DisableCommenting | Bool | Indicates whether commenting is disabled for the list. Helps manage collaboration settings. | |
| DocumentTemplateUrl | String | The URL of the default document template used when creating new files in the list. Important for document libraries. | |
| EnableAttachments | Bool | Indicates whether attachments are allowed for list items. Useful for managing file uploads within lists. | |
| EnableFolderCreation | Bool | Indicates whether users can create folders within the list. Important for structuring content hierarchies. | |
| EntityTypeName | String | The entity type name associated with the list. Helps in API interactions and automation. | |
| ImagePath_DecodedUrl | String | The decoded URL of the list’s associated image. Useful for branding and visual identification. | |
| ImageUrl | String | The URL of the image representing the list. Helps in user-friendly display of lists. | |
| IsApplicationList | Bool | Indicates whether the list is used as part of an application. Helps differentiate standard lists from system-generated ones. | |
| IsCatalog | Bool | Indicates whether the list functions as a catalog. Useful for managing product or resource directories. | |
| IsDefaultDocumentLibrary | Bool | Indicates whether the list is the primary document library of the site. Useful for identifying the main storage location. | |
| IsPrivate | Bool | Indicates whether the list is private and not accessible to all users. Helps enforce security and data protection. | |
| IsSystemList | Bool | Indicates whether the list is a system-generated list used by SharePoint internally. Useful for avoiding unintended modifications. | |
| ListFormCustomized | Bool | Indicates whether the list’s forms have been customized. Important for tracking UI customizations. | |
| ListItemEntityTypeFullName | String | The full entity type name associated with list items. Useful for integrations and API usage. | |
| ParentWebPath_DecodedUrl | String | The decoded URL of the parent site containing the list. Helps identify hierarchical site relationships. | |
| ParentWebUrl | String | The URL of the parent site containing the list. Useful for navigation and organization. | |
| ReadSecurity | Int | Specifies the level of read security applied to the list. Controls who can view items within the list. | |
| ServerTemplateCanCreateFolders | Bool | Indicates whether the server template allows folder creation in the list. Helps manage content structuring. |
Presents a comprehensive collection of SharePoint site pages, providing details about content, layout, creation information, permissions, and associated metadata for effective page management.
| Name | Type | References | Description |
| SiteURL [KEY] | String |
Sites.SiteURL | The base URL of the SharePoint site that hosts the Wiki Page list. |
| PageListId [KEY] | String | The unique identifier of the Wiki Page list (library) that contains the Wiki pages. | |
| PageId [KEY] | Int | The unique identifier for the Wiki Page item. | |
| Name | String | The file name of the Wiki page item, as stored in SharePoint. | |
| Title | String | The display title of the Wiki page item. | |
| FileSize | String | The display string representing the file size of the Wiki page item. | |
| FileType | String | The file type or extension of the Wiki page item. | |
| ItemType | Int | Specifies the type of SharePoint item. Enumerated values: 0 = File, 1 = Folder. | |
| PageLayoutType | String | Specifies the layout type for the Wiki page, determining its design and structure. | |
| PrincipalCount | String | The number of principals (users or groups) associated with the page item's permissions. | |
| EncodedAbsoluteURL | String | The fully encoded URL used to access the Wiki page item. | |
| ServerRelativeURL | String | The server-relative URL path to the Wiki page item. | |
| Path | String | The server file path where the Wiki page item is stored within SharePoint. | |
| ContentTypeID | String | The unique identifier for the content type applied to the Wiki page item. | |
| PromotedState | Double | Specifies the promoted state of the Wiki page. Enumerated values: 0 = Regular page (not promoted), 2 = Promoted page (such as featured or news page). | |
| EffectivePermissionsMask | String | A permissions mask representing the effective rights of the current user for this Wiki page item. | |
| CreatedBy | String | Display name of the user who created the document associated with the Wiki page item. | |
| CreatedById | Int | Identifier of the user who created the Wiki page item. | |
| ModifiedBy | String | Display name of the user who last modified the document associated with the Wiki page item. | |
| ModifiedById | Int | Identifier of the user who last modified the Wiki page item. | |
| Created | Datetime | The date and time when the Wiki page item was created. | |
| Modified | Datetime | The date and time when the Wiki page item was last modified. | |
| Description | String | A brief description or summary of the Wiki page content. | |
| BannerImageDescription | String | Descriptive text associated with the banner image of the Wiki page item. | |
| BannerImageURL | String | The URL for the banner image associated with the Wiki page item. | |
| GUID | String | The globally unique identifier (GUID) for the Wiki page item. | |
| UniqueId | String | A read-only globally unique identifier distinct from the GUID for the Wiki page item. | |
| PageLayoutContent | String | The XML or HTML defining the layout and web parts of the Wiki page. | |
| AuthoringCanvasContent | String | The content and configuration of the authoring canvas, detailing web part arrangements for the Wiki page. | |
| WikiContent | String | The main textual content of the Wiki page, typically written in Wiki markup or HTML. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| ItemCount | Int | The filter that is propagated to the AllLists view. |
Retrieves attachments associated with a specific list item in a SharePoint list. Helps manage and track attached files related to SharePoint items.
Note: List and ItemId are required to return Attachments.
List can be fetched from the Lists view(Title column).
SELECT * FROM Attachments WHERE List = 'TestApp' AND ItemID = 1
| Name | Type | References | Description |
| Id [KEY] | String | A unique identifier for the attachment associated with the list item. Useful for referencing attachments in automation and API calls. | |
| Updated | Datetime | The date and time when the attachment was last modified. Helps track recent updates to file attachments. | |
| FileName | String | The name of the attached file, including its extension. Useful for identifying and managing attachments. | |
| FileExtension | String | The file extension of the attachment. | |
| ServerRelativePath_DecodedUrl | String | The decoded server-relative path of the attachment. Helps in constructing URLs for accessing attachments within SharePoint. | |
| FileNameAsPath_DecodedUrl | String | The decoded file path representation of the attachment’s name. Useful for programmatically referencing attachments. | |
| ServerRelativeUrl | String | The server-relative URL of the attachment. Provides a direct path to the file within SharePoint for internal linking. | |
| ItemURL | String | A browsable link to the attachment. | |
| List | String |
Lists.Title | The internal name of the SharePoint list that contains the attachment. Useful for identifying the source list when retrieving attachments. |
| ItemID | Int | The unique identifier of the list item to which the attachment belongs. Helps in linking attachments to specific records. |
Contains details about comments made on SharePoint items, including authorship, content, replies, and metadata. Useful for monitoring discussions and user interactions.
To retrieve records from the Comments view, you must specify both the List and ItemId columns. These identify the list item whose comments you want to access.
The following query retrieves comments for the item with ItemId = 1 in the list1 list:
SELECT * FROM CData.REST.Comments WHERE List = 'list1' AND ItemId = 1;
| Name | Type | References | Description |
| Id [KEY] | Int | A unique numeric identifier for each comment. Useful for referencing specific comments in workflows or API queries. | |
| ItemId [KEY] | Int |
ListItems.Id | The ID of the SharePoint item that the comment is associated with. Helps link comments to their respective list items. |
| List | String |
Lists.Title | The name of the SharePoint list that contains the commented item. Useful for identifying the list context of the comment. |
| ListId | String | A unique identifier for the SharePoint list containing the comment. Helps differentiate between lists when retrieving comments. | |
| AuthorId | Int | The unique identifier of the user who authored the comment. Useful for tracking authorship and permissions. | |
| AuthorEmail | String | The email address of the user who posted the comment. Helps identify and contact the commenter. | |
| IsReply | Bool | Indicates whether the comment is a reply to another comment. Useful for structuring threaded discussions. | |
| ParentId | Int |
Comments.Id | The ID of the parent comment if this comment is a reply. Helps maintain comment hierarchy in nested conversations. |
| ReplyCount | Int | The total number of replies to the comment. Useful for tracking engagement and discussion activity. | |
| LikeCount | Int | The total number of likes the comment has received. Helps measure comment popularity. | |
| IsLikedByUser | Bool | Indicates whether the current user has liked the comment. Useful for personalizing user interactions. | |
| Text | String | The full text content of the comment. Essential for displaying the comment in user interfaces. | |
| Mentions | String | A list of users mentioned in the comment, separated by commas. Useful for notifying users mentioned in discussions. | |
| CreatedDate | Datetime | The date and time when the comment was originally posted. Useful for tracking comment history. | |
| ModifiedDate | Datetime | The date and time when the comment was last edited. Helps in auditing changes and tracking updates. |
Retrieves file attachments associated with a specific SharePoint list item. Facilitates file management and ensures access to necessary attachments.
| Name | Type | References | Description |
| Id [KEY] | String | A unique identifier for the file in SharePoint. Useful for tracking and referencing files programmatically. | |
| CreatedBy_Id | String | The unique ID of the user who uploaded the file. Helps track file ownership and permissions. | |
| CreatedBy_Name | String | The full name of the user who uploaded the file. Useful for displaying user-friendly metadata. | |
| CreatedBy_Puid | String | A personal identifier for the user who added the file. Useful for identity management in enterprise environments. | |
| ETag | String | An entity tag (ETag) value used for version control. Helps detect changes and prevent conflicting updates to the file. | |
| LastModifiedBy_Id | String | The unique ID of the user who last modified the file. Useful for auditing changes and tracking recent edits. | |
| LastModifiedBy_Name | String | The full name of the user who last modified the file. Helps in identifying contributors to a document. | |
| LastModifiedBy_Puid | String | A personal identifier for the user who last modified the file. Useful for distinguishing unique users across sessions. | |
| Name | String | The name of the file, including its extension (such as 'document.pdf'). Essential for file identification. | |
| Size | Long | The size of the file in bytes, excluding any Web Parts used in the file. Helps monitor storage usage and manage large files. | |
| TimeCreated | Datetime | The date and time when the file was originally created. Useful for tracking document history and retention policies. | |
| TimeLastModified | Datetime | The date and time when the file was last modified. Helps determine the most recent update to the file. | |
| Url | String | The full URL of the file. Useful for direct access and linking within SharePoint. | |
| List | String | The display name of the SharePoint list or library where the file is stored. Helps in organizing and retrieving files efficiently. |
Retrieves group details from a SharePoint site, including membership, permissions, and ownership settings. Essential for managing access control and security within SharePoint.
| Name | Type | References | Description |
| Id [KEY] | Int | A unique identifier for the SharePoint group. Useful for managing group permissions and retrieving group details. | |
| LoginName | String | The login name or alias associated with the group. Helps in authentication and managing group-based access control. | |
| Title | String | The display name of the group. Useful for displaying user-friendly group names in the SharePoint UI. | |
| AllowMembersEditMembership | Bool | Indicates whether group members have permission to add or remove users from the group. Useful for determining member control policies. | |
| AllowRequestToJoinLeave | Bool | Indicates whether users can request to join or leave the group. Helps manage open or restricted membership settings. | |
| AutoAcceptRequestToJoinLeave | Bool | Indicates whether membership requests are automatically approved. Useful for self-service group management. | |
| CanCurrentUserEditMembership | Bool | Indicates whether the currently logged-in user has permissions to edit the group's membership. Helps determine user-specific permissions. | |
| CanCurrentUserManageGroup | Bool | Indicates whether the current user has management permissions for the group. Useful for determining administrative access levels. | |
| CanCurrentUserViewMembership | Bool | Indicates whether the current user can view the group's membership details. Helps enforce security settings and access control. | |
| Description | String | A brief summary of the group's purpose or function. Useful for providing context about the group’s role in SharePoint. | |
| IsHiddenInUI | Bool | Indicates whether the group is hidden from the SharePoint user interface. Helps control visibility of system or background groups. | |
| OnlyAllowMembersViewMembership | Bool | Indicates whether only group members are allowed to view membership details. Useful for maintaining privacy and security settings. | |
| OwnerTitle | String | The display name of the group's owner. Helps identify the person responsible for managing the group. | |
| RequestToJoinLeaveEmailSetting | String | The email address where requests to join or leave the group are sent. Useful for managing group membership approvals. | |
| PrincipalType | Int | Specifies the type of principal associated with the group. Possible values include: None (0), User (1), DistributionList (2), SecurityGroup (4), SharePointGroup (8), All (15). Helps in categorizing different types of groups and users. |
Returns SharePoint lists.
Lists can be used to list the tables in SharePoint. This will only return actual lists in SharePoint and not any special tables associated with the Cloud.
The following columns can be used in the WHERE clause: Title and BaseTemplate.
| Name | Type | References | Description |
| Id [KEY] | String | The GUID that identifies the list in the database. | |
| EntityTypeName | String | The entity type name for the list. | |
| Title | String | The displayed title for the list. | |
| AdditionalUXProperties | String | Additional user experience properties associated with the list. | |
| AllowContentTypes | Bool | Specifies whether the list supports content types. | |
| AllowDeletion | Bool | Specifies whether the list allows deletion. | |
| BaseTemplate | Int | The list definition type on which the list is based. Represents a ListTemplateType value. | |
| BaseType | Int | The base type for the list. Represents an SP.BaseType value: Generic List = 0; Document Library = 1; Discussion Board = 3; Survey = 4; Issue = 5. | |
| BrowserFileHandling | Int | The override of the web application's BrowserFileHandling property at the list level: Permissive = 0; Strict = 1. | |
| Color | String | The color value associated with the list. | |
| ContentTypesEnabled | Bool | Specifies whether content types are enabled for the list. | |
| CrawlNonDefaultViews | Bool | Specifies whether non-default views of the list are included in search crawls. | |
| Created | Datetime | Date and time when the list was created. | |
| DefaultContentApprovalWorkflowId | String | The default workflow identifier for content approval on the list. Returns an empty GUID if there is no default content approval workflow. | |
| DefaultDisplayFormURL | String | The location of the default display form for the list. Clients specify a server-relative URL, and the server returns a site-relative URL | |
| DefaultEditFormURL | String | The URL of the edit form to use for list items in the list. Clients specify a server-relative URL, and the server returns a site-relative URL. | |
| DefaultItemOpenInBrowser | Bool | Specifies whether list items are opened in the browser by default. | |
| DefaultItemOpenUseListSetting | Bool | Specifies whether the list setting determines how items are opened by default. | |
| DefaultNewFormURL | String | Gets or sets a value that specifies the location of the default new form for the list. Clients specify a server-relative URL, and the server returns a site-relative URL. | |
| DefaultViewPath_DecodedURL | String | The decoded URL of the default view path for the list. | |
| DefaultViewURL | String | The URL of the default view for the list. | |
| Description | String | The description of the list. | |
| Direction | String | The reading order of the list. Returns NONE, LTR, or RTL. | |
| DisableCommenting | Bool | Specifies whether commenting is disabled for items in the list. | |
| DisableGridEditing | Bool | Specifies whether grid editing is disabled for the list. | |
| DocumentTemplateURL | String | The server-relative URL of the document template for the list. Returns a server-relative URL if the base type is DocumentLibrary, otherwise returns null. | |
| DraftVersionVisibility | Int | The minimum permission required to view minor versions and drafts within the list: Reader = 0; Author = 1; Approver = 2. | |
| EffectiveBasePermissions_High | Long | The effective permissions on the list that are assigned to the current user. | |
| EffectiveBasePermissions_Low | Long | The effective permissions on the list that are assigned to the current user. | |
| EffectiveBasePermissionsForUI_High | Long | The high-order part of the effective base permissions for the list as displayed in the user interface. | |
| EffectiveBasePermissionsForUI_Low | Long | The low-order part of the effective base permissions for the list as displayed in the user interface. | |
| EnableAssignToEmail | Bool | Specifies whether the 'Assign To' email notification feature is enabled for the list. | |
| EnableAttachments | Bool | Specifies whether list item attachments are enabled for the list. | |
| EnableFolderCreation | Bool | Specifies whether new list folders can be added to the list. | |
| EnableMinorVersions | Bool | Specifies whether minor versions are enabled for the list. | |
| EnableModeration | Bool | Specifies whether content approval is enabled for the list. | |
| EnableRequestSignOff | Bool | Specifies whether the 'Request Sign Off' feature is enabled for the list. | |
| EnableVersioning | Bool | Specifies whether historical versions of list items and documents can be created in the list. | |
| ExcludeFromOfflineClient | Bool | Specifies whether the list is excluded from offline clients. | |
| ExcludeFromOfflineMode | Bool | Specifies whether the list is excluded from offline mode. | |
| ExemptFromBlockDownloadOfNonViewableFiles | Bool | Specifies whether the list is exempt from the block download policy for non-viewable files. | |
| FileSavePostProcessingEnabled | Bool | Specifies whether post-processing is enabled when saving files to the list. | |
| ForceCheckout | Bool | Specifies whether forced checkout is enabled for the document library. | |
| HasContentAssemblyTemplates | Bool | Specifies whether the list has content assembly templates. | |
| HasExternalDataSource | Bool | Specifies whether the list is an external list. | |
| HasFolderColoringFields | Bool | Specifies whether the list has folder coloring fields. | |
| HasListBoundContentAssemblyTemplates | Bool | Specifies whether the list has list-bound content assembly templates. | |
| HasUniqueRoleAssignments | Bool | Specifies whether the role assignments are uniquely defined for this securable object or inherited from a parent securable object. | |
| Hidden | Bool | Specifies whether the list is hidden. If true, the server sets the OnQuickLaunch property to false. | |
| HighPriorityMediaProcessing | Bool | Specifies whether high priority media processing is enabled for the list. | |
| Icon | String | The icon associated with the list. | |
| ImagePath_DecodedURL | String | The decoded URL of the image path for the list. | |
| ImageURL | String | The URL for the icon of the list. | |
| IrmEnabled | Bool | Specifies whether IRM is enabled for the list. | |
| IrmExpire | Bool | Specifies whether IRM expiration is enabled for the list. | |
| IrmReject | Bool | Specifies whether IRM rejection is enabled for the list. | |
| IsApplicationList | Bool | Specifies a flag that a client application can use to determine whether to display the list. | |
| IsCatalog | Bool | Specifies whether the list is a gallery. | |
| IsContributorOwnerEnabled | Bool | Specifies whether contributor owner is enabled for the list. | |
| IsDefaultDocumentLibrary | Bool | Specifies whether the list is the default document library. | |
| IsPredictionModelApplied | Bool | Specifies whether a prediction model is applied to the list. | |
| IsPrivate | Bool | Specifies whether the list is private. | |
| IsSystemList | Bool | Specifies whether the list is a system list. | |
| ItemCount | Int | The number of items in the list. | |
| LastItemDeletedDate | Datetime | The last date and time a list item was deleted from the list. | |
| LastItemModifiedDate | Datetime | The last date and time a list item, field, or property of the list was modified. | |
| LastItemUserModifiedDate | Datetime | The last date and time a list item, field, or property of the list was last modified by a user. | |
| ListExperienceOptions | Int | The experience options for the list. | |
| ListFormCustomized | Bool | Specifies whether the list form is customized. | |
| ListItemEntityTypeFullName | String | The full entity type name for the list items. | |
| ListSchemaVersion | Int | The schema version of the list. | |
| MajorVersionLimit | Int | The limit of major versions allowed for items in the list. | |
| MajorWithMinorVersionsLimit | Int | The limit of major versions with minor versions allowed for items in the list. | |
| MultipleDataList | Bool | Specifies whether the list in a Meeting Workspace site contains data for multiple meeting instances within the site. | |
| NoCrawl | Bool | Specifies that the crawler must not crawl the list. | |
| OnQuickLaunch | Bool | Specifies whether the list appears on the Quick Launch of the site. If true, the server sets the Hidden property to false. | |
| PageRenderType | Int | The page render type for the list. | |
| ParentWebPath_DecodedURL | String | The decoded URL of the parent web path for the list. | |
| ParentWebURL | String | Specifies the server-relative URL of the site that contains the list. | |
| ParserDisabled | Bool | Specifies whether the parser is disabled for the list. | |
| ReadSecurity | Int | The read security setting for the list. | |
| SchemaXML | String | The list schema represented as an XML. | |
| ServerRelativeURL | String | The Server Relative URL. | |
| ServerTemplateCanCreateFolders | Bool | Specifies whether folders can be created within the list. | |
| ShowHiddenFieldsInModernForm | Bool | Specifies whether hidden fields are shown in the modern form for the list. | |
| TemplateFeatureId | String | The identifier of the feature that contains the list schema for the list. Returns an empty GUID if the list schema is not contained within a feature. | |
| TemplateTypeId | String | The template type identifier for the list. | |
| ValidationFormula | String | The data validation criteria for a list item. | |
| ValidationMessage | String | The error message returned when data validation fails for a list item. | |
| WriteSecurity | Int | The write security setting for the list. |
Represents all items within SharePoint lists, including standard columns applicable across different lists. Useful for bulk data extraction and reporting.
To retrieve records from the ListItems view, you must specify the List column. This identifies the Microsoft SharePoint list from which items should be fetched.
The following query retrieves all items from the list named List1:
SELECT * FROM CData.REST.ListItems WHERE List = 'List1';
| Name | Type | References | Description |
| ID [KEY] | Int | A unique numeric identifier assigned to the list item. Useful for referencing specific items in workflows and API queries. | |
| Title | String | The title or name of the list item. Helps in quickly identifying and organizing items within the list. | |
| Attachments | Bool | Indicates whether the list item has one or more attachments. Useful for managing related documents or files. | |
| Description | String | A detailed description of the list item. Helps provide additional context or metadata for the item. | |
| List [KEY] | String |
Lists.Title | The display name of the SharePoint list containing the item. Useful for identifying the source list when retrieving items. |
| ContentTypeID | String | The identifier for the content type associated with the item. Helps enforce metadata structures and define item types. | |
| FileSystemObjectType | Int | Indicates the type of object in the file system. Possible values: '-1' (Invalid), '0' (File), '1' (Folder), '2' (Web). Useful for distinguishing between files, folders, and site components. | |
| GUID | String | A globally unique identifier (GUID) assigned to the item. Ensures distinct identification across SharePoint environments. | |
| Version | String | The version number of the item, indicating its revision history. Useful for tracking changes and rollback purposes. | |
| CreatedBy | Int |
Users.Id | The unique identifier of the user who created the item. Useful for tracking authorship and permissions. |
| ModifiedBy | Int |
Users.Id | The unique identifier of the last user who edited the item. Helps monitor recent changes and user contributions. |
| Created | Datetime | The date and time when the item was originally created. Useful for tracking item lifecycle and auditing changes. | |
| Modified | Datetime | The date and time when the item was last modified. Helps identify recent updates and maintain version history. |
Retrieves details about members assigned to specific roles within SharePoint site permissions. Helps in auditing and managing user access rights.
Note: PrincipalId is required to return RoleAssignmentMember.
SELECT * FROM RoleAssignmentMember WHERE PrincipalId = 3 SELECT * FROM RoleAssignmentMember WHERE List = 'TestApp' AND PrincipalId = 3 SELECT * FROM RoleAssignmentMember WHERE PrincipalId = 5 AND list = 'MyTestList' AND ItemId = '3'
| Name | Type | References | Description |
| ID [KEY] | Int | A unique numeric identifier for the role-assigned member. Useful for tracking specific role assignments. | |
| Updated | Datetime | The date and time when the role assignment was last modified. Helps track changes in permissions and access control. | |
| IsHiddenInUI | Boolean | Indicates whether the assigned role member is hidden from the user interface. Useful for managing background roles that should not be visible. | |
| LoginName | String | The login name of the user or group assigned to the role. Useful for authentication and permission management. | |
| Title | String | The display title of the role-assigned member. Helps in easily identifying assigned users or groups. | |
| PrincipalType | Int | Specifies the type of principal assigned to the role. Possible values: None (0), User (1), DistributionList (2), SecurityGroup (4), SharePointGroup (8), All (15). Helps classify different types of role members. | |
| AllowMembersEditMembership | Boolean | Indicates whether members of the role are allowed to modify group membership. Useful for self-managed roles. | |
| AllowRequestToJoinLeave | Boolean | Indicates whether users can request to join or leave the assigned role. Helps control role accessibility. | |
| AutoAcceptRequestToJoinLeave | Boolean | Indicates whether requests to join or leave the role are automatically approved. Useful for open-access roles. | |
| Description | String | A short description of the role-assigned member. Helps provide additional context on role responsibilities. | |
| OnlyAllowMembersViewMembership | Boolean | Indicates whether only members of the role are allowed to view its membership details. Helps enforce privacy settings. | |
| OwnerTitle | String | The display name of the owner of the assigned role. Useful for identifying role managers or administrators. | |
| RequestToJoinLeaveEmailSetting | String | The email address where membership requests for the role are sent. Useful for managing access requests. | |
| List | String |
Lists.Title | The display name of the SharePoint list from which the role assignment information is retrieved. Helps identify the context of the role assignment. |
| ItemId | Int | The unique identifier of the list item associated with the role assignment. Helps link role assignments to specific items. | |
| PrincipalId | Int |
RoleAssignments.PrincipalId | The unique identifier of the principal (user or group) assigned to the role. Useful for managing security and access control. |
Retrieves role assignments configured on a SharePoint site, including users and groups with access. Useful for reviewing and managing SharePoint security policies.
SELECT * FROM RoleAssignments WHERE List = 'TestApp' SELECT * FROM RoleAssignments WHERE PrincipalId = 5 AND list = 'MyListName' AND ItemId = '3'
| Name | Type | References | Description |
| ID [KEY] | String | A unique identifier for the role assignment. Useful for tracking and managing permissions in SharePoint. | |
| PrincipalId | Int | The unique identifier of the principal (user or group) assigned to the role. Helps manage access control and security settings. | |
| Updated | Datetime | The date and time when the role assignment was last modified. Useful for auditing permission changes. | |
| List | String |
Lists.Title | The display name of the SharePoint list containing the role assignment. Helps identify where the role is applied. |
| ItemId | Int | The unique identifier of the list item associated with the role assignment. Useful for linking role assignments to specific records. |
Lists role definitions bound to specific security groups or users within a SharePoint site. Helps administrators enforce permission policies.
NOTE: PrincipalId is required to return RoleDefinitionBindings.
SELECT * FROM RoleDefinitionBindings WHERE PrincipalId = 3 SELECT * FROM RoleDefinitionBindings WHERE List = 'TestApp' AND PrincipalId = 3 SELECT * FROM RoleDefinitionBindings WHERE PrincipalId = 5 AND list = 'KatsunariMatsumoto' AND ItemId = '3'
| Name | Type | References | Description |
| PrincipalId [KEY] | Int |
RoleAssignments.PrincipalId | The unique identifier of the principal (user or group) assigned to the role. Helps manage security and access control settings. |
| ID [KEY] | Int | A unique identifier for the role-assigned member. Useful for tracking role assignments in SharePoint. | |
| BasePermissions_High | Long | Represents the high-level base permissions applied to the role. Helps define access rights and security policies. | |
| BasePermissions_Low | Long | Represents the low-level base permissions assigned to the role. Used for managing security settings. | |
| Description | String | A short description of the role definition. Useful for understanding the purpose and scope of the assigned role. | |
| Hidden | Boolean | Indicates whether the role definition is hidden from the user interface. Useful for managing system-level roles. | |
| Name | String | The display name of the role definition. Helps users identify the role and its permissions. | |
| Order | Int | The position of the role definition in the order of assignments. Useful for prioritizing role applications. | |
| RoleTypeKind | Int | Specifies the type of role assigned. Helps classify different role definitions within SharePoint. | |
| List | String |
Lists.Title | The display name of the SharePoint list containing the role assignment. Helps identify where the role is applied. |
| ItemId | Int | The unique identifier of the list item associated with the role definition. Useful for linking role definitions to specific records. |
Provides details about available role definitions, including permission levels within a SharePoint site collection. Essential for setting up and modifying security roles.
| Name | Type | References | Description |
| Id [KEY] | Int | A unique identifier for the role definition. Useful for tracking and managing role permissions in SharePoint. | |
| BasePermissions_High | Long | Represents the high-level base permissions assigned to the role definition. Helps define broad access rights within SharePoint. | |
| BasePermissions_Low | Long | Represents the low-level base permissions assigned to the role definition. Used for setting granular access controls. | |
| Description | String | A brief summary of the role definition, outlining its purpose and assigned permissions. Helps in understanding role scope. | |
| Hidden | Bool | Indicates whether the role definition is hidden from the Permission Levels page. Useful for managing system-defined or background roles. | |
| Name | String | The display name assigned to the role definition. Helps users easily identify different permission levels. | |
| Order | Int | Determines the position of the role definition in the list of permission levels within the site collection. Useful for organizing roles in a structured manner. | |
| RoleTypeKind | Int | Represents the type of role definition, mapped to an SP.RoleType enumeration. Helps classify roles based on predefined categories within SharePoint. |
Retrieves a list of all available sites within the SharePoint server, including metadata and site details. Useful for managing and navigating large SharePoint deployments.
| Name | Type | References | Description |
| SiteURL [KEY] | String | The full URL of the SharePoint site. Useful for navigating and referencing the site in automation or APIs. | |
| SiteCollectionId | String | A unique identifier for the site collection. Helps distinguish site collections within a SharePoint environment. | |
| WebId | String | A unique identifier for the specific site within the site collection. Useful for referencing individual subsites. | |
| Title | String | The display title of the site. Helps users easily identify sites within the collection. | |
| SiteCollectionURL | String | The URL of the site collection that contains the site. Useful for identifying parent site collections. | |
| Description | String | A brief description of the site, outlining its purpose or content. Helps provide context to users. | |
| Created | Datetime | The date and time when the site was created. Useful for tracking site lifespan and historical records. | |
| LastModified | Datetime | The date and time when the site was last updated. Helps monitor recent site activity. | |
| SPWebUrl | String | The URL used to display the site in a browser. Useful for UI navigation and direct linking. | |
| Author | String | The user who created the site. Helps track site ownership and administrative responsibility. | |
| DocumentSignature | String | A unique identifier related to the site's document signature. Useful for security and verification purposes. | |
| FileExtension | String | The file extension type associated with the site’s primary document. Helps in identifying site-related files. | |
| SecondaryFileExtension | String | An alternative file extension associated with the site’s files. Useful for additional document classification. | |
| FileType | String | The type of file associated with the site. Helps in organizing and filtering site-related documents. | |
| DocId | Long | A unique identifier for the site within a specific geographic location. Useful for multi-region SharePoint environments. | |
| GeoLocationSource | String | The geographical location of the site. Helps in categorizing sites based on region or physical location. | |
| HitHighlightedSummary | String | A highlighted summary of the site's content. Useful for search indexing and quick content previews. | |
| Importance | Long | An assigned importance score for the site. Helps in prioritizing sites within search results or organizational hierarchy. | |
| IsContainer | Bool | Indicates whether the site is structured as a folder. Helps distinguish folder-based sites from document-based sites. | |
| IsDocument | Bool | Indicates whether the site is treated as a document. Useful for categorizing site types. | |
| Path | String | The full site path within SharePoint. Useful for constructing file references and folder navigation. | |
| Rank | Double | The rank assigned to the site based on various parameters. Helps determine search relevance. | |
| RenderTemplateId | String | The control render template used for displaying the site. Helps in UI customization and theming. | |
| SiteLogo | String | The URI of the site's logo. Useful for branding and visual identification. | |
| ViewsLifeTime | Long | The total number of views the site has received since creation. Helps measure long-term engagement. | |
| ViewsRecent | Long | The total number of views the site has received in the last 14 days. Useful for tracking recent user interest. | |
| WebTemplate | String | The web template used to create the site. Helps identify the site's structure and purpose. |
Lists all subsites under a specified SharePoint site, including hierarchy and metadata. Helps in structuring and organizing content within a SharePoint environment.
| Name | Type | References | Description |
| Id [KEY] | String | Unique GUID of the subsite (SP.Web.Id). | |
| Title | String | Display title of the subsite shown in navigation and the UI. | |
| Url | String | Absolute URL of the subsite (e.g., https://tenant.sharepoint.com/sites/parent/subsite). | |
| AccessRequestSiteDescription | String | Optional text shown on the access request page for this site. | |
| Acronym | String | Short name/acronym used for the site in certain experiences. | |
| AllowAutomaticASPXPageIndexing | Bool | Whether classic .aspx pages can be automatically added to search index. | |
| AllowCreateDeclarativeWorkflowForCurrentUser | Bool | Whether the current user can create declarative (no-code) workflows. | |
| AllowDesignerForCurrentUser | Bool | Whether the current user can open the site in SharePoint Designer. | |
| AllowMasterPageEditingForCurrentUser | Bool | Whether the current user can edit master pages for this site. | |
| AllowRevertFromTemplateForCurrentUser | Bool | Whether the current user can revert site changes applied from a template. | |
| AllowRssFeeds | Bool | Enables or disables RSS feeds at the site level. | |
| AllowSaveDeclarativeWorkflowAsTemplateForCurrentUser | Bool | Whether the current user can save a declarative workflow as a template. | |
| AllowSavePublishDeclarativeWorkflowForCurrentUser | Bool | Whether the current user can save and publish declarative workflows. | |
| AlternateCssUrl | String | Alternate CSS file URL for classic pages (if configured). | |
| AppInstanceId | String | App instance GUID associated with the site (if provisioned from an app). | |
| ClassicWelcomePage | String | Welcome page path used by classic experience. | |
| CommentsOnSitePagesDisabled | Bool | Turns modern page comments on or off for this site. | |
| Configuration | Int | Numeric template configuration (site definition configuration ID). | |
| ContainsConfidentialInfo | Bool | Indicates that the site may contain confidential information. | |
| Created | Datetime | Creation timestamp of the subsite. | |
| CurrentChangeToken_StringValue | String | Change token string identifying the latest change captured for this Web. | |
| CustomMasterUrl | String | Custom master page URL applied to the site (classic). | |
| CustomSiteActionsDisabled | Bool | Disables custom site actions in the UI when true. | |
| DefaultNewPageTemplateId | String | Default page template ID used when creating new modern pages. | |
| Description | String | Site description shown in some directory and UI contexts. | |
| DescriptionForExistingLanguage | String | Localized description for the current UI language. | |
| DesignerDownloadUrlForCurrentUser | String | Download URL for SharePoint Designer if available for the current user. | |
| DesignPackageId | String | Design package (WSP) identifier applied to this site (classic). | |
| DisableAppViews | Bool | Disables application-specific views within the site when true. | |
| DisableFlows | Bool | Disables Power Automate (Flow) integration for this site when true. | |
| DisableRecommendedItems | Bool | Turns off recommended content experiences for this site. | |
| DocumentLibraryCalloutOfficeWebAppPreviewersDisabled | Bool | Disables Office Web Apps document previewers in library callouts. | |
| EffectiveBasePermissions_High | Long | High 32 bits of the current user’s effective permission mask on the site. | |
| EffectiveBasePermissions_Low | Long | Low 32 bits of the current user’s effective permission mask on the site. | |
| EnableMinimalDownload | Bool | Enables the Minimal Download Strategy (MDS) for classic pages. | |
| ExcludeFromOfflineClient | Bool | Prevents site content from being made available to offline clients. | |
| FontOptionForSiteFooterNav_fontFace | String | Font face applied to the footer navigation (modern theming). | |
| FontOptionForSiteFooterNav_fontFamilyKey | String | Font family key used for footer navigation (modern). | |
| FontOptionForSiteFooterNav_fontVariantWeight | String | Variant/weight used for footer navigation font (modern). | |
| FontOptionForSiteFooterTitle_fontFace | String | Font face applied to footer titles (modern theming). | |
| FontOptionForSiteFooterTitle_fontFamilyKey | String | Font family key used for footer titles (modern). | |
| FontOptionForSiteFooterTitle_fontVariantWeight | String | Variant/weight used for footer title font (modern). | |
| FontOptionForSiteNav_fontFace | String | Font face applied to the site’s top navigation (modern). | |
| FontOptionForSiteNav_fontFamilyKey | String | Font family key used for site navigation (modern). | |
| FontOptionForSiteNav_fontVariantWeight | String | Variant/weight used for site navigation font (modern). | |
| FontOptionForSiteTitle_fontFace | String | Font face applied to the site title (modern header). | |
| FontOptionForSiteTitle_fontFamilyKey | String | Font family key used for the site title (modern). | |
| FontOptionForSiteTitle_fontVariantWeight | String | Variant/weight used for the site title font (modern). | |
| FooterAlignment | Int | Alignment setting for the modern site footer. | |
| FooterBlur | Int | Blur intensity for the modern footer background (if used). | |
| FooterColorIndexInDarkMode | Int | Theme color index applied to the footer in dark mode. | |
| FooterColorIndexInLightMode | Int | Theme color index applied to the footer in light mode. | |
| FooterEmphasis | Int | Emphasis level (weight) used by the modern footer. | |
| FooterEnabled | Bool | Enables the modern footer on the site. | |
| FooterLayout | Int | Layout option used by the modern footer. | |
| FooterOverlayColor | Int | Overlay color index applied to the footer background. | |
| FooterOverlayGradientDirection | Int | Gradient direction used by the footer overlay. | |
| FooterOverlayOpacity | Int | Opacity of the footer overlay layer. | |
| HasWebTemplateExtension | Bool | Indicates if a web template extension is present. | |
| HeaderColorIndexInDarkMode | Int | Theme color index applied to the header in dark mode. | |
| HeaderColorIndexInLightMode | Int | Theme color index applied to the header in light mode. | |
| HeaderEmphasis | Int | Emphasis level (weight) used by the modern header. | |
| HeaderLayout | Int | Layout option used by the modern header. | |
| HeaderOverlayColor | Int | Overlay color index applied to the header background. | |
| HeaderOverlayGradientDirection | Int | Gradient direction used by the header overlay. | |
| HeaderOverlayOpacity | Int | Opacity of the header overlay layer. | |
| HideTitleInHeader | Bool | Hides the site title in the modern header when true. | |
| HorizontalQuickLaunch | Bool | Uses horizontal quick launch navigation layout (classic). | |
| IsEduClass | Bool | Indicates the site is associated with an EDU Class experience. | |
| IsEduClassProvisionChecked | Bool | Marks whether EDU Class provisioning checks have completed. | |
| IsEduClassProvisionPending | Bool | Indicates EDU Class provisioning is pending. | |
| IsHomepageModernized | Bool | Indicates whether the site homepage has been modernized. | |
| IsMultilingual | Bool | Whether Multilingual UI (MUI) is enabled for the site. | |
| IsProvisioningComplete | Bool | Indicates the site provisioning process has completed. | |
| IsRevertHomepageLinkHidden | Bool | Hides the 'revert homepage' link for modernized sites. | |
| Language | Int | LCID for the site’s default UI language (e.g., 1033=en-US). | |
| LastItemModifiedDate | Datetime | Timestamp of the most recent item modification within the site. | |
| LastItemUserModifiedDate | Datetime | Timestamp of the most recent user-initiated item modification. | |
| LogoAlignment | Int | Alignment option for the site logo in the modern header. | |
| MasterUrl | String | Master page URL used by the site (classic master page). | |
| MegaMenuEnabled | Bool | Enables the modern mega menu-style navigation (where supported). | |
| MembersCanShare | Bool | Allows Members to share content with others when true. | |
| NavAudienceTargetingEnabled | Bool | Enables audience targeting for site navigation links. | |
| NextStepsFirstRunEnabled | Bool | Shows the 'Next steps' first-run experience to site owners. | |
| NoCrawl | Bool | If true, the site is excluded from search indexing and results. | |
| NotificationsInOneDriveForBusinessEnabled | Bool | Enables OneDrive for Business notifications related to this site. | |
| NotificationsInSharePointEnabled | Bool | Enables SharePoint notifications for site activities. | |
| ObjectCacheEnabled | Bool | Enables the object cache for classic publishing scenarios. | |
| OverwriteTranslationsOnChange | Bool | Overwrites alternate language translations when default text changes. | |
| PreviewFeaturesEnabled | Bool | Enables preview/early release features on this site (tenant-controlled). | |
| PrimaryColor | String | Primary brand color value applied by the current theme. | |
| QuickLaunchEnabled | Bool | Enables the left-hand (Quick Launch) navigation. | |
| RecycleBinEnabled | Bool | Whether the Recycle Bin feature is enabled for this site. | |
| RelatedHubSiteIds | String | List of hub site IDs related or associated with this site. | |
| ResourcePath_DecodedUrl | String | Decoded URL value of the resource path representing the site. | |
| SaveSiteAsTemplateEnabled | Bool | Allows saving the site as a template (classic feature) when true. | |
| SearchBoxInNavBar | Int | Placement/visibility option for the search box in the navbar. | |
| SearchBoxPlaceholderText | String | Custom placeholder text displayed in the navigation search box. | |
| SearchScope | Int | Default scope used when searching from this site’s UI. | |
| ServerRelativePath_DecodedUrl | String | Decoded server-relative path of the site (modern typed path). | |
| ServerRelativeUrl | String | Server-relative URL of the site (e.g., /sites/parent/subsite). | |
| ShowUrlStructureForCurrentUser | Bool | Lets the current user view URL/folder structure in the UI. | |
| SiteLogoDescription | String | Alt text/description for the site logo. | |
| SiteLogoUrl | String | URL of the site logo image. | |
| SupportedUILanguageIds | String | Collection of LCIDs for languages enabled for the site’s UI (MUI). | |
| SyndicationEnabled | Bool | Enables RSS syndication for the site when true. | |
| TenantAdminMembersCanShare | Int | Tenant policy value controlling whether Members can share. | |
| TenantTagPolicyEnabled | Bool | Indicates whether tenant tag policy is enforced for this site. | |
| ThemeApplicationActionHistory | String | History log of theme application actions on the site. | |
| ThemeData | String | Serialized theme data applied to the site. | |
| ThemedCssFolderUrl | String | Folder URL where themed CSS is stored for the site. | |
| ThirdPartyMdmEnabled | Bool | Enables 3rd-party mobile device management integration. | |
| TitleForExistingLanguage | String | Localized title for the current UI language. | |
| TreeViewEnabled | Bool | Shows the Tree View (classic) for navigation when true. | |
| UIVersion | Int | UI version number (classic UI versioning setting). | |
| UIVersionConfigurationEnabled | Bool | Allows configuration of the classic UI version when true. | |
| WebTemplate | String | Template name used to provision the site (e.g., STS). | |
| WebTemplateConfiguration | String | Template configuration value paired with WebTemplate (site definition config ID). | |
| WebTemplatesGalleryFirstRunEnabled | Bool | Shows the Web Templates gallery first-run experience when true. | |
| WelcomePage | String | Relative URL of the welcome/home page (classic experience). | |
| AccessRequestListUrl | String | URL of the list that stores access requests for this site. | |
| RequestAccessEmail | String | Email address used to receive access requests. | |
| UseAccessRequestDefault | Bool | Uses the default access request behavior when true. | |
| DescriptionTranslations | String | Localized resource entries for the site description. | |
| TitleTranslations | String | Localized resource entries for the site title. |
Retrieves a list of users and their assigned roles within a SharePoint site or group. Important for managing permissions and user activity tracking.
SELECT * FROM Users // Fetch all the Users SELECT * FROM Users WHERE GroupId = 5 // Fetch a user for a particular Group
| Name | Type | References | Description |
| Id [KEY] | Int | A unique numeric identifier assigned to each user in the SharePoint environment. Useful for referencing users in workflows and permissions management. | |
| LoginName | String | The unique login name of the user accessing SharePoint. Helps authenticate and identify users within the system. | |
| Title | String | The display name or title associated with the user. Useful for showing user-friendly names in SharePoint interfaces. | |
| IsHiddenInUI | Bool | Indicates whether the user is hidden from the SharePoint user interface. Useful for managing background or system accounts. | |
| GroupId | Int | The identifier of the group the user belongs to. Helps manage user roles and permissions within groups. | |
| AadObjectId_NameId | String | The Azure Active Directory (AAD) object ID representing the user's unique identifier. Useful for integrating SharePoint with Azure AD. | |
| AadObjectId_NameIdIssuer | String | The issuer of the AAD NameId for the user. Helps verify the authentication source. | |
| String | The primary email address associated with the user. Useful for communication and notification purposes. | ||
| EmailWithFallback | String | An alternate or fallback email address for the user if the primary email is unavailable. Helps ensure redundancy in communication. | |
| Expiration | String | Specifies the expiration date of the user's access, if applicable. Useful for managing temporary access permissions. | |
| HexCid | String | A hexadecimal representation of the user's client ID. Helps in system tracking and authentication processes. | |
| IsEmailAuthenticationGuestUser | Bool | Indicates whether the user is a guest authenticated via email. Useful for identifying external users. | |
| IsShareByEmailGuestUser | Bool | Indicates whether the user is a guest invited via email for sharing purposes. Helps track external collaborators. | |
| IsSiteAdmin | Bool | Specifies whether the user has administrative rights for the SharePoint site collection. Helps manage site ownership and security. | |
| UserId_NameId | String | The unique identifier for the user in SharePoint’s user ID system. Useful for tracking user activities and permissions. | |
| UserId_NameIdIssuer | String | The issuer of the user's ID in SharePoint’s user ID system. Helps validate identity sources. | |
| UserPrincipalName | String | The User Principal Name (UPN) for the user, typically in email format. Useful for authentication and user identification. | |
| PrincipalType | Int | Defines the type of principal, using bitwise values: None=0, User=1, DistributionList=2, SecurityGroup=4, SharePointGroup=8, All=15. Helps categorize different types of users and groups. |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Microsoft SharePoint.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Microsoft SharePoint, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
| AddAttachment | Attaches a file to a SharePoint list item. Useful for adding supplementary documents to SharePoint records. |
| AddImage | Uploads an image to a SharePoint list item. Essential for embedding visual content in SharePoint records. |
| AddList | Creates a new SharePoint list with specified properties. Helps automate list creation for structured data storage. |
| AddListColumn | Adds a new column to an existing SharePoint list. Useful for modifying list structures dynamically. |
| AddPage | Creates a new page in the specified SharePoint page library. |
| AddRoleAssignment | Assigns a new role to a specified user or group within a SharePoint list or list item. Important for fine-tuning permissions and access. |
| AddUserToGroup | Adds a user to a specified SharePoint group to manage their access and permissions. |
| BreakRoleInheritance | Removes inherited permissions from a SharePoint list or item, making it independent from its parent permissions. Useful for restricting or customizing access at a more granular level. |
| CheckInDocument | Checks in a previously checked-out document, making it available for others to edit. Helps maintain document version control and prevents unnecessary file locks. |
| CheckOutDocument | Checks out a document from a SharePoint library, preventing others from modifying it until checked in. Useful for avoiding conflicts when multiple users are editing a file. |
| CheckPermissions | Checks the effective permissions of a specified user or group on a SharePoint list or list item. |
| CopyDocument | Copies a file from one location to another within a SharePoint document library. Facilitates content duplication and backup processes. |
| CopyFolderJob | Initiates an asynchronous copy job to replicate a SharePoint folder (and its contents) to a target location. Supports cross-site transfers, version history options, and conflict resolution behaviors. |
| CreateFolder | Creates a new folder in a specified SharePoint document library. Helps organize files within a structured hierarchy. |
| DeleteAttachment | Removes an attachment from a SharePoint list item. Useful for managing file storage and keeping lists clutter-free. |
| DeleteDocument | Deletes a document from a SharePoint document library. Helps in content cleanup and managing document lifecycle. |
| DeleteList | Permanently deletes a SharePoint list from the site. Useful when deprecating outdated or unused lists. |
| DeleteListColumn | Removes a column from an existing SharePoint list. Useful for restructuring lists and removing unnecessary fields. |
| DiscardCheckOutDocument | Cancels a document checkout, discarding any changes made while it was checked out. Helps in preventing unintended modifications. |
| GetAdminConsentURL | Generates an admin consent URL that an administrator must open to grant access to the application. Essential for configuring OAuth authentication in SharePoint. |
| GetCurrentUser | Retrieves details about the currently logged-in SharePoint user. Useful for personalizing user experiences and enforcing role-based access. |
| GetJobStatus | Polls the progress of an asynchronous SharePoint copy/move job, returning its current state, any errors, and relevant status messages. |
| MoveAttachmentOrDocument | Moves an attachment or document from one folder to another within SharePoint. Useful for reorganizing content within a document library. |
| MoveFolderJob | Initiates an asynchronous move job to relocate a SharePoint folder (and its contents) to a target location. Supports cross-site transfers, version history options, and conflict resolution behaviors. |
| RemoveRoleAssignment | Removes a specific role assignment from a SharePoint list or list item. Useful for revoking permissions when access is no longer required. |
| RemoveUserFromGroup | Removes a user from a specified SharePoint group. It is useful for revoking access when a user's role changes. |
| RenameAttachmentOrDocument | Renames an attachment or document in a SharePoint library. Useful for updating file names without affecting content. |
Attaches a file to a SharePoint list item. Useful for adding supplementary documents to SharePoint records.
| Name | Type | Required | Description |
| ListTitle | String | True | The title of the SharePoint list containing the item to which the attachment will be added. Helps identify the target list. |
| ItemId | String | True | The unique identifier of the list item to which the file will be attached. Ensures the attachment is linked to the correct item. |
| FileName | String | True | The name of the file being added as an attachment. Helps track and manage attached files. |
| InputFilePath | String | False | The full file path of the attachment to be uploaded. Required unless providing file content directly. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the attachment upload operation was successful. Returns 'true' for success and 'false' for failure. |
| RelativeUrl | String | The server-relative URL of the uploaded attachment. Useful for accessing and referencing the attached file. |
Uploads an image to a SharePoint list item. Essential for embedding visual content in SharePoint records.
| Name | Type | Required | Description |
| ListName | String | True | The display name of the SharePoint list where the image will be added. Helps identify the target list. |
| ItemId | String | True | The unique identifier of the list item to which the image will be attached. Ensures the image is linked to the correct item. |
| ColumnInternalName | String | True | The internal name of the column where the image will be stored. Useful for identifying the correct field in the list schema. |
| FileName | String | True | The name of the image file being uploaded. Helps track and manage attached images. |
| InputFilePath | String | False | The full file path of the image to be uploaded. Required unless providing the image content directly. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the image upload operation was successful. Returns 'true' for success and 'false' for failure. |
| ErrorCode | Integer | If the procedure fails, this field displays the corresponding error code. Useful for debugging and troubleshooting. |
| ErrorMessage | String | If the procedure fails, this field provides a detailed error message explaining the failure. Helps diagnose upload issues. |
Creates a new SharePoint list with specified properties. Helps automate list creation for structured data storage.
| Name | Type | Required | Description |
| Name | String | True | The name of the SharePoint list to be created. Helps identify the newly added list. |
| Template | String | False | The name or ID of the template used for creating the list. Determines the structure and default settings of the list. |
| Description | String | False | A brief description of the list being added. Helps provide context and purpose for the new list. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the list creation operation was successful. Returns 'true' for success and 'false' for failure. |
| ErrorCode | Integer | If the procedure fails, this field displays the corresponding error code. Useful for debugging and troubleshooting. |
| ErrorMessage | String | If the procedure fails, this field provides a detailed error message explaining the failure. Helps diagnose issues with list creation. |
Adds a new column to an existing SharePoint list. Useful for modifying list structures dynamically.
| Name | Type | Required | Description |
| ListName | String | True | The display name of the SharePoint list where the new column will be added. Helps identify the target list. |
| ColumnDisplayName | String | True | The display name of the column to be added. Used for presenting the column in SharePoint UI. |
| ColumnType | String | True | The data type of the new column. Valid options are defined by SharePoint’s FieldTypes, such as Text, Number, DateTime, Lookup, etc. See https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-csom/ee540543(v=office.15) for more information. |
| ColumnInternalName | String | False | The internal system name of the column. This is used for programmatic references and cannot be changed after creation. |
| IsRequired | Boolean | False | Indicates whether the column is mandatory for data entry. If true, users must provide a value when adding or editing items. |
| EnforceUniqueValues | Boolean | False | Indicates whether the column should enforce unique values. Helps prevent duplicate entries. |
| DisplayAfterCreation | Boolean | False | Indicates whether the newly added column should be displayed in the SharePoint UI immediately. Defaults to true. |
| LookupListId | String | False | If the column is a lookup field, this specifies the ID of the list containing the target data. |
| LookupFieldName | String | False | If the column is a lookup field, this specifies the display name of the field being referenced in the target list. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the column creation operation was successful. Returns 'true' for success and 'false' for failure. |
| ErrorCode | Integer | If the procedure fails, this field displays the corresponding error code. Useful for debugging and troubleshooting. |
| ErrorMessage | String | If the procedure fails, this field provides a detailed error message explaining the failure. Helps diagnose issues with column creation. |
Creates a new page in the specified SharePoint page library.
The created page will be empty and unpublished by default.
EXECUTE AddPage Title = 'My New Page'; EXECUTE AddPage PageLibrary = 'Page Library', Title = 'Welcome Page', Template = '1';
| Name | Type | Required | Description |
| PageLibrary | String | False | The title of the SharePoint document library where the new page will be created. Common default is 'Site Pages'.
The default value is Site Pages. |
| Title | String | True | The name or title of the new page to create. This will be used as the file name (for example, PageTitle.aspx). |
| Template | String | False | The type of template to use when creating the page. Values: 0 = StandardPage, 1 = WikiPage, 2 = FormPage.
The allowed values are 0, 1, 2. The default value is 0. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the page creation operation was successful. Returns 'true' if the page was created successfully. |
| RelativeUrl | String | The server-relative URL of the newly created SharePoint page (for example, /sites/demo/SitePages/PageTitle.aspx). |
Assigns a new role to a specified user or group within a SharePoint list or list item. Important for fine-tuning permissions and access.
| Name | Type | Required | Description |
| RoleId | Int | True | The unique ID of the role definition that specifies the permissions to be assigned. Determines the level of access granted. |
| PrincipalId | Int | True | The unique ID of the user or group receiving the assigned role. Helps identify who the permissions apply to. |
| List | String | True | The internal name of the SharePoint list where the role assignment will be applied. Useful for managing permissions at the list level. |
| ItemId | Int | False | The unique identifier of the list item to which the role assignment applies. Helps manage permissions at the item level. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the role assignment operation was successful. Returns 'true' for success and 'false' for failure. |
| ErrorCode | Integer | If the procedure fails, this field displays the corresponding error code. Useful for debugging and troubleshooting. |
| ErrorMessage | String | If the procedure fails, this field provides a detailed error message explaining the failure. Helps diagnose permission assignment issues. |
Adds a user to a specified SharePoint group to manage their access and permissions.
| Name | Type | Required | Description |
| LoginName | String | True | The login name of the user to be added to the SharePoint group. |
| Group | String | True | The name of the SharePoint group to which the user is added, such as 'Project Managers' or 'Site Admins.' |
| Name | Type | Description |
| Success | Boolean | Indicates whether the operation to add the user to the group was successful. Returns 'true' for success and 'false' for failure. |
Removes inherited permissions from a SharePoint list or item, making it independent from its parent permissions. Useful for restricting or customizing access at a more granular level.
| Name | Type | Required | Description |
| List | String | True | The internal name of the SharePoint list where security inheritance will be broken. Helps apply unique permissions to the list or its items. |
| ItemId | Int | False | The unique identifier of the list item for which security inheritance will be broken. Useful for setting item-level permissions. |
| CopyRoleAssignments | Boolean | False | Indicates whether the existing role assignments should be copied from the parent object. If 'true', current permissions are retained; if 'false', all permissions are removed and must be reassigned.
The default value is true. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the operation to break role inheritance was successful. Returns 'true' for success and 'false' for failure. |
| ErrorCode | Integer | If the procedure fails, this field displays the corresponding error code. Useful for debugging and troubleshooting. |
| ErrorMessage | String | If the procedure fails, this field provides a detailed error message explaining the failure. Helps diagnose security and permission issues. |
Checks in a previously checked-out document, making it available for others to edit. Helps maintain document version control and prevents unnecessary file locks.
| Name | Type | Required | Description |
| RelativeURL | String | True | The server-relative URL of the folder containing the document. Helps locate the document within the SharePoint site. |
| DocumentName | String | True | The name of the file to be checked in. Ensures the correct document is processed. |
| Comment | String | False | An optional message provided during check-in. Useful for describing changes or providing version history details. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the document check-in operation was successful. Returns 'true' for success and 'false' for failure. |
Checks out a document from a SharePoint library, preventing others from modifying it until checked in. Useful for avoiding conflicts when multiple users are editing a file.
| Name | Type | Required | Description |
| RelativeURL | String | True | The server-relative URL of the folder containing the document. Helps locate the document within the SharePoint site. |
| DocumentName | String | True | The name of the file to be checked out. Ensures the correct document is locked for editing. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the document check-out operation was successful. Returns 'true' for success and 'false' for failure. |
Checks the effective permissions of a specified user or group on a SharePoint list or list item.
| Name | Type | Required | Description |
| Principal | String | True | The login name of the user or group (e.g., 'i:0#.f|membership|[email protected]' or 'Group Name'). |
| ListName | String | True | The title of the SharePoint list (e.g., 'Documents'). |
| ItemId | Int | False | The ID of the list item to check permissions for. If not provided, the procedure checks permissions at the list level. |
| Name | Type | Description |
| Success | Boolean | Boolean flag: true if permissions were retrieved successfully; false otherwise. |
| BasePermissions_High | Long | High-order 32-bit mask representing base permissions. |
| BasePermissions_Low | Long | Low-order 32-bit mask representing base permissions. |
Copies a file from one location to another within a SharePoint document library. Facilitates content duplication and backup processes.
| Name | Type | Required | Description |
| SourceFileRelativeUrl | String | True | The server-relative URL of the source file to be copied. Specifies the original location of the document. |
| DestFileRelativeUrl | String | True | The server-relative URL where the copied file will be placed. Defines the new location of the document. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the document copy operation was successful. Returns 'true' for success and 'false' for failure. |
Initiates an asynchronous copy job to replicate a SharePoint folder (and its contents) to a target location. Supports cross-site transfers, version history options, and conflict resolution behaviors.
| Name | Type | Required | Description |
| SourceFolderUrl | String | True | URL of the folder to copy. Can be absolute (https://domain.sharepoint.com/site/mysite/Shared%20Documents/SourceFolder) or site-relative (/Shared%20Documents/SourceFolder). Must include document library name. |
| DestinationFolderUrl | String | True | URL where the folder will be copy to. Can be absolute (https://domain.sharepoint.com/site/mysite/Target) or site-relative (/Target). Parent folder must already exist. |
| AllowSchemaMismatch | Boolean | False | When true, allows the operation to proceed even if the source and destination libraries have different schemas or column configurations.
The default value is true. |
| AllowSmallerVersionLimit | Boolean | False | When true, allows moving content even if the destination library has a lower version limit than the source, which may result in version truncation.
The default value is true. |
| IgnoreVersionHistory | Boolean | False | When true, only the current version is copied. When false, preserves all version history during the copy operation.
The default value is true. |
| NameConflictBehavior | String | False | Controls handling when an item with the same name exists in the destination: FAIL (abort), REPLACE (overwrite), or RENAME (append unique suffix).
The allowed values are FAIL, REPLACE, RENAME. The default value is RENAME. |
| WaitJobToFinish | Boolean | False | When true, waits synchronously for the copy job to complete. When false, returns immediately with job tracking information for asynchronous status checks.
The default value is false. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the copy operation was initiated successfully. Returns 'true' for success and 'false' for failure. |
| JobId | String | The GUID that uniquely identifies this copy job; use this value when polling Job Progress to retrieve status updates. |
| JobQueueUri | String | The URL of the Azure Storage Queue associated with this job; the system enqueues status / progress messages there. |
| EncryptionKey | String | A Base64-encoded AES key used to decrypt status messages in the JobQueueUri for this specific job. |
| ErrorMessage | String | Contains error details if the operation fails, otherwise empty. |
Creates a new folder in a specified SharePoint document library. Helps organize files within a structured hierarchy.
| Name | Type | Required | Description |
| RelativeURL | String | True | The server-relative URL where the new folder will be created. Defines the parent directory for the new folder. |
| FolderName | String | True | The name of the new folder to be created. Helps identify and organize files within SharePoint. |
| SiteURL | String | False | The base URL of the SharePoint site where the folder should be created. If provided, this value overrides the default site URL specified in the connection properties. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the folder creation operation was successful. Returns 'true' for success and 'false' for failure. |
| Id | String | A unique identifier assigned to the newly created folder. Useful for referencing the folder in subsequent operations. |
Removes an attachment from a SharePoint list item. Useful for managing file storage and keeping lists clutter-free.
| Name | Type | Required | Description |
| ListTitle | String | True | The title of the SharePoint list containing the item from which the attachment will be deleted. Helps identify the target list. |
| ItemId | String | True | The unique identifier of the list item associated with the attachment. Ensures the correct item is targeted for deletion. |
| FileName | String | True | The name of the attachment to be deleted. Helps specify which file should be removed from the list item. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the attachment deletion operation was successful. Returns 'true' for success and 'false' for failure. |
Deletes a document from a SharePoint document library. Helps in content cleanup and managing document lifecycle.
| Name | Type | Required | Description |
| RelativePath | String | True | The server-relative path of the document to be deleted. For example: '/Shared Documents/My Folder/My Document.txt'. Specifies the exact file location. |
| Permanently | String | False | Indicates whether the document should be permanently deleted. If set to 'true', the document is permanently removed; if 'false', it is moved to the recycle bin for potential recovery.
The default value is false. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the document deletion operation was successful. Returns 'true' for success and 'false' for failure. |
| ErrorCode | Integer | If the procedure fails, this field displays the corresponding error code. Useful for debugging and troubleshooting. |
| ErrorMessage | String | If the procedure fails, this field provides a detailed error message explaining the failure. Helps diagnose document deletion issues. |
Permanently deletes a SharePoint list from the site. Useful when deprecating outdated or unused lists.
| Name | Type | Required | Description |
| Name | String | True | The name of the SharePoint list to be deleted. Identifies the target list for removal. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the list deletion operation was successful. Returns 'true' for success and 'false' for failure. |
| ErrorCode | Integer | If the procedure fails, this field displays the corresponding error code. Useful for debugging and troubleshooting. |
| ErrorMessage | String | If the procedure fails, this field provides a detailed error message explaining the failure. Helps diagnose list deletion issues. |
Removes a column from an existing SharePoint list. Useful for restructuring lists and removing unnecessary fields.
| Name | Type | Required | Description |
| ListName | String | True | The display name of the SharePoint list from which the column will be deleted. Identifies the target list. |
| ColumnName | String | True | The display name of the column to be deleted. Specifies the exact field to remove from the list. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the column deletion operation was successful. Returns 'true' for success and 'false' for failure. |
| ErrorCode | Integer | If the procedure fails, this field displays the corresponding error code. Useful for debugging and troubleshooting. |
| ErrorMessage | String | If the procedure fails, this field provides a detailed error message explaining the failure. Helps diagnose issues with column deletion. |
Cancels a document checkout, discarding any changes made while it was checked out. Helps in preventing unintended modifications.
| Name | Type | Required | Description |
| RelativeURL | String | True | The server-relative URL of the folder containing the document. Helps locate the document within the SharePoint site. |
| DocumentName | String | True | The name of the file for which the checkout will be discarded. Ensures the correct document is processed. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the discard check-out operation was successful. Returns 'true' for success and 'false' for failure. |
Generates an admin consent URL that an administrator must open to grant access to the application. Essential for configuring OAuth authentication in SharePoint.
| Name | Type | Required | Description |
| CallbackUrl | String | False | The URL where the user will be redirected after authorizing your application. This must match the Reply URL configured in the Azure AD app settings. |
| State | String | False | A value that maintains state between the authorization request and callback. Used to prevent cross-site request forgery (CSRF) attacks. |
| Scope | String | False | The permissions being requested from the administrator. Determines what level of access the application will receive.
The default value is AllSites.Manage. |
| Name | Type | Description |
| URL | String | The generated authorization URL that must be entered into a web browser by an administrator to grant consent and authorize the application. |
Retrieves details about the currently logged-in SharePoint user. Useful for personalizing user experiences and enforcing role-based access.
| Name | Type | Description |
| Id | Int | The unique identifier of the currently authenticated user in SharePoint. |
| Title | String | The display name or title associated with the currently authenticated user. |
| String | The primary email address linked to the currently authenticated user. | |
| IsSiteAdmin | Boolean | Indicates whether the user has administrative privileges on the SharePoint site. Returns 'true' for site admins and 'false' otherwise. |
Polls the progress of an asynchronous SharePoint copy/move job, returning its current state, any errors, and relevant status messages.
| Name | Type | Required | Description |
| JobId | String | True | The GUID that uniquely identifies the copy job; required to query its status. |
| JobQueueUri | String | True | The URI of the Azure Storage Queue associated with this job; status updates are enqueued here. |
| EncryptionKey | String | True | A Base64-encoded AES key used to decrypt and verify status message payloads from the queue. |
| Name | Type | Description |
| Success | Boolean | Boolean indicator: true if the job polling call succeeded; false if there was an invocation or protocol error. |
| JobState | String | Current state of the job (Queued, InProgress, Completed). |
| ErrorMessage | String | Details of any error encountered by the job; null if none. |
Moves an attachment or document from one folder to another within SharePoint. Useful for reorganizing content within a document library.
The paths specified in SourceFileURL and DestinationFolderURL must be relative to what you have used in URL. Refer to the query example below:
/* URL = https://mysite.sharepoint.com/sites/Subsite */ EXEC MoveAttachmentOrDocument SourceFileURL = '/Shared Documents/Source Folder/Subfolder/Original Document.txt', DestinationFolderURL = '/Destination Library/Destination Folder/';
| Name | Type | Required | Description |
| SourceFileURL | String | True | The relative path of the file to be moved. This path is relative to the base URL specified in the SharePoint connection properties. |
| DestinationFolderURL | String | True | The relative path of the destination folder where the file will be moved. This path is also relative to the base URL specified in the SharePoint connection properties. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the file move operation was successful. Returns 'true' for success and 'false' for failure. |
Initiates an asynchronous move job to relocate a SharePoint folder (and its contents) to a target location. Supports cross-site transfers, version history options, and conflict resolution behaviors.
| Name | Type | Required | Description |
| SourceFolderUrl | String | True | URL of the folder to move. Can be absolute (https://domain.sharepoint.com/site/mysite/Shared%20Documents/SourceFolder) or site-relative (/Shared%20Documents/SourceFolder). Must include document library name. |
| DestinationFolderUrl | String | True | URL where the folder will be move to. Can be absolute (https://domain.sharepoint.com/site/mysite/Target) or site-relative (/Target). Parent folder must already exist. |
| AllowSchemaMismatch | Boolean | False | When true, allows the operation to proceed even if the source and destination libraries have different schemas or column configurations.
The default value is true. |
| AllowSmallerVersionLimit | Boolean | False | When true, allows moving content even if the destination library has a lower version limit than the source, which may result in version truncation.
The default value is true. |
| IgnoreVersionHistory | Boolean | False | When true, only the current version is copied. When false, preserves all version history during the move operation.
The default value is true. |
| NameConflictBehavior | String | False | Controls handling when an item with the same name exists in the destination: FAIL (abort), REPLACE (overwrite), or RENAME (append unique suffix).
The allowed values are FAIL, REPLACE, RENAME. The default value is RENAME. |
| WaitJobToFinish | Boolean | False | When true, waits synchronously for the move job to complete. When false, returns immediately with job tracking information for asynchronous status checks.
The default value is false. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the move operation was initiated successfully. Returns 'true' for success and 'false' for failure. |
| JobId | String | The GUID that uniquely identifies this move job; use this value when polling Job Progress to retrieve status updates. |
| JobQueueUri | String | The URL of the Azure Storage Queue associated with this job; the system enqueues status / progress messages there. |
| EncryptionKey | String | A Base64-encoded AES key used to decrypt status messages in the JobQueueUri for this specific job. |
| ErrorMessage | String | Contains error details if the operation fails, otherwise empty. |
Removes a specific role assignment from a SharePoint list or list item. Useful for revoking permissions when access is no longer required.
| Name | Type | Required | Description |
| RoleId | Int | True | The unique identifier of the role definition to be removed from the role assignment. |
| PrincipalId | Int | True | The unique identifier of the user or group from which the role assignment will be removed. |
| List | String | True | The internal name of the SharePoint list where the role assignment exists. |
| ItemId | Int | False | The unique identifier of the list item for which the role assignment will be removed. |
| Name | Type | Description |
| Success | Boolean | Indicates whether the role assignment removal operation was successful. Returns 'true' for success and 'false' for failure. |
| ErrorCode | Integer | The error code returned if the procedure fails to execute successfully. |
| ErrorMessage | String | The error message returned if the procedure fails to execute successfully. |
Removes a user from a specified SharePoint group. It is useful for revoking access when a user's role changes.
| Name | Type | Required | Description |
| LoginName | String | True | The login name of the user to be removed from the specified SharePoint group. |
| Group | String | True | The name of the SharePoint group from which the user is removed, such as 'Project Managers' or 'Site Admins.' |
| Name | Type | Description |
| Success | Boolean | Indicates whether the user was successfully removed from the group. Returns 'true' if the operation was successful, otherwise 'false'. |
Renames an attachment or document in a SharePoint library. Useful for updating file names without affecting content.
The path specified in SourceFileURL must be relative to what you have used in URL. Refer to the query example below:
/* URL = https://mysite.sharepoint.com/sites/Subsite */ EXEC RenameAttachmentOrDocument SourceFileURL = '/Shared Documents/Source Folder/Subfolder/Original Document.txt', NewFileName = 'Renamed Document.txt';
| Name | Type | Required | Description |
| SourceFileURL | String | True | The relative path of the file or attachment to be renamed. This path is relative to the base URL specified in the SharePoint connection properties. |
| NewFileName | String | True | The new name for the file, including the file extension (such as 'UpdatedDocument.pdf'). |
| Name | Type | Description |
| Success | Boolean | Indicates whether the rename operation was successful. Returns 'true' for success and 'false' for failure. |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| AuthScheme | Specifies the authentication scheme used to connect to Microsoft SharePoint. |
| URL | Specifies the base URL of the Microsoft SharePoint site to connect to. This URL is used as the starting point for all API calls. |
| SharePointEdition | Specifies the Microsoft SharePoint edition to connect to. |
| User | Specifies the Microsoft SharePoint user account used for authentication. |
| Password | Specifies the password used to authenticate the user. |
| Property | Description |
| AzureTenant | Identifies the Microsoft SharePoint tenant being used to access data. Accepts either the tenant's domain name (for example, contoso.onmicrosoft.com ) or its directory (tenant) ID. |
| AzureEnvironment | Specifies the Azure cloud environment to use for authentication. Set this to match your Azure account’s region (Global, China, U.S. Government, or U.S. DoD cloud). |
| Property | Description |
| SSOLoginURL | The identity provider's login URL. |
| SSODomain | Specifies the user domain to use with single sign-on (SSO) authentication when it differs from the domain in the user’s login credentials. |
| SSOProperties | Additional properties required to connect to the identity provider, formatted as a semicolon-separated list. |
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Scope | Specifies the OAuth scope used to request permissions when accessing Microsoft SharePoint data. |
| State | Optional value for representing extra OAuth state information. |
| Property | Description |
| OAuthJWTCert | Supplies the name of the client certificate's JWT Certificate store. |
| OAuthJWTCertType | Identifies the type of key store containing the JWT Certificate. |
| OAuthJWTCertPassword | Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank. |
| OAuthJWTIssuer | The issuer of the Java Web Token. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Schema | Specifies the type of schema the provider uses for connecting to Microsoft SharePoint. |
| Property | Description |
| CalculatedDataType | Specifies the data type to use for calculated fields in the SOAP schema. Set this if Microsoft SharePoint returns unexpected types for calculated fields. |
| ContinueOnError | Specifies whether the provider continues processing batch updates after an error occurs. |
| CreateIDColumns | Specifies whether the provider creates supplemental ID columns for Microsoft SharePoint fields that reference values from other lists. Applies only to the SOAP schema. |
| DisableFilterLimit | Specifies whether to disable the 5000-record limit for list filters in Microsoft SharePoint REST queries. Setting this to true attempts server-side processing beyond the limit, but may result in server errors. |
| FolderOption | Specifies how the provider displays folders and files in query results when using the SOAP schema. |
| GetColumnsMetadata | Specifies when the provider retrieves column metadata for tables in the REST schema. Metadata can be loaded at startup or on first use. |
| IncludeLookupColumns | Specifies whether the provider includes lookup columns in query results when using the SOAP schema. |
| IncludeLookupDisplayValueColumns | Specifies whether the provider includes display value columns for lookup fields in query results when using the REST schema. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from Microsoft SharePoint. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| ResolveCalculatedTypes | Controls whether SharePoint calculated columns are assigned a SQL data type corresponding to the result type of their formula. |
| ShowHiddenColumns | Specifies whether the provider includes hidden columns in metadata and query results. |
| ShowPredefinedColumns | Specifies whether the provider includes predefined columns, such as system or base-type columns, in metadata and query results. |
| ShowVersionViews | Specifies whether the provider includes list version views in metadata discovery when using the SOAP schema. |
| STSURL | Specifies the URL of the security token service (STS) used for single sign-on (SSO) authentication. This property is rarely required to be set manually. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UseDisplayNames | Specifies whether the provider uses column display names instead of API names in metadata and query results. |
| UseEntityTypeName | Specifies whether the provider uses a list’s EntityTypeName as the table name during metadata discovery instead of the list’s Title field. |
| UseNTLMV1 | Specifies whether the provider uses NTLMv1 or NTLMv2 for authentication. |
| UseSimpleNames | Specifies whether or not simple names should be used for tables and columns. |
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.