SSIS Components for Microsoft SharePoint

Build 25.0.9434

AddListColumn

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

Input

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.

Result Set Columns

Name Type Description
Success Boolean Indicates whether the column creation operation was successful. Returns 'true' for success and 'false' for failure.

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