SharePoint.BuildingBlocks.Fields
Building blocks to manage list- and site-fields.
Delete Field
Deletes the given field on the given list and / or site. Internal name or title of the field must be given. First checks if a field can be retrieved with the given internal name, if not with the title.
Input Fields
| Name | Required? | Description |
|---|---|---|
| Action When List Not Empty | optional | Action to do when the list is not empty. Ff the list contains field values for this field those can be lost permanently when deleting this field. Default the field deletion will be skipped when the list is not empty. |
| Internal Name | required | The internal name of the field. Avoid the use of special characters, use them in the field 'Title' instead. |
| Is Site Column | optional | If set to true, this field will be added as a site column. If a list is provided, the field will first be added as a site column and afterwards as a site field to the list. If the field already exists on the list an error will occur. |
| List | optional | The GUID, internal name or title of the list on which the field is added. First the list will be retrieved by the GUID, then the internal name and lastly the title. |
| Title | required | Display name of the field. |
| Url | optional | The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'. |
Ensure Calculated Field
Ensures the given calculated field on the given list. If the field already exists it is updated with the given properties (where possible). First checks if a field exists with the given internal name, if not with the title.
Input Fields
| Name | Required? | Description |
|---|---|---|
| Add To Content Types | optional | If set to true, the field will be added to content types existing on that list. The advanced list setting 'enable content types' will be activated on that list. |
| Add To Default View | optional | If set to true, the field is added to the default view. Will be ignored if the field already exists. |
| Custom Formatter | optional | The custom JSON formatting on the field. Documentation about the custom JSON formatting can be found in the official Microsoft documentation: https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/column-formatting This is only supported in SharePoint Online. |
| Description | optional | Description of the field. |
| Formula | required | Specifies the formula for the calculated field. For the syntax, consult the official Microsoft documentation: https://support.microsoft.com/en-us/office/examples-of-common-formulas-in-lists-d81f5f21-2b4e-45ce-b170-bf7ebf6988b3 |
| Group | optional | Name of the group to which the field will be added. Only applicable in the case of a site column. |
| Hidden | optional | If set to true, the field is hidden. |
| Internal Name | required | The internal name of the field. Avoid the use of special characters, use them in the field 'Title' instead. |
| Is Site Column | optional | If set to true, this field will be added as a site column. If a list is provided, the field will first be added as a site column and afterwards as a site field to the list. If the field already exists on the list an error will occur. |
| List | optional | The GUID, internal name or title of the list on which the field is added. First the list will be retrieved by the GUID, then the internal name and lastly the title. |
| Result Type | required | The type of the result returned by the formula. |
| Show In Display Form | optional | Specifies if this field is shown in the display form. |
| Show In Edit Form | optional | Specifies if this field is shown in the edit form. |
| Show In New Form | optional | Specifies if this field is shown in the new form. |
| Title | required | Display name of the field. |
| Url | optional | The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'. |
Ensure Choice Field
Ensures the given choice field on the given list. If the field already exists it is updated with the given properties (where possible). First checks if a field exists with the given internal name, if not with the title.
Input Fields
| Name | Required? | Description |
|---|---|---|
| Add To Content Types | optional | If set to true, the field will be added to content types existing on that list. The advanced list setting 'enable content types' will be activated on that list. |
| Add To Default View | optional | If set to true, the field is added to the default view. Will be ignored if the field already exists. |
| Allow Fill In Choices | optional | If set to true, custom choiced can be provided. |
| Choice Format | required | Defines how the configured choices are displayed. |
| Configured Choices | required | Defines the available choices in the field. Choices need to be seperated with a semicolon. |
| Custom Formatter | optional | The custom JSON formatting on the field. Documentation about the custom JSON formatting can be found in the official Microsoft documentation: https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/column-formatting This is only supported in SharePoint Online. |
| Default Value | optional | Default value of the field. |
| Description | optional | Description of the field. |
| Enforce Unique Values | optional | If set to true, unique values are required to be entered for the field. |
| Group | optional | Name of the group to which the field will be added. Only applicable in the case of a site column. |
| Hidden | optional | If set to true, the field is hidden. |
| Indexed | optional | If set to true, the field will be added as an index on the list. Ignored when multiple values are allowed. |
| Internal Name | required | The internal name of the field. Avoid the use of special characters, use them in the field 'Title' instead. |
| Is Site Column | optional | If set to true, this field will be added as a site column. If a list is provided, the field will first be added as a site column and afterwards as a site field to the list. If the field already exists on the list an error will occur. |
| List | optional | The GUID, internal name or title of the list on which the field is added. First the list will be retrieved by the GUID, then the internal name and lastly the title. |
| Read Only | optional | If set to true, the field becomes read only. |
| Required | optional | Specifies if this field is required to be filled in in the list. |
| Show In Display Form | optional | Specifies if this field is shown in the display form. |
| Show In Edit Form | optional | Specifies if this field is shown in the edit form. |
| Show In New Form | optional | Specifies if this field is shown in the new form. |
| Title | required | Display name of the field. |
| Url | optional | The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'. |
Ensure Currency Field
Ensures the given currency field on the given list. If the field already exists it is updated with the given properties (where possible). First checks if a field exists with the given internal name, if not with the title.
Input Fields
| Name | Required? | Description |
|---|---|---|
| Add To Content Types | optional | If set to true, the field will be added to content types existing on that list. The advanced list setting 'enable content types' will be activated on that list. |
| Add To Default View | optional | If set to true, the field is added to the default view. Will be ignored if the field already exists. |
| Custom Formatter | optional | The custom JSON formatting on the field. Documentation about the custom JSON formatting can be found in the official Microsoft documentation: https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/column-formatting This is only supported in SharePoint Online. |
| Default Value | optional | Default value of the field. |
| Description | optional | Description of the field. |
| Enforce Unique Values | optional | If set to true, unique values are required to be entered for the field. |
| Format Culture (LCID) | required | Specifies the language code identifier (LCID) used to format the value of the field. Accepted values: https://msdn.microsoft.com/en-us/library/ms912047. Example: 1033 for English (United States). |
| Group | optional | Name of the group to which the field will be added. Only applicable in the case of a site column. |
| Hidden | optional | If set to true, the field is hidden. |
| Indexed | optional | If set to true, the field will be added as an index on the list. Ignored when multiple values are allowed. |
| Internal Name | required | The internal name of the field. Avoid the use of special characters, use them in the field 'Title' instead. |
| Is Site Column | optional | If set to true, this field will be added as a site column. If a list is provided, the field will first be added as a site column and afterwards as a site field to the list. If the field already exists on the list an error will occur. |
| List | optional | The GUID, internal name or title of the list on which the field is added. First the list will be retrieved by the GUID, then the internal name and lastly the title. |
| Maximum Value | optional | Specifies the maximum allowed value for the field. |
| Minimum Value | optional | Specifies the minimum allowed value for the field. |
| Number Of Decimal Places | required | Specifies the amount of decimal places. |
| Read Only | optional | If set to true, the field becomes read only. |
| Required | optional | Specifies if this field is required to be filled in in the list. |
| Show In Display Form | optional | Specifies if this field is shown in the display form. |
| Show In Edit Form | optional | Specifies if this field is shown in the edit form. |
| Show In New Form | optional | Specifies if this field is shown in the new form. |
| Title | required | Display name of the field. |
| Url | optional | The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'. |
Ensure DateTime Field
Ensures the given datetime field on the given list. If the field already exists it is updated with the given properties (where possible). First checks if a field exists with the given internal name, if not with the title.
Input Fields
| Name | Required? | Description |
|---|---|---|
| Add To Content Types | optional | If set to true, the field will be added to content types existing on that list. The advanced list setting 'enable content types' will be activated on that list. |
| Add To Default View | optional | If set to true, the field is added to the default view. Will be ignored if the field already exists. |
| Custom Formatter | optional | The custom JSON formatting on the field. Documentation about the custom JSON formatting can be found in the official Microsoft documentation: https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/column-formatting This is only supported in SharePoint Online. |
| DateTime Format | required | Specifies the display format for date and time fields. |
| Default DateTime | optional | Specifies a default datetime as default value. Ignored if 'Default Today' is true. |
| Default Today | optional | Sets the default value of the field to today's date. |
| Description | optional | Description of the field. |
| Enforce Unique Values | optional | If set to true, unique values are required to be entered for the field. |
| Friendly Display Format | required | Specifies a friendly format to use in displaying date and time fields. Standard = Default representation, e.g. "9/20/2016". Friendly = Friendly relative representation will be used, e.g. "September 20". |
| Group | optional | Name of the group to which the field will be added. Only applicable in the case of a site column. |
| Hidden | optional | If set to true, the field is hidden. |
| Indexed | optional | If set to true, the field will be added as an index on the list. Ignored when multiple values are allowed. |
| Internal Name | required | The internal name of the field. Avoid the use of special characters, use them in the field 'Title' instead. |
| Is Site Column | optional | If set to true, this field will be added as a site column. If a list is provided, the field will first be added as a site column and afterwards as a site field to the list. If the field already exists on the list an error will occur. |
| List | optional | The GUID, internal name or title of the list on which the field is added. First the list will be retrieved by the GUID, then the internal name and lastly the title. |
| Read Only | optional | If set to true, the field becomes read only. |
| Required | optional | Specifies if this field is required to be filled in in the list. |
| Show In Display Form | optional | Specifies if this field is shown in the display form. |
| Show In Edit Form | optional | Specifies if this field is shown in the edit form. |
| Show In New Form | optional | Specifies if this field is shown in the new form. |
| Title | required | Display name of the field. |
| Url | optional | The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'. |
Ensure Lookup Field
Ensures the given look up field on the given list. If the field already exists it is updated with the given properties (where possible). First checks if a field exists with the given internal name, if not with the title.
Input Fields
| Name | Required? | Description |
|---|---|---|
| Add To Content Types | optional | If set to true, the field will be added to content types existing on that list. The advanced list setting 'enable content types' will be activated on that list. |
| Add To Default View | optional | If set to true, the field is added to the default view. Will be ignored if the field already exists. |
| Additional Lookup Fields | optional | Which additional fields to show from the lookup list. Needs to be the title or internal name of the field. Seperate multiple fields with a semicolon. |
| Allow Multiple Values | optional | If set to true multiple values are accepted in this field. Ignored if 'Enforce Unique Values' is set to true. |
| Custom Formatter | optional | The custom JSON formatting on the field. Documentation about the custom JSON formatting can be found in the official Microsoft documentation: https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/column-formatting This is only supported in SharePoint Online. |
| Description | optional | Description of the field. |
| Enforce Unique Values | optional | If set to true, unique values are required to be entered for the field. |
| Group | optional | Name of the group to which the field will be added. Only applicable in the case of a site column. |
| Hidden | optional | If set to true, the field is hidden. |
| Indexed | optional | If set to true, the field will be added as an index on the list. Ignored when multiple values are allowed. |
| Internal Name | required | The internal name of the field. Avoid the use of special characters, use them in the field 'Title' instead. |
| Is Site Column | optional | If set to true, this field will be added as a site column. If a list is provided, the field will first be added as a site column and afterwards as a site field to the list. If the field already exists on the list an error will occur. |
| List | optional | The GUID, internal name or title of the list on which the field is added. First the list will be retrieved by the GUID, then the internal name and lastly the title. |
| Lookup Field | required | The internal name of the field to retrieve the information from. |
| Lookup List | required | Title of the list to retrieve the information from. |
| Relationship Delete Behavior | required | Specifies the relationship behavior enforced by this lookup column when a list item in the lookup list is deleted. Ignored if 'Allow Multiple Values' is set to true. Cascade Delete = When an item in the target list is deleted, cascade delete will delete all related items in this list. Restrict Delete = When an item in the target list is deleted, restrict delete will prevent the deletion of an item in the target list if it has one or more related items in this list. |
| Required | optional | Specifies if this field is required to be filled in in the list. |
| Show In Display Form | optional | Specifies if this field is shown in the display form. |
| Show In Edit Form | optional | Specifies if this field is shown in the edit form. |
| Show In New Form | optional | Specifies if this field is shown in the new form. |
| Title | required | Display name of the field. |
| Unlimited Length In Document Library | optional | If set to true this field has an unlimited length in document libraries. Columns with long text are not supported by most applications for editing documents and could result in a loss of data. Only allow unlimited length if users will be uploading documents through the Web site, and not saving directly from the application. |
| Url | optional | The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'. |
Ensure Multiline Text Field
Ensures the given multiline text field on the given list. If the field already exists it is updated with the given properties (where possible). First checks if a field exists with the given internal name, if not with the title.
Input Fields
| Name | Required? | Description |
|---|---|---|
| Add To Content Types | optional | If set to true, the field will be added to content types existing on that list. The advanced list setting 'enable content types' will be activated on that list. |
| Add To Default View | optional | If set to true, the field is added to the default view. Will be ignored if the field already exists. |
| Custom Formatter | optional | The custom JSON formatting on the field. Documentation about the custom JSON formatting can be found in the official Microsoft documentation: https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/column-formatting This is only supported in SharePoint Online. |
| Description | optional | Description of the field. |
| Group | optional | Name of the group to which the field will be added. Only applicable in the case of a site column. |
| Hidden | optional | If set to true, the field is hidden. |
| Internal Name | required | The internal name of the field. Avoid the use of special characters, use them in the field 'Title' instead. |
| Is Site Column | optional | If set to true, this field will be added as a site column. If a list is provided, the field will first be added as a site column and afterwards as a site field to the list. If the field already exists on the list an error will occur. |
| List | optional | The GUID, internal name or title of the list on which the field is added. First the list will be retrieved by the GUID, then the internal name and lastly the title. |
| Number of Lines | optional | Number of lines for editing. |
| Required | optional | Specifies if this field is required to be filled in in the list. |
| Rich Text | optional | If set to true, the field supports rich formatting (pictures, tables, ...), depending on the 'Rich Text Mode'. |
| Rich Text Mode | optional | Specifies the kind of rich formatting. Ignored if 'Rich Text' is false. |
| Show In Display Form | optional | Specifies if this field is shown in the display form. |
| Show In Edit Form | optional | Specifies if this field is shown in the edit form. |
| Show In New Form | optional | Specifies if this field is shown in the new form. |
| Title | required | Display name of the field. |
| Unlimited Length In Document Library | optional | If set to true this field has an unlimited length in document libraries. Columns with long text are not supported by most applications for editing documents and could result in a loss of data. Only allow unlimited length if users will be uploading documents through the Web site, and not saving directly from the application. |
| Url | optional | The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'. |
Ensure Number Field
Ensures the given number field on the given list. If the field already exists it is updated with the given properties (where possible). First checks if a field exists with the given internal name, if not with the title.
Input Fields
| Name | Required? | Description |
|---|---|---|
| Add To Content Types | optional | If set to true, the field will be added to content types existing on that list. The advanced list setting 'enable content types' will be activated on that list. |
| Add To Default View | optional | If set to true, the field is added to the default view. Will be ignored if the field already exists. |
| Custom Formatter | optional | The custom JSON formatting on the field. Documentation about the custom JSON formatting can be found in the official Microsoft documentation: https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/column-formatting This is only supported in SharePoint Online. |
| Default Value | optional | Default value of the field. |
| Description | optional | Description of the field. |
| Enforce Unique Values | optional | If set to true, unique values are required to be entered for the field. |
| Group | optional | Name of the group to which the field will be added. Only applicable in the case of a site column. |
| Hidden | optional | If set to true, the field is hidden. |
| Indexed | optional | If set to true, the field will be added as an index on the list. Ignored when multiple values are allowed. |
| Internal Name | required | The internal name of the field. Avoid the use of special characters, use them in the field 'Title' instead. |
| Is Site Column | optional | If set to true, this field will be added as a site column. If a list is provided, the field will first be added as a site column and afterwards as a site field to the list. If the field already exists on the list an error will occur. |
| List | optional | The GUID, internal name or title of the list on which the field is added. First the list will be retrieved by the GUID, then the internal name and lastly the title. |
| Maximum Value | optional | Specifies the maximum allowed value for the field. |
| Minimum Value | optional | Specifies the minimum allowed value for the field. |
| Number Of Decimal Places | required | Specifies the amount of decimal places. |
| Read Only | optional | If set to true, the field becomes read only. |
| Required | optional | Specifies if this field is required to be filled in in the list. |
| Show In Display Form | optional | Specifies if this field is shown in the display form. |
| Show In Edit Form | optional | Specifies if this field is shown in the edit form. |
| Show In New Form | optional | Specifies if this field is shown in the new form. |
| Title | required | Display name of the field. |
| Url | optional | The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'. |
Ensure Person Or Group Field
Ensures the given person or group field on the given list. If the field already exists it is updated with the given properties (where possible). First checks if a field exists with the given internal name, if not with the title.
Input Fields
| Name | Required? | Description |
|---|---|---|
| Add To Content Types | optional | If set to true, the field will be added to content types existing on that list. The advanced list setting 'enable content types' will be activated on that list. |
| Add To Default View | optional | If set to true, the field is added to the default view. Will be ignored if the field already exists. |
| Allow Multiple Selections | optional | Specifies whether multiple persons or groups may be selected. |
| Allow Selection Of | required | Specifies whether only people or also groups may be selected. |
| Choose From | optional | Specify a valid SharePoint group to select users from. When left empty the selection of all users will be possible. |
| Custom Formatter | optional | The custom JSON formatting on the field. Documentation about the custom JSON formatting can be found in the official Microsoft documentation: https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/column-formatting This is only supported in SharePoint Online. |
| Description | optional | Description of the field. |
| Enforce Unique Values | optional | If set to true, unique values are required to be entered for the field. |
| Group | optional | Name of the group to which the field will be added. Only applicable in the case of a site column. |
| Hidden | optional | If set to true, the field is hidden. |
| Indexed | optional | If set to true, the field will be added as an index on the list. Ignored when multiple values are allowed. |
| Internal Name | required | The internal name of the field. Avoid the use of special characters, use them in the field 'Title' instead. |
| Is Site Column | optional | If set to true, this field will be added as a site column. If a list is provided, the field will first be added as a site column and afterwards as a site field to the list. If the field already exists on the list an error will occur. |
| List | optional | The GUID, internal name or title of the list on which the field is added. First the list will be retrieved by the GUID, then the internal name and lastly the title. |
| Read Only | optional | If set to true, the field becomes read only. |
| Required | optional | Specifies if this field is required to be filled in in the list. |
| Show Field | required | The field which is shown in the person field. |
| Show In Display Form | optional | Specifies if this field is shown in the display form. |
| Show In Edit Form | optional | Specifies if this field is shown in the edit form. |
| Show In New Form | optional | Specifies if this field is shown in the new form. |
| Title | required | Display name of the field. |
| Url | optional | The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'. |
Ensure Text Field
Ensures the given text field on the given list. If the field already exists it is updated with the given properties (where possible). First checks if a field exists with the given internal name, if not with the title.
Input Fields
| Name | Required? | Description |
|---|---|---|
| Add To Content Types | optional | If set to true, the field will be added to content types existing on that list. The advanced list setting 'enable content types' will be activated on that list. |
| Add To Default View | optional | If set to true, the field is added to the default view. Will be ignored if the field already exists. |
| Custom Formatter | optional | The custom JSON formatting on the field. Documentation about the custom JSON formatting can be found in the official Microsoft documentation: https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/column-formatting This is only supported in SharePoint Online. |
| Default Value | optional | Default value of the field. |
| Description | optional | Description of the field. |
| Enforce Unique Values | optional | If set to true, unique values are required to be entered for the field. |
| Group | optional | Name of the group to which the field will be added. Only applicable in the case of a site column. |
| Hidden | optional | If set to true, the field is hidden. |
| Indexed | optional | If set to true, the field will be added as an index on the list. Ignored when multiple values are allowed. |
| Internal Name | required | The internal name of the field. Avoid the use of special characters, use them in the field 'Title' instead. |
| Is Site Column | optional | If set to true, this field will be added as a site column. If a list is provided, the field will first be added as a site column and afterwards as a site field to the list. If the field already exists on the list an error will occur. |
| List | optional | The GUID, internal name or title of the list on which the field is added. First the list will be retrieved by the GUID, then the internal name and lastly the title. |
| Max Length | optional | Sets the max allowed length of characters in the field. |
| Read Only | optional | If set to true, the field becomes read only. |
| Required | optional | Specifies if this field is required to be filled in in the list. |
| Show In Display Form | optional | Specifies if this field is shown in the display form. |
| Show In Edit Form | optional | Specifies if this field is shown in the edit form. |
| Show In New Form | optional | Specifies if this field is shown in the new form. |
| Title | required | Display name of the field. |
| Url | optional | The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'. |
Ensure URL Field
Ensures the given URL field on the given list. If the field already exists it is updated with the given properties (where possible). First checks if a field exists with the given internal name, if not with the title.
Input Fields
| Name | Required? | Description |
|---|---|---|
| Add To Content Types | optional | If set to true, the field will be added to content types existing on that list. The advanced list setting 'enable content types' will be activated on that list. |
| Add To Default View | optional | If set to true, the field is added to the default view. Will be ignored if the field already exists. |
| Custom Formatter | optional | The custom JSON formatting on the field. Documentation about the custom JSON formatting can be found in the official Microsoft documentation: https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/column-formatting This is only supported in SharePoint Online. |
| Description | optional | Description of the field. |
| Display Format | required | Display format of the URL. |
| Group | optional | Name of the group to which the field will be added. Only applicable in the case of a site column. |
| Hidden | optional | If set to true, the field is hidden. |
| Internal Name | required | The internal name of the field. Avoid the use of special characters, use them in the field 'Title' instead. |
| Is Site Column | optional | If set to true, this field will be added as a site column. If a list is provided, the field will first be added as a site column and afterwards as a site field to the list. If the field already exists on the list an error will occur. |
| List | optional | The GUID, internal name or title of the list on which the field is added. First the list will be retrieved by the GUID, then the internal name and lastly the title. |
| Required | optional | Specifies if this field is required to be filled in in the list. |
| Show In Display Form | optional | Specifies if this field is shown in the display form. |
| Show In Edit Form | optional | Specifies if this field is shown in the edit form. |
| Show In New Form | optional | Specifies if this field is shown in the new form. |
| Title | required | Display name of the field. |
| Url | optional | The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'. |
Ensure Yes/No Field
Ensures the given yes/no field on the given list. If the field already exists it is updated with the given properties (where possible). First checks if a field exists with the given internal name, if not with the title.
Input Fields
| Name | Required? | Description |
|---|---|---|
| Add To Content Types | optional | If set to true, the field will be added to content types existing on that list. The advanced list setting 'enable content types' will be activated on that list. |
| Add To Default View | optional | If set to true, the field is added to the default view. Will be ignored if the field already exists. |
| Custom Formatter | optional | The custom JSON formatting on the field. Documentation about the custom JSON formatting can be found in the official Microsoft documentation: https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/column-formatting This is only supported in SharePoint Online. |
| Default Value | optional | Default value of the field. |
| Description | optional | Description of the field. |
| Group | optional | Name of the group to which the field will be added. Only applicable in the case of a site column. |
| Hidden | optional | If set to true, the field is hidden. |
| Indexed | optional | If set to true, the field will be added as an index on the list. Ignored when multiple values are allowed. |
| Internal Name | required | The internal name of the field. Avoid the use of special characters, use them in the field 'Title' instead. |
| Is Site Column | optional | If set to true, this field will be added as a site column. If a list is provided, the field will first be added as a site column and afterwards as a site field to the list. If the field already exists on the list an error will occur. |
| List | optional | The GUID, internal name or title of the list on which the field is added. First the list will be retrieved by the GUID, then the internal name and lastly the title. |
| Read Only | optional | If set to true, the field becomes read only. |
| Show In Display Form | optional | Specifies if this field is shown in the display form. |
| Show In Edit Form | optional | Specifies if this field is shown in the edit form. |
| Show In New Form | optional | Specifies if this field is shown in the new form. |
| Title | required | Display name of the field. |
| Url | optional | The url of the subsite or site collection. The url can also be specified with other context fields named 'Website' or 'CaseRootUrl'. |