Edit

Share via

SharePoint Site (SharePointSite) table/entity reference (Microsoft Dataverse)

SharePoint site from where documents can be managed in Microsoft Dynamics 365.

Messages

The following table lists the messages for the SharePoint Site (SharePointSite) table. Messages represent operations that can be performed on the table. They may also be events.

Name
Is Event?		 Web API Operation SDK for .NET
Assign
Event: True		 PATCH /sharepointsites(sharepointsiteid)
Update the ownerid property.		 AssignRequest
Associate
Event: True		 Associate records Associate records
Create
Event: True		 POST /sharepointsites
See Create		 Create records
Delete
Event: True		 DELETE /sharepointsites(sharepointsiteid)
See Delete		 Delete records
Disassociate
Event: True		 Disassociate records Disassociate records
GrantAccess
Event: True		 GrantAccess GrantAccessRequest
ModifyAccess
Event: True		 ModifyAccess ModifyAccessRequest
Retrieve
Event: True		 GET /sharepointsites(sharepointsiteid)
See Retrieve		 Retrieve records
RetrieveAbsoluteAndSiteCollectionUrl
Event: False		 RetrieveAbsoluteAndSiteCollectionUrl RetrieveAbsoluteAndSiteCollectionUrlRequest
RetrieveMultiple
Event: True		 GET /sharepointsites
See Query data		 Query data
RetrievePrincipalAccess
Event: True		 RetrievePrincipalAccess RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess
Event: True		 RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess
Event: True		 RevokeAccess RevokeAccessRequest
SetState
Event: True		 PATCH /sharepointsites(sharepointsiteid)
Update the statecode and statuscode properties.		 SetStateRequest
Update
Event: True		 PATCH /sharepointsites(sharepointsiteid)
See Update		 Update records
Upsert
Event: False		 PATCH /sharepointsites(sharepointsiteid)
See Upsert a table row		 UpsertRequest

Properties

The following table lists selected properties for the SharePoint Site (SharePointSite) table.

Property Value
DisplayName SharePoint Site
DisplayCollectionName SharePoint Sites
SchemaName SharePointSite
CollectionSchemaName SharePointSites
EntitySetName sharepointsites
LogicalName sharepointsite
LogicalCollectionName sharepointsites
PrimaryIdAttribute sharepointsiteid
PrimaryNameAttribute name
TableType Standard
OwnershipType UserOwned

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

AbsoluteURL

Property Value
Description Absolute URL of the SharePoint site.
DisplayName Absolute URL
IsValidForForm True
IsValidForRead True
LogicalName absoluteurl
RequiredLevel None
Type String
Format Url
FormatName Url
ImeMode Auto
IsLocalizable False
MaxLength 2000

Description

Property Value
Description Description of the SharePoint site record.
DisplayName Description
IsValidForForm True
IsValidForRead True
LogicalName description
RequiredLevel None
Type Memo
Format TextArea
FormatName TextArea
ImeMode Auto
IsLocalizable False
MaxLength 2000

FolderStructureEntity

Property Value
Description Entity on which the folder structure for Microsoft Dynamics 365 records will be created in SharePoint.
DisplayName Entity for SharePoint Folder Structure
IsValidForForm False
IsValidForRead True
LogicalName folderstructureentity
RequiredLevel None
Type EntityName

ImportSequenceNumber

Property Value
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
IsValidForForm False
IsValidForRead True
LogicalName importsequencenumber
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -2147483648

IsDefault

Property Value
Description Indicates whether the SharePoint site is the default site or not.
DisplayName Default Site
IsValidForForm True
IsValidForRead True
LogicalName isdefault
RequiredLevel None
Type Boolean
GlobalChoiceName sharepointsite_isdefault
DefaultValue False
True Label Yes
False Label No

IsGridPresent

Property Value
Description Indicates if SharePoint Grid is present or not.
DisplayName List component is installed
IsValidForForm True
IsValidForRead True
LogicalName isgridpresent
RequiredLevel None
Type Boolean
GlobalChoiceName sharepointsite_isgridpresent
DefaultValue False
True Label Yes
False Label No

IsPowerBISite

Property Value
Description Allows embedding of Power BI Reports available in this SharePoint site.
DisplayName Allow Embedding of Power BI Reports
IsValidForForm True
IsValidForRead True
LogicalName ispowerbisite
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName sharepointsite_ispowerbisite
DefaultValue False
True Label Yes
False Label No

LastValidated

Property Value
Description Date and time when the SharePoint site URL was last validated.
DisplayName Last Validated
IsValidForForm True
IsValidForRead True
LogicalName lastvalidated
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

Name

Property Value
Description Name of the SharePoint site record.
DisplayName Name
IsValidForForm True
IsValidForRead True
LogicalName name
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 160

OverriddenCreatedOn

Property Value
Description Date and time that the record was migrated.
DisplayName Record Created On
IsValidForForm False
IsValidForRead True
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateOnly
ImeMode Inactive
SourceTypeMask 0

OwnerId

Property Value
Description Unique identifier of the user or team who owns the SharePoint site.
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Type Owner
Targets systemuser, team

OwnerIdType

Property Value
Description Owner Id Type
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

ParentSite

Property Value
Description Unique identifier of the parent SharePoint site.
DisplayName Parent Site
IsValidForForm True
IsValidForRead True
LogicalName parentsite
RequiredLevel None
Type Lookup
Targets sharepointsite

ParentSiteObjectTypeCode

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName parentsiteobjecttypecode
RequiredLevel None
Type EntityName

RelativeUrl

Property Value
Description Relative URL of the SharePoint site.
DisplayName Relative URL
IsValidForForm True
IsValidForRead True
LogicalName relativeurl
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 160

ServiceType

Property Value
Description Shows the service type of location of the SharePoint site.
DisplayName Service Type
IsValidForForm False
IsValidForRead True
LogicalName servicetype
RequiredLevel SystemRequired
Type Picklist
DefaultFormValue 0
GlobalChoiceName sharepointsite_servicetype

ServiceType Choices/Options

Value Label
0 SharePoint
1 OneDrive
2 Shared with me
3 MS Teams

SharePointSiteId

Property Value
Description Unique identifier of the SharePoint site in Dynamics 365
DisplayName SharePoint Site ID
IsValidForForm False
IsValidForRead True
LogicalName sharepointsiteid
RequiredLevel SystemRequired
Type Uniqueidentifier

StateCode

Property Value
Description Status of the SharePoint site record.
DisplayName Status
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State
DefaultFormValue 0
GlobalChoiceName sharepointsite_statecode

StateCode Choices/Options

Value Details
0 Label: Active
DefaultStatus: 1
InvariantName: Active
1 Label: Inactive
DefaultStatus: 2
InvariantName: Inactive

StatusCode

Property Value
Description Reason for the status of the SharePoint site record.
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status
DefaultFormValue -1
GlobalChoiceName sharepointsite_statuscode

StatusCode Choices/Options

Value Details
1 Label: Active
State:0
TransitionData: None
2 Label: Inactive
State:1
TransitionData: None

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -1

UserId

Property Value
Description Choose the user who owns the SharePoint site.
DisplayName SharePoint Site Owner
IsValidForForm False
IsValidForRead True
LogicalName userid
RequiredLevel None
Type Uniqueidentifier

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -1

ValidationStatus

Property Value
Description Validation status of the SharePoint site URL.
DisplayName Last Validation Status
IsValidForForm True
IsValidForRead True
LogicalName validationstatus
RequiredLevel None
Type Picklist
DefaultFormValue 1
GlobalChoiceName sharepoint_validationstatus

ValidationStatus Choices/Options

Value Label
1 Not Validated
2 In Progress
3 Invalid
4 Valid
5 Could not validate

ValidationStatusErrorCode

Property Value
Description Reason for validation status of the URL
DisplayName Additional Information
IsValidForForm True
IsValidForRead True
LogicalName validationstatuserrorcode
RequiredLevel None
Type Picklist
DefaultFormValue 1
GlobalChoiceName sharepoint_validationstatusreason

ValidationStatusErrorCode Choices/Options

Value Label
1 This record's URL has not been validated.
2 This record's URL is valid.
3 This record's URL is not valid.
4 The URL schemes of Microsoft Dynamics 365 and SharePoint are different.
5 The URL could not be accessed because of Internet Explorer security settings.
6 Authentication failure.
7 Invalid certificates.

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

CreatedBy

Property Value
Description Unique identifier of the user who created the SharePoint site record.
DisplayName Created By
IsValidForForm False
IsValidForRead True
LogicalName createdby
RequiredLevel None
Type Lookup
Targets systemuser

CreatedOn

Property Value
Description Date and time when the SharePoint site record was created.
DisplayName Created On
IsValidForForm False
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

CreatedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who created the SharePoint site record.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Type Lookup
Targets systemuser

ExchangeRate

Property Value
Description Exchange rate between the currency associated with the SharePoint site record and the base currency.
DisplayName Exchange Rate
IsValidForForm True
IsValidForRead True
LogicalName exchangerate
RequiredLevel None
Type Decimal
ImeMode Disabled
MaxValue 100000000000
MinValue 1E-12
Precision 12
SourceTypeMask 0

ModifiedBy

Property Value
Description Unique identifier of the user who last modified the SharePoint site record.
DisplayName Modified By
IsValidForForm False
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Type Lookup
Targets systemuser

ModifiedOn

Property Value
Description Date and time when the SharePoint site record was last modified.
DisplayName Modified On
IsValidForForm False
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

ModifiedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who modified the SharePoint site record.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Type Lookup
Targets systemuser

OwnerIdName

Property Value
Description Name of the owner
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridname
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

OwnerIdYomiName

Property Value
Description Yomi name of the owner
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridyominame
RequiredLevel SystemRequired
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 100

OwningBusinessUnit

Property Value
Description Unique identifier for the business unit that owns the document location record.
DisplayName Owning Business Unit
IsValidForForm True
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Type Lookup
Targets businessunit

OwningTeam

Property Value
Description Unique identifier of the team that owns the SharePoint site record.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Type Lookup
Targets team

OwningUser

Property Value
Description Unique identifier of the user who owns the SharePoint site record.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Type Lookup
Targets systemuser

SiteCollectionId

Property Value
Description For internal use only.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName sitecollectionid
RequiredLevel None
Type Uniqueidentifier

TransactionCurrencyId

Property Value
Description Unique identifier of the currency associated with the SharePoint site record.
DisplayName Currency
IsValidForForm True
IsValidForRead True
LogicalName transactioncurrencyid
RequiredLevel None
Type Lookup
Targets transactioncurrency

VersionNumber

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
RequiredLevel None
Type BigInt
MaxValue 9223372036854775807
MinValue -9223372036854775808

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

business_unit_sharepointsites

One-To-Many Relationship: businessunit business_unit_sharepointsites

Property Value
ReferencedEntity businessunit
ReferencedAttribute businessunitid
ReferencingAttribute owningbusinessunit
ReferencingEntityNavigationPropertyName owningbusinessunit
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_sharepointsitebase_createdby

One-To-Many Relationship: systemuser lk_sharepointsitebase_createdby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdby
ReferencingEntityNavigationPropertyName createdby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_sharepointsitebase_createdonbehalfby

One-To-Many Relationship: systemuser lk_sharepointsitebase_createdonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdonbehalfby
ReferencingEntityNavigationPropertyName createdonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_sharepointsitebase_modifiedby

One-To-Many Relationship: systemuser lk_sharepointsitebase_modifiedby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedby
ReferencingEntityNavigationPropertyName modifiedby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_sharepointsitebase_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_sharepointsitebase_modifiedonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedonbehalfby
ReferencingEntityNavigationPropertyName modifiedonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

owner_sharepointsite

One-To-Many Relationship: owner owner_sharepointsite

Property Value
ReferencedEntity owner
ReferencedAttribute ownerid
ReferencingAttribute ownerid
ReferencingEntityNavigationPropertyName ownerid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

sharepointsite_parentsite_sharepointsite

One-To-Many Relationship: sharepointsite sharepointsite_parentsite_sharepointsite

Property Value
ReferencedEntity sharepointsite
ReferencedAttribute sharepointsiteid
ReferencingAttribute parentsite
ReferencingEntityNavigationPropertyName parentsite
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

team_sharepointsite

One-To-Many Relationship: team team_sharepointsite

Property Value
ReferencedEntity team
ReferencedAttribute teamid
ReferencingAttribute owningteam
ReferencingEntityNavigationPropertyName owningteam
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

TransactionCurrency_SharePointSite

One-To-Many Relationship: transactioncurrency TransactionCurrency_SharePointSite

Property Value
ReferencedEntity transactioncurrency
ReferencedAttribute transactioncurrencyid
ReferencingAttribute transactioncurrencyid
ReferencingEntityNavigationPropertyName transactioncurrencyid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: Restrict
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

user_sharepointsite

One-To-Many Relationship: systemuser user_sharepointsite

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute owninguser
ReferencingEntityNavigationPropertyName owninguser
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

sharepointdocumentlocation_parent_sharepointsite

Many-To-One Relationship: sharepointdocumentlocation sharepointdocumentlocation_parent_sharepointsite

Property Value
ReferencingEntity sharepointdocumentlocation
ReferencingAttribute parentsiteorlocation
ReferencedEntityNavigationPropertyName sharepointdocumentlocation_parent_sharepointsite
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: UseCollectionName
Group: Details
Label:
MenuId: null
Order: 40
QueryApi: CRMSharePointDocumentLocation.RetrieveSubSharePointDocumentLocations
ViewId: 757f2447-c680-437b-8d46-0d5f84cc2f03

SharePointSite_AsyncOperations

Many-To-One Relationship: asyncoperation SharePointSite_AsyncOperations

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName SharePointSite_AsyncOperations
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

SharePointSite_DuplicateBaseRecord

Many-To-One Relationship: duplicaterecord SharePointSite_DuplicateBaseRecord

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute baserecordid
ReferencedEntityNavigationPropertyName SharePointSite_DuplicateBaseRecord
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

SharePointSite_DuplicateMatchingRecord

Many-To-One Relationship: duplicaterecord SharePointSite_DuplicateMatchingRecord

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute duplicaterecordid
ReferencedEntityNavigationPropertyName SharePointSite_DuplicateMatchingRecord
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

sharepointsite_parentsite_sharepointsite

Many-To-One Relationship: sharepointsite sharepointsite_parentsite_sharepointsite

Property Value
ReferencingEntity sharepointsite
ReferencingAttribute parentsite
ReferencedEntityNavigationPropertyName sharepointsite_parentsite_sharepointsite
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order: 40
QueryApi: CRMSharePointSites.RetrieveSharePointSubSites
ViewId: df2fe6da-f97f-4878-80b6-8deb7d9d6a09

sharepointsite_principalobjectattributeaccess

Many-To-One Relationship: principalobjectattributeaccess sharepointsite_principalobjectattributeaccess

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
ReferencedEntityNavigationPropertyName sharepointsite_principalobjectattributeaccess
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

SharePointSite_ProcessSessions

Many-To-One Relationship: processsession SharePointSite_ProcessSessions

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName SharePointSite_ProcessSessions
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: UseCollectionName
Group: Details
Label:
MenuId: null
Order: 110
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

SharePointSite_SyncErrors

Many-To-One Relationship: syncerror SharePointSite_SyncErrors

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName SharePointSite_SyncErrors
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

See also

Dataverse table/entity reference
Dataverse Web API Reference
sharepointsite