Tableau Connector for Microsoft SharePoint

Build 25.0.9434

AddListColumn

Adds a new column to an existing SharePoint list. Useful for modifying list structures dynamically.

Input

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.

Result Set Columns

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.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434