WBS SharePoint, Dodeca 8.3
Methods
SharePointOperations
Downloads, uploads, and lists SharePoint documents, list items, and attachments.
Overloads
| Overload Name | Description |
|---|---|
Uploads a locally accessible file to a SharePoint site as a list item attachment. If the attachment already exists in SharePoint, it will be replaced. |
|
Uploads a locally accessible file to a SharePoint site library as a document. If the document already exists in SharePoint, a new version of the document is created. |
|
Adds a list item to a SharePoint site list. If the list item already exists in SharePoint, no action will be taken. |
|
Deletes an attachment file from a SharePoint site list item. |
|
Deletes a document from a SharePoint site library. |
|
Deletes a list item from a SharePoint site list. |
|
Downloads an attachment file from a SharePoint site list item. |
|
Downloads a document file from a SharePoint site library. |
|
Gets the list items for a given SharePoint site list and optionally retains them in a DataCache. |
|
Validates credentials by connecting to a SharePoint site, optionally setting a property value with the results. |
AddAttachment
Uploads a locally accessible file to a SharePoint site as a list item attachment. If the attachment already exists in SharePoint, it will be replaced.
| Argument | Description |
|---|---|
SiteType |
Controls the type of connection that will be used to connect to SharePoint. Online - A connection to SharePoint Online or SharePoint Office 365. OnPrem - A connection to an on-premises SharePoint server. Extranet - A connection to an externally shared on-premises SharePoint server. If a SiteType is not specified, a SharePoint online connection will be used. |
SiteUrl |
The URL of a SharePoint site, such as https://x.sharepoint.com, https://x.sharepoint.com/y. |
ListName |
The name of the SharePoint list. |
ListPath |
The path of the SharePoint list relative to the SiteUrl, which includes any intermediate subfolders. |
ListItemName |
The name of the SharePoint list item. |
AttachmentName |
The name of the SharePoint attachment to be downloaded, uploaded, or deleted. If an AttachmentName is not specified, the name of the local file will be used (if available). |
AuthenticationPolicy |
Controls the authentication mechanism used to connect to SharePoint. DefaultNetworkCredentials - Represents the authentication credentials for the current security context in which the Dodeca application is running, which is usually the Windows credentials (user name, password, and domain) of the user running the application. The DefaultNetworkCredentials is applicable only for NTLM, negotiate, and Kerberos-based authentication. SpecifiedCredentials - Uses the specified Username, Password, and Domain. OAuthCredentials - Obtains an OAuth access token with the specified ClientID and ClientSecret. OAuthPassword - Obtains an OAuth access token with the specified ClientID, Username and Password. |
ClientID |
The client ID of the OAuth application used to connect to SharePoint. |
ClientSecret |
The client secret of the OAuth application used to connect to SharePoint when using the OAuthClientSecret AuthenticationPolicy. |
Username |
The username of the credentials used to connect to SharePoint. If a Username is not specified or is invalid when using the SpecifiedCredentials AuthenticationPolicy, the following exception is thrown: "Unable to validate the user's access to the given SharePoint URL. Access was denied." |
Password |
The password of the credentials used to connect to SharePoint. If a Password is not specified or is invalid when using the SpecifiedCredentials AuthenticationPolicy, the following exception is thrown: "Unable to validate the user's access to the given SharePoint URL. Access was denied." |
Domain |
The domain of the credentials used to connect to SharePoint. The Domain is only utilized when connecting to an on-premises or extranet SharePoint server. |
LocalFilePath |
The full path of the local file to be downloaded, uploaded, or deleted. |
UseDialog |
(Optional) Whether to display a file dialog that allows the user to choose the local file to be uploaded or saved. If left blank, FALSE will be used. |
DialogFilter |
(Optional) A filter string that determines which choices that appear in the save and choose file dialogs. The following is an example of a filter string: "PDF files (*.pdf)|*.pdf|All files (*.*)|*.*" |
DialogTitle |
(Optional) A caption to use as the title of the file dialog. |
ContinueOnError |
(Optional) Controls whether to continue execution when an error occurs. By default, execution is not continued when an error occurs. |
ContinueOnItemNotFound |
(Optional) Controls whether to continue execution when a specified item is not found. By default, execution is not continued when a specified item is not found. |
CreateListItemNotFound |
(Optional) Controls whether to add the specified list item when it cannot be found. By default, the list item will not be created. |
ErrorOccurredPropertyName |
(Optional) The name of the property set to True when an error occurs. |
ItemNotFoundPropertyName |
(Optional) The name of the property set to True if the specified document, item, or attachment is not found. |
SpecifiedPathPropertyName |
(Optional) The name of the workbook script property that receives the specified local path. |
UserCancelledPropertyName |
(Optional) The name of the property set to True if the user cancels the selection of a local file. |
AddDocument
Uploads a locally accessible file to a SharePoint site library as a document. If the document already exists in SharePoint, a new version of the document is created.
| Argument | Description |
|---|---|
SiteType |
Controls the type of connection that will be used to connect to SharePoint. Online - A connection to SharePoint Online or SharePoint Office 365. OnPrem - A connection to an on-premises SharePoint server. Extranet - A connection to an externally shared on-premises SharePoint server. If a SiteType is not specified, a SharePoint online connection will be used. |
SiteUrl |
The URL of a SharePoint site, such as https://x.sharepoint.com, https://x.sharepoint.com/y. |
DocumentLibraryName |
The name of the SharePoint document library, such as 'Shared Documents'. |
DocumentLibraryPath |
The path of the SharePoint document library relative to the SiteUrl, which includes the destination folder and any intermediate subfolders. |
DocumentName |
The name of the uploaded SharePoint document to be downloaded, uploaded, or deleted. If a DocumentName is not specified, the name of the local file will be used (if available). |
AuthenticationPolicy |
Controls the authentication mechanism used to connect to SharePoint. DefaultNetworkCredentials - Represents the authentication credentials for the current security context in which the Dodeca application is running, which is usually the Windows credentials (user name, password, and domain) of the user running the application. The DefaultNetworkCredentials is applicable only for NTLM, negotiate, and Kerberos-based authentication. SpecifiedCredentials - Uses the specified Username, Password, and Domain. OAuthCredentials - Obtains an OAuth access token with the specified ClientID and ClientSecret. OAuthPassword - Obtains an OAuth access token with the specified ClientID, Username and Password. |
ClientID |
The client ID of the OAuth application used to connect to SharePoint. |
ClientSecret |
The client secret of the OAuth application used to connect to SharePoint when using the OAuthClientSecret AuthenticationPolicy. |
Username |
The username of the credentials used to connect to SharePoint. If a Username is not specified or is invalid when using the SpecifiedCredentials AuthenticationPolicy, the following exception is thrown: "Unable to validate the user's access to the given SharePoint URL. Access was denied." |
Password |
The password of the credentials used to connect to SharePoint. If a Password is not specified or is invalid when using the SpecifiedCredentials AuthenticationPolicy, the following exception is thrown: "Unable to validate the user's access to the given SharePoint URL. Access was denied." |
Domain |
The domain of the credentials used to connect to SharePoint. The Domain is only utilized when connecting to an on-premises or extranet SharePoint server. |
LocalFilePath |
The full path of the local file to be downloaded, uploaded, or deleted. |
UseDialog |
(Optional) Whether to display a file dialog that allows the user to choose the local file to be uploaded or saved. If left blank, FALSE will be used. |
DialogFilter |
(Optional) A filter string that determines which choices that appear in the save and choose file dialogs. The following is an example of a filter string: "PDF files (*.pdf)|*.pdf|All files (*.*)|*.*" |
DialogTitle |
(Optional) A caption to use as the title of the file dialog. |
ContinueOnError |
(Optional) Controls whether to continue execution when an error occurs. By default, execution is not continued when an error occurs. |
ContinueOnItemNotFound |
(Optional) Controls whether to continue execution when a specified item is not found. By default, execution is not continued when a specified item is not found. |
ErrorOccurredPropertyName |
(Optional) The name of the property set to True when an error occurs. |
ItemNotFoundPropertyName |
(Optional) The name of the property set to True if the specified document, item, or attachment is not found. |
SpecifiedPathPropertyName |
(Optional) The name of the workbook script property that receives the specified local path. |
UserCancelledPropertyName |
(Optional) The name of the property set to True if the user cancels the selection of a local file. |
AddListItem
Adds a list item to a SharePoint site list. If the list item already exists in SharePoint, no action will be taken.
| Argument | Description |
|---|---|
SiteType |
Controls the type of connection that will be used to connect to SharePoint. Online - A connection to SharePoint Online or SharePoint Office 365. OnPrem - A connection to an on-premises SharePoint server. Extranet - A connection to an externally shared on-premises SharePoint server. If a SiteType is not specified, a SharePoint online connection will be used. |
SiteUrl |
The URL of a SharePoint site, such as https://x.sharepoint.com, https://x.sharepoint.com/y. |
ListName |
The name of the SharePoint list. |
ListPath |
The path of the SharePoint list relative to the SiteUrl, which includes any intermediate subfolders. |
ListItemName |
The name of the SharePoint list item. |
AuthenticationPolicy |
Controls the authentication mechanism used to connect to SharePoint. DefaultNetworkCredentials - Represents the authentication credentials for the current security context in which the Dodeca application is running, which is usually the Windows credentials (user name, password, and domain) of the user running the application. The DefaultNetworkCredentials is applicable only for NTLM, negotiate, and Kerberos-based authentication. SpecifiedCredentials - Uses the specified Username, Password, and Domain. OAuthCredentials - Obtains an OAuth access token with the specified ClientID and ClientSecret. OAuthPassword - Obtains an OAuth access token with the specified ClientID, Username and Password. |
ClientID |
The client ID of the OAuth application used to connect to SharePoint. |
ClientSecret |
The client secret of the OAuth application used to connect to SharePoint when using the OAuthClientSecret AuthenticationPolicy. |
Username |
The username of the credentials used to connect to SharePoint. If a Username is not specified or is invalid when using the SpecifiedCredentials AuthenticationPolicy, the following exception is thrown: "Unable to validate the user's access to the given SharePoint URL. Access was denied." |
Password |
The password of the credentials used to connect to SharePoint. If a Password is not specified or is invalid when using the SpecifiedCredentials AuthenticationPolicy, the following exception is thrown: "Unable to validate the user's access to the given SharePoint URL. Access was denied." |
Domain |
The domain of the credentials used to connect to SharePoint. The Domain is only utilized when connecting to an on-premises or extranet SharePoint server. |
ContinueOnError |
(Optional) Controls whether to continue execution when an error occurs. By default, execution is not continued when an error occurs. |
ContinueOnItemNotFound |
(Optional) Controls whether to continue execution when a specified item is not found. By default, execution is not continued when a specified item is not found. |
ErrorOccurredPropertyName |
(Optional) The name of the property set to True when an error occurs. |
ItemNotFoundPropertyName |
(Optional) The name of the property set to True if the specified document, item, or attachment is not found. |
DeleteAttachment
Deletes an attachment file from a SharePoint site list item.
| Argument | Description |
|---|---|
SiteType |
Controls the type of connection that will be used to connect to SharePoint. Online - A connection to SharePoint Online or SharePoint Office 365. OnPrem - A connection to an on-premises SharePoint server. Extranet - A connection to an externally shared on-premises SharePoint server. If a SiteType is not specified, a SharePoint online connection will be used. |
SiteUrl |
The URL of a SharePoint site, such as https://x.sharepoint.com, https://x.sharepoint.com/y. |
ListName |
The name of the SharePoint list. |
ListPath |
The path of the SharePoint list relative to the SiteUrl, which includes any intermediate subfolders. |
ListItemName |
The name of the SharePoint list item. |
AttachmentName |
The name of the SharePoint attachment to be downloaded, uploaded, or deleted. If an AttachmentName is not specified, the name of the local file will be used (if available). |
AuthenticationPolicy |
Controls the authentication mechanism used to connect to SharePoint. DefaultNetworkCredentials - Represents the authentication credentials for the current security context in which the Dodeca application is running, which is usually the Windows credentials (user name, password, and domain) of the user running the application. The DefaultNetworkCredentials is applicable only for NTLM, negotiate, and Kerberos-based authentication. SpecifiedCredentials - Uses the specified Username, Password, and Domain. OAuthCredentials - Obtains an OAuth access token with the specified ClientID and ClientSecret. OAuthPassword - Obtains an OAuth access token with the specified ClientID, Username and Password. |
ClientID |
The client ID of the OAuth application used to connect to SharePoint. |
ClientSecret |
The client secret of the OAuth application used to connect to SharePoint when using the OAuthClientSecret AuthenticationPolicy. |
Username |
The username of the credentials used to connect to SharePoint. If a Username is not specified or is invalid when using the SpecifiedCredentials AuthenticationPolicy, the following exception is thrown: "Unable to validate the user's access to the given SharePoint URL. Access was denied." |
Password |
The password of the credentials used to connect to SharePoint. If a Password is not specified or is invalid when using the SpecifiedCredentials AuthenticationPolicy, the following exception is thrown: "Unable to validate the user's access to the given SharePoint URL. Access was denied." |
Domain |
The domain of the credentials used to connect to SharePoint. The Domain is only utilized when connecting to an on-premises or extranet SharePoint server. |
LocalFilePath |
The full path of the local file to be downloaded, uploaded, or deleted. |
UseDialog |
(Optional) Whether to display a file dialog that allows the user to choose the local file to be uploaded or saved. If left blank, FALSE will be used. |
DialogFilter |
(Optional) A filter string that determines which choices that appear in the save and choose file dialogs. The following is an example of a filter string: "PDF files (*.pdf)|*.pdf|All files (*.*)|*.*" |
DialogTitle |
(Optional) A caption to use as the title of the file dialog. |
ContinueOnError |
(Optional) Controls whether to continue execution when an error occurs. By default, execution is not continued when an error occurs. |
ContinueOnItemNotFound |
(Optional) Controls whether to continue execution when a specified item is not found. By default, execution is not continued when a specified item is not found. |
ErrorOccurredPropertyName |
(Optional) The name of the property set to True when an error occurs. |
ItemNotFoundPropertyName |
(Optional) The name of the property set to True if the specified document, item, or attachment is not found. |
SpecifiedPathPropertyName |
(Optional) The name of the workbook script property that receives the specified local path. |
UserCancelledPropertyName |
(Optional) The name of the property set to True if the user cancels the selection of a local file. |
DeleteDocument
Deletes a document from a SharePoint site library.
| Argument | Description |
|---|---|
SiteType |
Controls the type of connection that will be used to connect to SharePoint. Online - A connection to SharePoint Online or SharePoint Office 365. OnPrem - A connection to an on-premises SharePoint server. Extranet - A connection to an externally shared on-premises SharePoint server. If a SiteType is not specified, a SharePoint online connection will be used. |
SiteUrl |
The URL of a SharePoint site, such as https://x.sharepoint.com, https://x.sharepoint.com/y. |
DocumentLibraryName |
The name of the SharePoint document library, such as 'Shared Documents'. |
DocumentLibraryPath |
The path of the SharePoint document library relative to the SiteUrl, which includes the destination folder and any intermediate subfolders. |
DocumentName |
The name of the uploaded SharePoint document to be downloaded, uploaded, or deleted. If a DocumentName is not specified, the name of the local file will be used (if available). |
AuthenticationPolicy |
Controls the authentication mechanism used to connect to SharePoint. DefaultNetworkCredentials - Represents the authentication credentials for the current security context in which the Dodeca application is running, which is usually the Windows credentials (user name, password, and domain) of the user running the application. The DefaultNetworkCredentials is applicable only for NTLM, negotiate, and Kerberos-based authentication. SpecifiedCredentials - Uses the specified Username, Password, and Domain. OAuthCredentials - Obtains an OAuth access token with the specified ClientID and ClientSecret. OAuthPassword - Obtains an OAuth access token with the specified ClientID, Username and Password. |
ClientID |
The client ID of the OAuth application used to connect to SharePoint. |
ClientSecret |
The client secret of the OAuth application used to connect to SharePoint when using the OAuthClientSecret AuthenticationPolicy. |
Username |
The username of the credentials used to connect to SharePoint. If a Username is not specified or is invalid when using the SpecifiedCredentials AuthenticationPolicy, the following exception is thrown: "Unable to validate the user's access to the given SharePoint URL. Access was denied." |
Password |
The password of the credentials used to connect to SharePoint. If a Password is not specified or is invalid when using the SpecifiedCredentials AuthenticationPolicy, the following exception is thrown: "Unable to validate the user's access to the given SharePoint URL. Access was denied." |
Domain |
The domain of the credentials used to connect to SharePoint. The Domain is only utilized when connecting to an on-premises or extranet SharePoint server. |
LocalFilePath |
The full path of the local file to be downloaded, uploaded, or deleted. |
UseDialog |
(Optional) Whether to display a file dialog that allows the user to choose the local file to be uploaded or saved. If left blank, FALSE will be used. |
DialogFilter |
(Optional) A filter string that determines which choices that appear in the save and choose file dialogs. The following is an example of a filter string: "PDF files (*.pdf)|*.pdf|All files (*.*)|*.*" |
DialogTitle |
(Optional) A caption to use as the title of the file dialog. |
ContinueOnError |
(Optional) Controls whether to continue execution when an error occurs. By default, execution is not continued when an error occurs. |
ContinueOnItemNotFound |
(Optional) Controls whether to continue execution when a specified item is not found. By default, execution is not continued when a specified item is not found. |
ErrorOccurredPropertyName |
(Optional) The name of the property set to True when an error occurs. |
ItemNotFoundPropertyName |
(Optional) The name of the property set to True if the specified document, item, or attachment is not found. |
SpecifiedPathPropertyName |
(Optional) The name of the workbook script property that receives the specified local path. |
UserCancelledPropertyName |
(Optional) The name of the property set to True if the user cancels the selection of a local file. |
DeleteListItem
Deletes a list item from a SharePoint site list.
| Argument | Description |
|---|---|
SiteType |
Controls the type of connection that will be used to connect to SharePoint. Online - A connection to SharePoint Online or SharePoint Office 365. OnPrem - A connection to an on-premises SharePoint server. Extranet - A connection to an externally shared on-premises SharePoint server. If a SiteType is not specified, a SharePoint online connection will be used. |
SiteUrl |
The URL of a SharePoint site, such as https://x.sharepoint.com, https://x.sharepoint.com/y. |
ListName |
The name of the SharePoint list. |
ListPath |
The path of the SharePoint list relative to the SiteUrl, which includes any intermediate subfolders. |
ListItemName |
The name of the SharePoint list item. |
AuthenticationPolicy |
Controls the authentication mechanism used to connect to SharePoint. DefaultNetworkCredentials - Represents the authentication credentials for the current security context in which the Dodeca application is running, which is usually the Windows credentials (user name, password, and domain) of the user running the application. The DefaultNetworkCredentials is applicable only for NTLM, negotiate, and Kerberos-based authentication. SpecifiedCredentials - Uses the specified Username, Password, and Domain. OAuthCredentials - Obtains an OAuth access token with the specified ClientID and ClientSecret. OAuthPassword - Obtains an OAuth access token with the specified ClientID, Username and Password. |
ClientID |
The client ID of the OAuth application used to connect to SharePoint. |
ClientSecret |
The client secret of the OAuth application used to connect to SharePoint when using the OAuthClientSecret AuthenticationPolicy. |
Username |
The username of the credentials used to connect to SharePoint. If a Username is not specified or is invalid when using the SpecifiedCredentials AuthenticationPolicy, the following exception is thrown: "Unable to validate the user's access to the given SharePoint URL. Access was denied." |
Password |
The password of the credentials used to connect to SharePoint. If a Password is not specified or is invalid when using the SpecifiedCredentials AuthenticationPolicy, the following exception is thrown: "Unable to validate the user's access to the given SharePoint URL. Access was denied." |
Domain |
The domain of the credentials used to connect to SharePoint. The Domain is only utilized when connecting to an on-premises or extranet SharePoint server. |
ContinueOnError |
(Optional) Controls whether to continue execution when an error occurs. By default, execution is not continued when an error occurs. |
ContinueOnItemNotFound |
(Optional) Controls whether to continue execution when a specified item is not found. By default, execution is not continued when a specified item is not found. |
ErrorOccurredPropertyName |
(Optional) The name of the property set to True when an error occurs. |
ItemNotFoundPropertyName |
(Optional) The name of the property set to True if the specified document, item, or attachment is not found. |
GetAttachment
Downloads an attachment file from a SharePoint site list item.
| Argument | Description |
|---|---|
SiteType |
Controls the type of connection that will be used to connect to SharePoint. Online - A connection to SharePoint Online or SharePoint Office 365. OnPrem - A connection to an on-premises SharePoint server. Extranet - A connection to an externally shared on-premises SharePoint server. If a SiteType is not specified, a SharePoint online connection will be used. |
SiteUrl |
The URL of a SharePoint site, such as https://x.sharepoint.com, https://x.sharepoint.com/y. |
ListName |
The name of the SharePoint list. |
ListPath |
The path of the SharePoint list relative to the SiteUrl, which includes any intermediate subfolders. |
ListItemName |
The name of the SharePoint list item. |
AttachmentName |
The name of the SharePoint attachment to be downloaded, uploaded, or deleted. If an AttachmentName is not specified, the name of the local file will be used (if available). |
AuthenticationPolicy |
Controls the authentication mechanism used to connect to SharePoint. DefaultNetworkCredentials - Represents the authentication credentials for the current security context in which the Dodeca application is running, which is usually the Windows credentials (user name, password, and domain) of the user running the application. The DefaultNetworkCredentials is applicable only for NTLM, negotiate, and Kerberos-based authentication. SpecifiedCredentials - Uses the specified Username, Password, and Domain. OAuthCredentials - Obtains an OAuth access token with the specified ClientID and ClientSecret. OAuthPassword - Obtains an OAuth access token with the specified ClientID, Username and Password. |
ClientID |
The client ID of the OAuth application used to connect to SharePoint. |
ClientSecret |
The client secret of the OAuth application used to connect to SharePoint when using the OAuthClientSecret AuthenticationPolicy. |
Username |
The username of the credentials used to connect to SharePoint. If a Username is not specified or is invalid when using the SpecifiedCredentials AuthenticationPolicy, the following exception is thrown: "Unable to validate the user's access to the given SharePoint URL. Access was denied." |
Password |
The password of the credentials used to connect to SharePoint. If a Password is not specified or is invalid when using the SpecifiedCredentials AuthenticationPolicy, the following exception is thrown: "Unable to validate the user's access to the given SharePoint URL. Access was denied." |
Domain |
The domain of the credentials used to connect to SharePoint. The Domain is only utilized when connecting to an on-premises or extranet SharePoint server. |
LocalFilePath |
The full path of the local file to be downloaded, uploaded, or deleted. |
UseDialog |
(Optional) Whether to display a file dialog that allows the user to choose the local file to be uploaded or saved. If left blank, FALSE will be used. |
DialogFilter |
(Optional) A filter string that determines which choices that appear in the save and choose file dialogs. The following is an example of a filter string: "PDF files (*.pdf)|*.pdf|All files (*.*)|*.*" |
DialogTitle |
(Optional) A caption to use as the title of the file dialog. |
ContinueOnError |
(Optional) Controls whether to continue execution when an error occurs. By default, execution is not continued when an error occurs. |
ContinueOnItemNotFound |
(Optional) Controls whether to continue execution when a specified item is not found. By default, execution is not continued when a specified item is not found. |
ErrorOccurredPropertyName |
(Optional) The name of the property set to True when an error occurs. |
ItemNotFoundPropertyName |
(Optional) The name of the property set to True if the specified document, item, or attachment is not found. |
SpecifiedPathPropertyName |
(Optional) The name of the workbook script property that receives the specified local path. |
UserCancelledPropertyName |
(Optional) The name of the property set to True if the user cancels the selection of a local file. |
GetDocument
Downloads a document file from a SharePoint site library.
| Argument | Description |
|---|---|
SiteType |
Controls the type of connection that will be used to connect to SharePoint. Online - A connection to SharePoint Online or SharePoint Office 365. OnPrem - A connection to an on-premises SharePoint server. Extranet - A connection to an externally shared on-premises SharePoint server. If a SiteType is not specified, a SharePoint online connection will be used. |
SiteUrl |
The URL of a SharePoint site, such as https://x.sharepoint.com, https://x.sharepoint.com/y. |
DocumentLibraryName |
The name of the SharePoint document library, such as 'Shared Documents'. |
DocumentLibraryPath |
The path of the SharePoint document library relative to the SiteUrl, which includes the destination folder and any intermediate subfolders. |
DocumentName |
The name of the uploaded SharePoint document to be downloaded, uploaded, or deleted. If a DocumentName is not specified, the name of the local file will be used (if available). |
AuthenticationPolicy |
Controls the authentication mechanism used to connect to SharePoint. DefaultNetworkCredentials - Represents the authentication credentials for the current security context in which the Dodeca application is running, which is usually the Windows credentials (user name, password, and domain) of the user running the application. The DefaultNetworkCredentials is applicable only for NTLM, negotiate, and Kerberos-based authentication. SpecifiedCredentials - Uses the specified Username, Password, and Domain. OAuthCredentials - Obtains an OAuth access token with the specified ClientID and ClientSecret. OAuthPassword - Obtains an OAuth access token with the specified ClientID, Username and Password. |
ClientID |
The client ID of the OAuth application used to connect to SharePoint. |
ClientSecret |
The client secret of the OAuth application used to connect to SharePoint when using the OAuthClientSecret AuthenticationPolicy. |
Username |
The username of the credentials used to connect to SharePoint. If a Username is not specified or is invalid when using the SpecifiedCredentials AuthenticationPolicy, the following exception is thrown: "Unable to validate the user's access to the given SharePoint URL. Access was denied." |
Password |
The password of the credentials used to connect to SharePoint. If a Password is not specified or is invalid when using the SpecifiedCredentials AuthenticationPolicy, the following exception is thrown: "Unable to validate the user's access to the given SharePoint URL. Access was denied." |
Domain |
The domain of the credentials used to connect to SharePoint. The Domain is only utilized when connecting to an on-premises or extranet SharePoint server. |
LocalFilePath |
The full path of the local file to be downloaded, uploaded, or deleted. |
UseDialog |
(Optional) Whether to display a file dialog that allows the user to choose the local file to be uploaded or saved. If left blank, FALSE will be used. |
DialogFilter |
(Optional) A filter string that determines which choices that appear in the save and choose file dialogs. The following is an example of a filter string: "PDF files (*.pdf)|*.pdf|All files (*.*)|*.*" |
DialogTitle |
(Optional) A caption to use as the title of the file dialog. |
ContinueOnError |
(Optional) Controls whether to continue execution when an error occurs. By default, execution is not continued when an error occurs. |
ContinueOnItemNotFound |
(Optional) Controls whether to continue execution when a specified item is not found. By default, execution is not continued when a specified item is not found. |
ErrorOccurredPropertyName |
(Optional) The name of the property set to True when an error occurs. |
ItemNotFoundPropertyName |
(Optional) The name of the property set to True if the specified document, item, or attachment is not found. |
SpecifiedPathPropertyName |
(Optional) The name of the workbook script property that receives the specified local path. |
UserCancelledPropertyName |
(Optional) The name of the property set to True if the user cancels the selection of a local file. |
GetListItems
Gets the list items for a given SharePoint site list and optionally retains them in a DataCache.
| Argument | Description |
|---|---|
SiteType |
Controls the type of connection that will be used to connect to SharePoint. Online - A connection to SharePoint Online or SharePoint Office 365. OnPrem - A connection to an on-premises SharePoint server. Extranet - A connection to an externally shared on-premises SharePoint server. If a SiteType is not specified, a SharePoint online connection will be used. |
SiteUrl |
The URL of a SharePoint site, such as https://x.sharepoint.com, https://x.sharepoint.com/y. |
ListName |
The name of the SharePoint list. |
ListPath |
The path of the SharePoint list relative to the SiteUrl, which includes any intermediate subfolders. |
ListItemsDataCacheName |
(Optional) The name of the DataCache that will hold the names of the list items discovered under the specified list, if the specified list is found. |
AuthenticationPolicy |
Controls the authentication mechanism used to connect to SharePoint. DefaultNetworkCredentials - Represents the authentication credentials for the current security context in which the Dodeca application is running, which is usually the Windows credentials (user name, password, and domain) of the user running the application. The DefaultNetworkCredentials is applicable only for NTLM, negotiate, and Kerberos-based authentication. SpecifiedCredentials - Uses the specified Username, Password, and Domain. OAuthCredentials - Obtains an OAuth access token with the specified ClientID and ClientSecret. OAuthPassword - Obtains an OAuth access token with the specified ClientID, Username and Password. |
ClientID |
The client ID of the OAuth application used to connect to SharePoint. |
ClientSecret |
The client secret of the OAuth application used to connect to SharePoint when using the OAuthClientSecret AuthenticationPolicy. |
Username |
The username of the credentials used to connect to SharePoint. If a Username is not specified or is invalid when using the SpecifiedCredentials AuthenticationPolicy, the following exception is thrown: "Unable to validate the user's access to the given SharePoint URL. Access was denied." |
Password |
The password of the credentials used to connect to SharePoint. If a Password is not specified or is invalid when using the SpecifiedCredentials AuthenticationPolicy, the following exception is thrown: "Unable to validate the user's access to the given SharePoint URL. Access was denied." |
Domain |
The domain of the credentials used to connect to SharePoint. The Domain is only utilized when connecting to an on-premises or extranet SharePoint server. |
ContinueOnError |
(Optional) Controls whether to continue execution when an error occurs. By default, execution is not continued when an error occurs. |
ContinueOnItemNotFound |
(Optional) Controls whether to continue execution when a specified item is not found. By default, execution is not continued when a specified item is not found. |
ErrorOccurredPropertyName |
(Optional) The name of the property set to True when an error occurs. |
ItemNotFoundPropertyName |
(Optional) The name of the property set to True if the specified document, item, or attachment is not found. |
ValidateCredentials
Validates credentials by connecting to a SharePoint site, optionally setting a property value with the results.
| Argument | Description |
|---|---|
SiteType |
Controls the type of connection that will be used to connect to SharePoint. Online - A connection to SharePoint Online or SharePoint Office 365. OnPrem - A connection to an on-premises SharePoint server. Extranet - A connection to an externally shared on-premises SharePoint server. If a SiteType is not specified, a SharePoint online connection will be used. |
SiteUrl |
The URL of a SharePoint site, such as https://x.sharepoint.com, https://x.sharepoint.com/y. |
AuthenticationPolicy |
Controls the authentication mechanism used to connect to SharePoint. DefaultNetworkCredentials - Represents the authentication credentials for the current security context in which the Dodeca application is running, which is usually the Windows credentials (user name, password, and domain) of the user running the application. The DefaultNetworkCredentials is applicable only for NTLM, negotiate, and Kerberos-based authentication. SpecifiedCredentials - Uses the specified Username, Password, and Domain. OAuthCredentials - Obtains an OAuth access token with the specified ClientID and ClientSecret. OAuthPassword - Obtains an OAuth access token with the specified ClientID, Username and Password. |
ClientID |
The client ID of the OAuth application used to connect to SharePoint. |
ClientSecret |
The client secret of the OAuth application used to connect to SharePoint when using the OAuthClientSecret AuthenticationPolicy. |
Username |
The username of the credentials used to connect to SharePoint. If a Username is not specified or is invalid when using the SpecifiedCredentials AuthenticationPolicy, the following exception is thrown: "Unable to validate the user's access to the given SharePoint URL. Access was denied." |
Password |
The password of the credentials used to connect to SharePoint. If a Password is not specified or is invalid when using the SpecifiedCredentials AuthenticationPolicy, the following exception is thrown: "Unable to validate the user's access to the given SharePoint URL. Access was denied." |
Domain |
The domain of the credentials used to connect to SharePoint. The Domain is only utilized when connecting to an on-premises or extranet SharePoint server. |
ContinueOnError |
(Optional) Controls whether to continue execution when an error occurs. By default, execution is not continued when an error occurs. |
ErrorOccurredPropertyName |
(Optional) The name of the property set to True when an error occurs. |