Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the driver 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.

CData ODBC Driver for Microsoft SharePoint Stored Procedures


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.
DownloadAttachment	Downloads an attachment from a SharePoint list item. Useful for accessing and retrieving necessary documents.
DownloadDocument	Downloads a document from a SharePoint document library. Allows users to obtain offline copies or process documents externally.
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.
GetOAuthAccessToken	Obtains an OAuth access token required for authentication with SharePoint. Necessary for making authenticated API requests.
GetOAuthAuthorizationURL	Generates the SharePoint authorization URL needed for OAuth authentication. Helps users grant permissions to third-party applications.
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.
RefreshOAuthAccessToken	Renews an expired OAuth access token for continued authentication with SharePoint. Helps maintain uninterrupted access to SharePoint services.
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.
UploadDocument	Uploads a document to a SharePoint document library. Essential for adding new files to SharePoint for collaboration and storage.