Concepts

Concepts used in Microsoft SharePoint BDK Book.

Sharepoint list

A SharePoint list is a structured collection of data within a SharePoint site. It provides a way to organize and manage information in a tabular format, with columns representing different data fields and rows containing specific data entries. Lists are commonly used for tasks like tracking project progress, managing contacts, or storing custom data.

Field Name	Description	Type
columns	The columns of the list.	list of text
created_date_time	The date and time the list was created.	datetime
display_name	The display name of the list.	text
id	The unique identifier for the list.	text
name	The name of the list.	text
web_url	The URL of the list.	text
site_id	The id of the site this list belongs to.	text
description	The description of the list.	optional[text]

Sharepoint list item

A SharePoint list item represents an individual entry within a SharePoint list. It contains specific data values corresponding to the columns defined in the list. List items are used to store and manage structured data within a SharePoint list, enabling efficient organization and retrieval of information.

Field Name	Description	Type
id	The unique identifier for the list item.	text
list_id	The id of the list this item belongs to.	text
site_id	The id of the site this item belongs to.	text
fields	The fields of the list item.	``
web_url	The URL of the list item.	text

Sharepoint folder reference

A Sharepoint Folder Reference is a reference to a folder in a SharePoint document library.

Field Name	Description	Type
id	The unique identifier for the document library.	optional[text]
name	The name of the document library.	optional[text]
web_url	URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).	optional[text]
parent_reference	Parent information, if the item has a parent.	optional[parent_reference]
is_folder	Boolean flag indicating whenever this item is a folder or not.	boolean
folder_name	The name of the folder. Same as name.	text

Parent_reference

A reference to a SharePoint document library item, providing essential identifiers that link to a specific item within a SharePoint document library.

Field Name	Description	Type
id	The unique identifier of the document library item.	optional[text]
drive_id	The unique identifier of the drive containing the document library item.	optional[text]

Sharepoint site

A SharePoint site is a versatile web-based platform within Microsoft SharePoint designed for team collaboration,document management, and content sharing. It provides a centralized space where users can store and manage documents with version control, organize information in lists, create and publish web pages, and control permissions for different users.

Field Name	Description	Type
id	The unique identifier for the site. Read-only.	text
name	The name of the site. Read-write.	optional[text]
display_name	The full title for the site. Read-only.	optional[text]
web_url	URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats). Read-only.	optional[text]
is_personal_site	Identifies whether the site is personal or not. Read-only.	optional[boolean]
description	Provides a user-visible description of the site. Optional.	optional[text]

Sharepoint document library

A SharePoint Document Library is a specialized storage location within a SharePoint site designed for storing, organizing,and managing documents. It supports advanced document management features such as version control, metadata tagging, and workflow automation, making it ideal for team collaboration and enterprise content management.

Field Name	Description	Type
id	The unique identifier for the document library. Read-only.	text
drive_type	Describes the type of drive represented by this resource. OneDrive personal drives will return personal. OneDrive for Business will return business. SharePoint document libraries will return documentLibrary. Read-only.	optional[text]
name	The name of the document library. Read-write.	optional[text]
web_url	URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats). Read-only.	optional[text]
description	Provides a user-visible description of the document library. Optional.	optional[text]

Sharepoint list column

A SharePoint list column definition represents the configuration and properties of a column within a SharePoint list.

Field Name	Description	Type
id	The unique identifier for the column.	text
type	The type of the column.	text
list_id	The id of the list this column belongs to.	text
site_id	The id of the site this column belongs to.	text
general_definition	The general definition of the column.	``
type_specific_definition	The type specific definition of the column.	optional[json]

Type_specific_definition

No description

Sharepoint file reference

A Sharepoint File Reference is a reference to a file in a SharePoint document library.

Field Name	Description	Type
id	The unique identifier for the document library.	optional[text]
name	The name of the document library.	optional[text]
web_url	URL that either displays the resource in the browser (for Office file formats), or is a direct link to the file (for other formats).	optional[text]
parent_reference	Parent information, if the item has a parent.	optional[parent_reference]
is_folder	Boolean flag indicating whenever this item is a folder or not.	boolean
file_name	The name of the file. Same as name.	text