Arguments

Name	Description	Default
title R	The title or the id of the list
fileName R	The relative path and file name
overrideFile R	Set to true to override the file
content R	A binary stream of data to save as a document

SQL Call

EXEC sharepoint.AddDocument 'mylist1', 'myfilename', false, 0x001122334455

Http Call

/bsc/sharepoint/adddocument

Output Columns

This call does not return data.

Arguments

Name	Description	Default
title R	The title or id of the list
name R	The name of the field to add
type	The type of the field (Number, Currency, Guid, URL, User, Choice, Text, Note, DateTime)	Text
defaultValue	A default value for the field
options	Options specific to the field type (currency: a valid LCID (locale id); datetime: date, datetime; note: richtext, plaintext; text: max length (int); url:image, hyperlink; choice: list of comma-separated values; user: peopleonly, peopleandgroups)
unique	Sets the unique flag for this field (0=no, 1=yes)	False
required	Sets the required flag for this field (0=no, 1=yes)	False

SQL Call

EXEC SharePoint.AddField 'mylist', 'fieldname', '' 

Http Call

/bsc/sharepoint/addfield

Output Columns

This call does not return data.

Arguments

Name	Description	Default
name R	The name of the group
userInfo R	The Email or LoginName of an existing user
noError	True to silence errors	False

SQL Call

EXEC SharePoint.AddGroupUser 'owners', 'email_or_loginname' 
INTO INTO sharepoint.GroupUsers VALUES ('owners', 'email_or_loginname') 

Http Call

/bsc/sharepoint/addgroupuser

Output Columns

This call does not return data.

Arguments

SQL Call

INSERT INTO SharePoint.list@mylist (col1, cole2) VALUES (123, 'abc')

Http Call

/bsc/sharepoint/addlistitem

Output Columns

This call does not return data.

Arguments

Name	Description	Default
filePath R	The full path to the file(s) to mark (including the name of the file, or a file pattern)
userId	The user id for which to mark the files (optional)
afterDateTime	Date filter
includeSubdirectories	1 to include subdirectories	False
isUTC	1 to indicate the date filter is in UTC	False
maxCount	Max number of records to return	0

SQL Call

EXEC SharePoint.AddMarkedLocalFiles 'filePath'
EXEC SharePoint.AddMarkedLocalFiles 'filePath', 'userId'

Http Call

/bsc/sharepoint/addmarkedlocalfiles

Output Columns

This call does not return data.

Arguments

Name	Description	Default
filePath R	The full path to the file to mark (including the name of the file)
tmpFile	The TMP file name to use if already downloaded (if not provided, will attempt to download the file)
userId	The user id for which to mark the files (optional)

SQL Call

EXEC SharePoint.AddMarkedTMPDocument 'filePath'
EXEC SharePoint.AddMarkedTMPDocument 'filePath', 'tmpFileName'
EXEC SharePoint.AddMarkedTMPDocument 'filePath', 'tmpFileName', 'userId'

Http Call

/bsc/sharepoint/addmarkedtmpdocument

Output Columns

This call does not return data.

Arguments

Name	Description	Default
subSite	The name of the site/subsite/ (leave blank for current site)
name R	The name of the group
roleNames	A comma-separated list of roles to assign to the group	Contributor

SQL Call

EXEC SharePoint.AddGroupToSite '/site/subsite/', 'myGroup1', 'View Only' 

Http Call

/bsc/sharepoint/addsitepermissions

Output Columns

This call does not return data.

Arguments

Name	Description	Default
title R	The title or the id of the list
fileName R	The relative path and file name
overrideFile R	Set to true to override the file
content R	A string to save as a document

SQL Call

EXEC sharepoint.AddDocument 'mylist1', 'myfilename', false, 'hello'

Http Call

/bsc/sharepoint/addtextdocument

Output Columns

This call does not return data.

Arguments

Name	Description	Default
subSite	The name of the site/subsite/ (leave blank for current site)

SQL Call

EXEC SharePoint.BreakSiteRoleInheritence '/site/subsite/'

Http Call

/bsc/sharepoint/breaksiteroleinheritence

Output Columns

This call does not return data.

Arguments

Name	Description	Default
title	The title or the id of the list (send null to clear the cache for all lists)

SQL Call

EXEC sharepoint.ClearFieldCache 'mylist1'

Http Call

/bsc/sharepoint/clearfieldcache

Output Columns

This call does not return data.

Arguments

Name	Description	Default
userId	The user id for which to unmark the files (optional)

SQL Call

EXEC SharePoint.ClearMarkedDocuments
EXEC SharePoint.ClearMarkedDocuments 'userId'

Http Call

/bsc/sharepoint/clearmarkeddocuments

Output Columns

This call does not return data.

Arguments

Name	Description	Default
title R	The title or the id of the list
folderName R	The name of the folder

SQL Call

EXEC sharepoint.CreateFolder 'mylist1', 'myfolder'

Http Call

/bsc/sharepoint/createfolder

Output Columns

This call does not return data.

Arguments

Name	Description	Default
groupName R	The name of the group
description	The description of the group

SQL Call

EXEC SharePoint.CreateGroup 'myGroup1' 

Http Call

/bsc/sharepoint/creategroup

Output Columns

This call does not return data.

Arguments

Name	Description	Default
title R	The title of the list
template R	The template to use (GenericList, DocumentLibrary, Survey, Links, Announcements, Contacts, Posts, Events, Tasks, PictureLibrary... (See ListTemplateType SharePoint object type for reference))
description	The description of the list

SQL Call

EXEC SharePoint.CreateList 'Test List', 'Posts', 'This is a test list' 

Http Call

/bsc/sharepoint/createlist

Output Columns

This call does not return data.

Arguments

Name	Description	Default
siteUrl R	The relative path of the new site
title R	Friendly name of the new site
description R	Description of the site
template	The site template to use (STS#0 (default),STS#1,STS#2,MSP#0,WIKI#0...)	STS#0
inheritPermission	1 to inherit permission (default: 1)	True
language	The language code (default: 1033)	1033

SQL Call

EXEC SharePoint.CreateSite '/subsite1/testsite', 'My Test Site', 'A description', 'STS#0', 1, 1033 

Http Call

/bsc/sharepoint/createsite

Output Columns

This call does not return data.

Arguments

Name	Description	Default
title R	The title or the id of the list
fileName R	The relative path and file name

SQL Call

EXEC sharepoint.DeleteDocument 'mylist1', 'myfilename'

Http Call

/bsc/sharepoint/deletedocument

Output Columns

This call does not return data.

Arguments

Name	Description	Default
title R	The title or id of the list
fieldName R	The Title, Internal Name or Id of the field

SQL Call

EXEC SharePoint.DeleteField 'mylist', 'myproperty'

Http Call

/bsc/sharepoint/deletefield

Output Columns

This call does not return data.

Arguments

Name	Description	Default
title R	The title or the id of the list
folderName R	The name of the folder

SQL Call

EXEC sharepoint.DeleteFolder 'mylist1', 'myfolder'

Http Call

/bsc/sharepoint/deletefolder

Output Columns

This call does not return data.

Arguments

Name	Description	Default
groupName R	The name of the group

SQL Call

EXEC SharePoint.DeleteGroup 'myGroup1' 

Http Call

/bsc/sharepoint/deletegroup

Output Columns

This call does not return data.

Arguments

Name	Description	Default
title R	The title or the id of the list

SQL Call

EXEC SharePoint.DeleteList 'Test List'

Http Call

/bsc/sharepoint/deletelist

Output Columns

This call does not return data.

Arguments

SQL Call

DELETE FROM SharePoint.list@mylist WHERE id=1

Http Call

/bsc/sharepoint/deletelistitem

Output Columns

This call does not return data.

Arguments

Name	Description	Default
name R	The name of the list to delete an item from
where	A SQL WHERE clause that identifies the records to be deleted (fields are case sensitive)

SQL Call

EXEC SharePoint.DeleteListItemRaw 'mylist', 'ID=10'

Http Call

/bsc/sharepoint/deletelistitemraw

Output Columns

This call does not return data.

Arguments

Name	Description	Default
siteUrl R	The relative path of the site to delete

SQL Call

EXEC SharePoint.DeleteSite '/subsite1/testsite'

Http Call

/bsc/sharepoint/deletesite

Output Columns

This call does not return data.

Arguments

Name	Description	Default
title R	The title or the id of the list
fileName R	The relative path and file name
timeout	Operation timeout in minutes	0
downloadPath	Specify a directory path in which to download the file; if not provided the file will be downloaded in the Enzo TMP directory
override	Use 1 when okay to override file	False

SQL Call

EXEC SharePoint.DownloadDocument '/subsite/mylist1', '/subfolder/myfilename'
EXEC SharePoint.DownloadDocument '/subsite/mylist1', '/subfolder/myfilename', 0, 'c:	mp'

Http Call

/bsc/sharepoint/downloaddocument

Output Columns

String fileURL	The full path to the file downloaded
String tmpFileName	The temporary file name that contains the file
Int64 bytesTx	Total bytes transferred
Double elapsedSec	Total seconds elapsed during the transfer

Arguments

Name	Description	Default
downloadPath	Specify a directory path in which to download the marked documents; if not provided the documents will be downloaded in the Enzo TMP directory
timeout	Operation timeout in minutes	0
override	When true overrides files if they exist	False
resendAll	When true resends all marked documents even if previously downloaded	False
userId	The user Id to use (optional)

SQL Call

EXEC SharePoint.DownloadMarkedDocuments

Http Call

/bsc/sharepoint/downloadmarkeddocuments

Output Columns

This call does not return data.

Arguments

SQL Call

EXEC SharePoint.GetContext

Http Call

/bsc/sharepoint/getcontext

Output Columns

String url	The URL of a SharePoint site
String userName	The user name used to connect

Arguments

Name	Description	Default
Library	The title of the list
Folder	The name of the folder to inspect. Send null to return all documents and folders from the root
Recursive	True if the query should include all documents below the folder provided	False
mark	True if the query should also mark the items for download	False

SQL Call

EXEC SharePoint.GetDocuments 'Documents' 
SELECT * FROM SharePoint.Documents@MyDocuments
SELECT * FROM SharePoint.[Documents@subsite/MyDocuments]

Http Call

/bsc/sharepoint/getdocuments

Output Columns

String Library	The name of the document library
String Folder	The folder name
Boolean Recursive	1 when recursive
Boolean mark
String ID	The id of the file
String ContentType	The content type for this item
String Name	The name of the file
String CreatedBy	The login of the user that last modified the file
String ModifiedBy	The login of the user that last modified the file
DateTime Created	The modified datetime of the file
DateTime Modified	The modified datetime of the file
String File Size	The size of the file
String ServerRelativeUrl	The server relative URL of the file

Arguments

Name	Description	Default
title R	The title or id of the list
fieldName R	The Title, Internal Name or Id of the field

SQL Call

EXEC SharePoint.GetFieldByTitle 'mylist', 'Body'

Http Call

/bsc/sharepoint/getfield

Output Columns

This call does not return data.

Arguments

Name	Description	Default
title R	The title or id of the list

SQL Call

EXEC SharePoint.GetFields 'mylist'
SELECT * FROM SharePoint.Fields WHERE Title = 'mylist'

Http Call

/bsc/sharepoint/getfields

Output Columns

This call does not return data.

Arguments

Name	Description	Default
Title R	The name of the list to query
folder	The name of the folder (null to retrieve all folders)

SQL Call

EXEC SharePoint.GetFoldersWithRoles 

Http Call

/bsc/sharepoint/getfolderswithroles

Output Columns

String id	Item Id
String Title	The name of the list
String Folder	The name of the folder
String serverRelativeUrl	Folder path
String roleAssignments	Roles assigned to the folder
Boolean hasUniqueRoleAssignments	True if folder has unique role assignments

Arguments

SQL Call

EXEC SharePoint.GetGroups
SELECT * FROM sharepoint.Groups 

Http Call

/bsc/sharepoint/getgroups

Output Columns

String id	The group id
String title	The group name
String description	The group description
String userCount	Number of users that are part of this group

Arguments

Name	Description	Default
name R	The name of the group

SQL Call

EXEC SharePoint.GetGroupUsers 'owners' 
SELECT * FROM sharepoint.GroupUsers WHERE name = 'owners' 

Http Call

/bsc/sharepoint/getgroupusers

Output Columns

String groupId	The group id
String groupTitle	The group name
String loginName	The login name of the user
String email	The email of the user
String userTitle	The name of the user

Arguments

Name	Description	Default
name R	The name of the list
changeType	The type of change to filter on (add, delete, update). Leave blank to return all changes.
changeToken	The last change token retrieved previously to retrieve changes from this point on. Leave blank for all changes.

SQL Call

EXEC SharePoint.GetListChanges 

Http Call

/bsc/sharepoint/getlistchanges

Output Columns

Int32 itemId	The list item id
DateTime dateChanged	The datetime of the change
String changeType	The type of change
String changeToken	The change token for this modification

Arguments

Name	Description	Default
viewName	The name of the view to use. By default uses the default view.

SQL Call

SELECT * FROM SharePoint.list@mylist1
SELECT * FROM SharePoint.list@mylist1 WHERE viewname = 'myview'
SELECT ID, Title, Age, State FROM SharePoint.list@mylist1 WHERE State in ('Florida', 'New York') OR Age > 25

Http Call

/bsc/sharepoint/getlistitems

Output Columns

This call does not return data.

Arguments

Name	Description	Default
viewName R	The name of the view to use. By default uses the default view.
columns	A case-sensitive list of columns to return. Send an empty string, or *, to return all columns.	*
where	A SQL where clause that is used to filter the output
top	Maximum number of records to return	0

SQL Call

EXEC SharePoint.GetListItemsEx 'mylist1', '*', 'ID=5'

Http Call

/bsc/sharepoint/getlistitemsex

Output Columns

This call does not return data.

Arguments

Name	Description	Default
userId	The user id that marked the files (optional)

SQL Call

EXEC SharePoint.GetMarkedDocuments
EXEC SharePoint.GetMarkedDocuments 'sessionid'
SELECT * FROM SharePoint.MarkedDocuments WHERE session = 'sessionid'

Http Call

/bsc/sharepoint/getmarkeddocuments

Output Columns

String userId
String sourceFile
String fileName
Boolean processed
String status
String tmpFileName
Int64 bytes
Single txPct
String errorMsg

Arguments

Name	Description	Default
subSite	The name of the site/subsite/ (leave blank for current site)

SQL Call

EXEC SharePoint.GetRoles '/site/subsite/' 

Http Call

/bsc/sharepoint/getroles

Output Columns

Int32 id	The role Id
String name	The role name
String description	The role description

Arguments

Name	Description	Default
subSite	The name of the site/subsite/	/

SQL Call

EXEC SharePoint.GetSitePermissions '/site/subsite/' 

Http Call

/bsc/sharepoint/getsitepermissions

Output Columns

String subSite	The name of the site
String name	The principal name
String roleNames	List of permission levels

Arguments

Name	Description	Default
name	The user email or user name

SQL Call

EXEC SharePoint.GetUserGroups 'user@email.com' 
SELECT * FROM sharepoint.usergroups WHERE email = 'user@email.com' 

Http Call

/bsc/sharepoint/getusergroups

Output Columns

String name	The user email or LoginName
String userName	The user name
String email	The email of the user
String userPrincipalName	The UPN of the user
String groupId	The group Id the user belongs to
String groupName	Group the user belongs to

Arguments

Name	Description	Default
title R	The title of the list
folder	The path to the folder (for Document lists)

SQL Call

EXEC SharePoint.GetUserPermissions '/TeamSite/Documents/Personal/2016', 'user@domain.com' 

Http Call

/bsc/sharepoint/getuserpermissions

Output Columns

String title	The name of the list
String folder	The folder (for Document lists)
String loginName	The login name of the user
String role	The role name

Arguments

Name	Description	Default
id
Title
email
LoginName
IsSiteAdmin
PrincipalType
NameId
NameIdIssuer
Groups

SQL Call

EXEC SharePoint.GetUsers 
SELECT * FROM sharepoint.users WHERE email = 'user@email.com' 

Http Call

/bsc/sharepoint/getusers

Output Columns

String id	The user id
String Title	The user name
String email	The user email address
String LoginName	The login name
Boolean IsSiteAdmin	True if the user is a site admin
String PrincipalType	The principal type
String NameId	The NameId of the user
String NameIdIssuer	The NameIdIssuer of the user
String Groups	Comma-separated list of groups the user belongs to

Arguments

Name	Description	Default
title	The subsite/title or the Id of the list (optional)

SQL Call

SELECT * FROM SharePoint.lists 

Http Call

/bsc/sharepoint/lists

Output Columns

String Id
String Title
String Description
DateTime Created
String BaseType
String DefaultView
Boolean VersioningEnabled
Boolean ForceCheckout
Boolean Hidden
Int64 ItemCount

Arguments

Name	Description	Default
name R	The name of the group
userInfo R	The Email or LoginName of an existing user
noError	True to silence errors	False

SQL Call

EXEC SharePoint.RemoveGroupUser 'owners', 'email_or_loginname' 
DELETE FROM sharepoint.GroupUsers WHERE name='owners' and userInfo='email_or_loginname') 

Http Call

/bsc/sharepoint/removegroupuser

Output Columns

This call does not return data.

Arguments

Name	Description	Default
filePath R	The full path to the file to remove (including the name of the file)
userId	The user id for which to unmark the files (optional)

SQL Call

EXEC SharePoint.RemoveMarkedDocument 'filePath'
EXEC SharePoint.RemoveMarkedDocument 'filePath', 'userId'

Http Call

/bsc/sharepoint/removemarkeddocument

Output Columns

This call does not return data.

Arguments

Name	Description	Default
subSite	The name of the site/subsite/ (leave blank for current site)
name R	The name of the group
roleNames	A comma-separated list of roles to remove from the group	Contributor

SQL Call

EXEC SharePoint.RemoveGroupPermissions '/site/subsite/', 'myGroup1', 'Edit' 

Http Call

/bsc/sharepoint/removesitepermissions

Output Columns

This call does not return data.

Arguments

Name	Description	Default
title R	The title or the id of the list
folderName R	The name of the folder
newFolderName R	The name of the folder

SQL Call

EXEC sharepoint.UpdateFolder 'mylist1', 'myfolder', 'newfoldername'

Http Call

/bsc/sharepoint/renamefolder

Output Columns

This call does not return data.

Arguments

SQL Call

SELECT * FROM SharePoint.sites

Http Call

/bsc/sharepoint/sites

Output Columns

String id
String title
String description
DateTime created
String siteUrl
Boolean hasUniqueRoleAssignments

Arguments

SQL Call

UPDATE SharePoint.list@mylist SET col1 = 123 WHERE id=2

Http Call

/bsc/sharepoint/updatelistitem

Output Columns

This call does not return data.

Arguments

Name	Description	Default
siteUrl R	The relative path of the site
title	Friendly name of the new site (send null to leave the name unchanged)
description	Description of the site (send null to leave the description unchanged)

SQL Call

EXEC SharePoint.UpdateSite '/subsite1/testsite', 'My new site name', 'A new description' 

Http Call

/bsc/sharepoint/updatesite

Output Columns

This call does not return data.

Arguments

Name	Description	Default
sourceFileName R	The name of the source (or TMP) file
title R	The name of the document library (includes subsite path)
fileName R	The file name to create (includes the folder; folder must exist)
override	Use 1 when okay to override file	False
timeout	Operation timeout in minutes	0

SQL Call

EXEC SharePoint.UploadDocument 'TMPFILE.tmp', '/subsite/mylist1', '/folder1/myfilename.txt'
EXEC SharePoint.UploadDocument 'c:\files\myfile.txt', '/subsite/mylist1', '/folder1/myfilename.txt'

Http Call

/bsc/sharepoint/uploaddocument

Output Columns

String fileURL	The file name created in SharePoint
Int64 bytesTx	Total bytes transferred
Double elapsedSec	Total seconds elapsed during the transfer

Arguments

Name	Description	Default
library R	Name of the destination document library, including subsites (ex: /subsite/MyDocuments/)
folder	Name of the destination folder (leave blank for root)
override	When true overrides destination files if they exist	False
resendAll	When true resends all marked documents even if previously sent	False
userId	The user Id to use (optional)

SQL Call

EXEC SharePoint.UploadMarkedDocuments

Http Call

/bsc/sharepoint/uploadmarkeddocuments

Output Columns

This call does not return data.

Arguments

Name	Description	Default
name R	The name of the list
data	An XML string or a JSon document or array (fields are case sensitive)
uid	The unique key of the table (if missing, the data will be inserted)

SQL Call

EXEC SharePoint.UpsertListItemRaw 'mylist', '74fc1087-d1d9-4841-a2ad-27c9adc1b5aa', 'uid'

Http Call

/bsc/sharepoint/upsertlistitemraw

Output Columns

This call does not return data.

Arguments

SQL Call

SELECT * FROM SharePoint.webapplication 

Http Call

/bsc/sharepoint/webapplication

Output Columns

String Id
String Title
String Description
DateTime Created
String URL

Arguments

Name	Description	Default
title R	The title or the id of the list
fileName R	The relative path and file name

SQL Call

EXEC sharepoint.GetDocument 'mylist1', 'myfilename'

Http Call

/bsc/sharepoint/getdocument

Output Columns

Object content	The content of the file
String etag	The eTag of the file

Arguments

Name	Description	Default
url R	The relative path of the document in SharePoint

SQL Call

EXEC sharepoint.GetDocumentAt '/mylist1/folder/myfilename.txt'

Http Call

/bsc/sharepoint/getdocumentat

Output Columns

Object content	The content of the file
String etag	The eTag of the file

Arguments

Name	Description	Default
title R	The title or the id of the list
fileName R	The relative path and file name

SQL Call

EXEC sharepoint.GetTextDocument 'mylist1', 'myfilename'

Http Call

/bsc/sharepoint/gettextdocument

Output Columns

String content	The content of the file as a text file
String etag	The eTag of the file

Arguments

Name	Description	Default
url R	The relative path of the document in SharePoint

SQL Call

EXEC sharepoint.GetTextDocumentAt '/mylist1/folder/myfilename.txt'

Http Call

/bsc/sharepoint/gettextdocumentat

Output Columns

Object content	The content of the file
String etag	The eTag of the file