SharePointDocumentLocation Entity Reference

Document libraries or folders on a SharePoint server from where documents can be managed in Microsoft Dynamics 365.

Messages

Message Web API Operation SDK Assembly
Assign PATCH [org URI]/api/data/v9.0/sharepointdocumentlocations(sharepointdocumentlocationid)
Update ownerid property.
AssignRequest
Create POST [org URI]/api/data/v9.0/sharepointdocumentlocations
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/sharepointdocumentlocations(sharepointdocumentlocationid)
See Delete
DeleteRequest or
Delete
GrantAccess GrantAccess Action GrantAccessRequest
ModifyAccess ModifyAccess Action ModifyAccessRequest
Retrieve GET [org URI]/api/data/v9.0/sharepointdocumentlocations(sharepointdocumentlocationid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveAbsoluteAndSiteCollectionUrl RetrieveAbsoluteAndSiteCollectionUrl Function RetrieveAbsoluteAndSiteCollectionUrlRequest
RetrieveMultiple GET [org URI]/api/data/v9.0/sharepointdocumentlocations
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccess Function RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccess Function RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccess Action RevokeAccessRequest
SetState PATCH [org URI]/api/data/v9.0/sharepointdocumentlocations(sharepointdocumentlocationid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/sharepointdocumentlocations(sharepointdocumentlocationid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName SharePointDocumentLocations
DisplayCollectionName Document Locations
DisplayName Document Location
EntitySetName sharepointdocumentlocations
IsBPFEntity False
LogicalCollectionName sharePointdocumentlocations
LogicalName sharepointdocumentlocation
OwnershipType UserOwned
PrimaryIdAttribute sharepointdocumentlocationid
PrimaryNameAttribute name
SchemaName SharePointDocumentLocation

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 document location.
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 document location record.
DisplayName Description
Format TextArea
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName description
MaxLength 2000
RequiredLevel None
Type Memo

ImportSequenceNumber

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

LocationType

Property Value
Description Location type of the SharePoint document location.
DisplayName Location Type
IsValidForForm True
IsValidForRead True
LogicalName locationtype
RequiredLevel None
Type Picklist

LocationType Options

Value Label
0 General
1 Dedicated for OneNote Integration

Name

Property Value
Description Name of the SharePoint document location 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 document location record.
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

ParentSiteOrLocation

Property Value
Description Unique identifier of the parent site or location.
DisplayName Parent Site or Location
IsValidForForm True
IsValidForRead True
LogicalName parentsiteorlocation
RequiredLevel None
Targets sharepointdocumentlocation,sharepointsite
Type Lookup

ParentSiteOrLocationTypeCode

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

RegardingObjectId

Property Value
Description Unique identifier of the object with which the SharePoint document location record is associated.
DisplayName Regarding
IsValidForForm True
IsValidForRead True
LogicalName regardingobjectid
RequiredLevel None
Targets account,kbarticle,knowledgearticle,msdyn_knowledgearticletemplate
Type Lookup

RegardingObjectIdName

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

RegardingObjectIdYomiName

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

RegardingObjectTypeCode

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

RelativeUrl

Property Value
Description Relative URL of the SharePoint document location.
DisplayName Relative URL
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName relativeurl
MaxLength 255
RequiredLevel None
Type String

ServiceType

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

ServiceType Options

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

SharePointDocumentLocationId

Property Value
Description Unique identifier of the SharePoint document location record.
DisplayName SharePoint Document Location ID
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName sharepointdocumentlocationid
RequiredLevel SystemRequired
Type Uniqueidentifier

StateCode

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

StateCode Options

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

StatusCode

Property Value
Description Reason for the status of the SharePoint document location record.
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

StatusCode 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 document location.
DisplayName SharePoint Document Location 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

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 document location 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 document location 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 document location 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 document location 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 document location 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 document location 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 document location 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 of the business unit that owns the SharePoint 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 who owns the SharePoint document location 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 document location record.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Targets systemuser
Type Lookup

ParentSiteOrLocationName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName parentsiteorlocationname
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 document location 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_sharepointdocumentlocation

Same as sharepointdocumentlocation entity sharepointdocumentlocation_parent_sharepointdocumentlocation Many-To-One relationship.

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

SharePointDocumentLocation_AsyncOperations

Same as asyncoperation entity SharePointDocumentLocation_AsyncOperations Many-To-One relationship.

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

sharepointdocumentlocation_principalobjectattributeaccess

Same as principalobjectattributeaccess entity sharepointdocumentlocation_principalobjectattributeaccess Many-To-One relationship.

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

SharePointDocumentLocation_DuplicateBaseRecord

Same as duplicaterecord entity SharePointDocumentLocation_DuplicateBaseRecord Many-To-One relationship.

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

SharePointDocumentLocation_ProcessSessions

Same as processsession entity SharePointDocumentLocation_ProcessSessions Many-To-One relationship.

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

SharePointDocumentLocation_SyncErrors

Same as syncerror entity SharePointDocumentLocation_SyncErrors Many-To-One relationship.

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

SharePointDocumentLocation_DuplicateMatchingRecord

Same as duplicaterecord entity SharePointDocumentLocation_DuplicateMatchingRecord Many-To-One relationship.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute duplicaterecordid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName SharePointDocumentLocation_DuplicateMatchingRecord
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
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.

knowledgearticle_SharePointDocumentLocations

See knowledgearticle Entity knowledgearticle_SharePointDocumentLocations One-To-Many relationship.

user_sharepointdocumentlocation

See systemuser Entity user_sharepointdocumentlocation One-To-Many relationship.

team_sharepointdocumentlocation

See team Entity team_sharepointdocumentlocation One-To-Many relationship.

business_unit_sharepointdocumentlocation

See businessunit Entity business_unit_sharepointdocumentlocation One-To-Many relationship.

lk_sharepointdocumentlocationbase_createdby

See systemuser Entity lk_sharepointdocumentlocationbase_createdby One-To-Many relationship.

lk_sharepointdocumentlocationbase_modifiedby

See systemuser Entity lk_sharepointdocumentlocationbase_modifiedby One-To-Many relationship.

sharepointdocumentlocation_parent_sharepointdocumentlocation

See sharepointdocumentlocation Entity sharepointdocumentlocation_parent_sharepointdocumentlocation One-To-Many relationship.

TransactionCurrency_SharePointDocumentLocation

See transactioncurrency Entity TransactionCurrency_SharePointDocumentLocation One-To-Many relationship.

lk_sharepointdocumentlocationbase_createdonbehalfby

See systemuser Entity lk_sharepointdocumentlocationbase_createdonbehalfby One-To-Many relationship.

Account_SharepointDocumentLocation

See account Entity Account_SharepointDocumentLocation One-To-Many relationship.

lk_sharepointdocumentlocationbase_modifiedonbehalfby

See systemuser Entity lk_sharepointdocumentlocationbase_modifiedonbehalfby One-To-Many relationship.

KbArticle_SharepointDocumentLocation

See kbarticle Entity KbArticle_SharepointDocumentLocation One-To-Many relationship.

sharepointdocumentlocation_parent_sharepointsite

See sharepointsite Entity sharepointdocumentlocation_parent_sharepointsite One-To-Many relationship.

msdyn_knowledgearticletemplate_SharePointDocumentLocations

Added by: Knowledge Management Features Solution

See msdyn_knowledgearticletemplate Entity msdyn_knowledgearticletemplate_SharePointDocumentLocations One-To-Many relationship.

See also

About the Entity Reference
Web API Reference
sharepointdocumentlocation EntityType