SharePointSite entity reference

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

Messages

Message SDK class or method
Assign AssignRequest
Create CreateRequest or
Create
Delete DeleteRequest or
Delete
GrantAccess GrantAccessRequest
ModifyAccess ModifyAccessRequest
Retrieve RetrieveRequest or
Retrieve
RetrieveAbsoluteAndSiteCollectionUrl RetrieveAbsoluteAndSiteCollectionUrlRequest
RetrieveMultiple RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccessRequest
SetState SetStateRequest
Update UpdateRequest or
Update

Properties

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

Writable attributes

These 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
FormatName Url
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName absoluteurl
MaxLength 2000
RequiredLevel None
Type String

Description

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

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
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

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

IsDefault Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: 0

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

IsGridPresent Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: 0

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

IsPowerBISite Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: 0

LastValidated

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

Name

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

OverriddenCreatedOn

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

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
Targets systemuser,team
Type Owner

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
Targets sharepointsite
Type Lookup

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
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName relativeurl
MaxLength 160
RequiredLevel None
Type String

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

ServiceType Choices/Options

Value Label Description
0 SharePoint
1 OneDrive
2 Shared with me

SharePointSiteId

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

StateCode

Property Value
Description Status of the SharePoint site record.
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

StateCode Choices/Options

Value Label DefaultStatus InvariantName
0 Active 1 Active
1 Inactive 2 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

StatusCode Choices/Options

Value Label State
1 Active 0
2 Inactive 1

TimeZoneRuleVersionNumber

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

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
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

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

ValidationStatus Choices/Options

Value Label Description
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

ValidationStatusErrorCode Choices/Options

Value Label Description
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 attributes

These attributes return false for both IsValidForCreate or 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
Targets systemuser
Type Lookup

CreatedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel None
Type String

CreatedOn

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

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
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

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
MaxValue 100000000000
MinValue 0.0000000001
Precision 10
RequiredLevel None
Type Decimal

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
Targets systemuser
Type Lookup

ModifiedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel None
Type String

ModifiedOn

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

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
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel None
Type String

OwnerIdName

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

OwnerIdYomiName

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

OwningBusinessUnit

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

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
Targets team
Type Lookup

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
Targets systemuser
Type Lookup

ParentSiteName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName parentsitename
MaxLength 160
RequiredLevel None
Type String

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
Targets transactioncurrency
Type Lookup

TransactionCurrencyIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName transactioncurrencyidname
MaxLength 100
RequiredLevel None
Type String

VersionNumber

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

One-To-Many Relationships

Listed by SchemaName.

sharepointdocumentlocation_parent_sharepointsite

Same as the sharepointdocumentlocation_parent_sharepointsite many-to-one relationship for the sharepointdocumentlocation entity.

Property Value
ReferencingEntity sharepointdocumentlocation
ReferencingAttribute parentsiteorlocation
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName sharepointdocumentlocation_parent_sharepointsite
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 40
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

sharepointsite_principalobjectattributeaccess

Same as the sharepointsite_principalobjectattributeaccess many-to-one relationship for the principalobjectattributeaccess entity.

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName sharepointsite_principalobjectattributeaccess
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

SharePointSite_SyncErrors

Same as the SharePointSite_SyncErrors many-to-one relationship for the syncerror entity.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName SharePointSite_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: Cascade
Delete: Cascade
Merge: Cascade
Reparent: Cascade
Share: Cascade
Unshare: Cascade

sharepointsite_parentsite_sharepointsite

Same as the sharepointsite_parentsite_sharepointsite many-to-one relationship for the sharepointsite entity.

Property Value
ReferencingEntity sharepointsite
ReferencingAttribute parentsite
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName sharepointsite_parentsite_sharepointsite
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order: 40
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

SharePointSite_DuplicateBaseRecord

Same as the SharePointSite_DuplicateBaseRecord many-to-one relationship for the duplicaterecord entity.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute baserecordid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName SharePointSite_DuplicateBaseRecord
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

SharePointSite_AsyncOperations

Same as the SharePointSite_AsyncOperations many-to-one relationship for the asyncoperation entity.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName SharePointSite_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

SharePointSite_DuplicateMatchingRecord

Same as the SharePointSite_DuplicateMatchingRecord many-to-one relationship for the duplicaterecord entity.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute duplicaterecordid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName SharePointSite_DuplicateMatchingRecord
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

SharePointSite_ProcessSessions

Same as the SharePointSite_ProcessSessions many-to-one relationship for the processsession entity.

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName SharePointSite_ProcessSessions
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 110
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

user_sharepointsite

See the user_sharepointsite one-to-many relationship for the systemuser entity.

team_sharepointsite

See the team_sharepointsite one-to-many relationship for the team entity.

business_unit_sharepointsites

See the business_unit_sharepointsites one-to-many relationship for the businessunit entity.

TransactionCurrency_SharePointSite

See the TransactionCurrency_SharePointSite one-to-many relationship for the transactioncurrency entity.

lk_sharepointsitebase_modifiedonbehalfby

See the lk_sharepointsitebase_modifiedonbehalfby one-to-many relationship for the systemuser entity.

lk_sharepointsitebase_createdby

See the lk_sharepointsitebase_createdby one-to-many relationship for the systemuser entity.

sharepointsite_parentsite_sharepointsite

See the sharepointsite_parentsite_sharepointsite one-to-many relationship for the sharepointsite entity.

lk_sharepointsitebase_createdonbehalfby

See the lk_sharepointsitebase_createdonbehalfby one-to-many relationship for the systemuser entity.

lk_sharepointsitebase_modifiedby

See the lk_sharepointsitebase_modifiedby one-to-many relationship for the systemuser entity.

See also

About the Entity Reference
Web API EntityType Reference