sharepointdocumentlocation EntityType

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

Entity set path: 
[organization URI]/api/data/v9.2/sharepointdocumentlocations
Base type: 
crmbaseentity
Table type: 
Standard
Display name: 
Document Location
Primary key: 
sharepointdocumentlocationid
Primary name column: 
name
Operations supported: 
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity. Some properties are read-only.

Name Type Details
absoluteurl Edm.String

Absolute URL of the SharePoint document location.

Display name: Absolute URL

createdon Edm.DateTimeOffset

Date and time when the SharePoint document location record was created.

Display name: Created On

Read only
description Edm.String

Description of the SharePoint document location record.

Display name: Description

exchangerate Edm.Decimal

Exchange rate between the currency associated with the SharePoint document location record and the base currency.

Display name: Exchange Rate

Read only
importsequencenumber Edm.Int32

Sequence number of the import that created the SharePoint document location record.

Display name: Import Sequence Number

locationtype Edm.Int32

Location type of the SharePoint document location.

Display name: Location Type

Default options
Values Label
0 General
1 Dedicated for OneNote Integration
modifiedon Edm.DateTimeOffset

Date and time when the SharePoint document location record was last modified.

Display name: Modified On

Read only
name Edm.String

Name of the SharePoint document location record.

Display name: Name

overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display name: Record Created On

relativeurl Edm.String

Relative URL of the SharePoint document location.

Display name: Relative URL

servicetype Edm.Int32

Shows the service type of the SharePoint site.

Display name: Service Type

Default options
Values Label
0 SharePoint
1 OneDrive
2 Shared with me
3 MS Teams
sharepointdocumentlocationid Edm.Guid

Unique identifier of the SharePoint document location record.

Display name: SharePoint Document Location ID

sitecollectionid Edm.Guid

For internal use only.

Read only
statecode Edm.Int32

Status of the SharePoint document location record.

Display name: Status

Default options
Values Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the SharePoint document location record.

Display name: Status Reason

Default options
Values Label
1 Active
2 Inactive
timezoneruleversionnumber Edm.Int32

For internal use only.

userid Edm.Guid

Choose the user who owns the SharePoint document location.

Display name: SharePoint Document Location Owner

utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

versionnumber Edm.Int64
Read only

Lookup properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.

Name Single-valued navigation property Description
_createdby_value createdby

Unique identifier of the user who created the SharePoint document location record.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the SharePoint document location record.

_modifiedby_value modifiedby

Unique identifier of the user who last modified the SharePoint document location record.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who modified the SharePoint document location record.

_ownerid_value ownerid

Unique identifier of the user or team who owns the SharePoint document location record.

_owningbusinessunit_value owningbusinessunit

Unique identifier of the business unit that owns the SharePoint document location record.

_owningteam_value owningteam

Unique identifier of the team who owns the SharePoint document location record.

_owninguser_value owninguser

Unique identifier of the user who owns the SharePoint document location record.

_parentsiteorlocation_value parentsiteorlocation_sharepointdocumentlocation
parentsiteorlocation_sharepointsite

Unique identifier of the parent site or location.

_regardingobjectid_value regardingobjectid_account
regardingobjectid_kbarticle
regardingobjectid_knowledgearticle
regardingobjectid_msdyn_knowledgearticletemplate
regardingobjectid_mspp_website

Unique identifier of the object with which the SharePoint document location record is associated.

_transactioncurrencyid_value transactioncurrencyid

Unique identifier of the currency associated with the SharePoint document location record.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
createdby systemuser lk_sharepointdocumentlocationbase_createdby
createdonbehalfby systemuser lk_sharepointdocumentlocationbase_createdonbehalfby
modifiedby systemuser lk_sharepointdocumentlocationbase_modifiedby
modifiedonbehalfby systemuser lk_sharepointdocumentlocationbase_modifiedonbehalfby
ownerid principal owner_sharepointdocumentlocation
owningbusinessunit businessunit business_unit_sharepointdocumentlocation
owningteam team team_sharepointdocumentlocation
owninguser systemuser user_sharepointdocumentlocation
parentsiteorlocation_sharepointdocumentlocation sharepointdocumentlocation sharepointdocumentlocation_parent_sharepointdocumentlocation
parentsiteorlocation_sharepointsite sharepointsite sharepointdocumentlocation_parent_sharepointsite
regardingobjectid_account account Account_SharepointDocumentLocation
regardingobjectid_adx_portalcomment adx_portalcomment adx_portalcomment_SharePointDocumentLocations
regardingobjectid_kbarticle kbarticle KbArticle_SharepointDocumentLocation
regardingobjectid_knowledgearticle knowledgearticle knowledgearticle_SharePointDocumentLocations
regardingobjectid_msdyn_knowledgearticletemplate msdyn_knowledgearticletemplate msdyn_knowledgearticletemplate_SharePointDocumentLocations
regardingobjectid_mspp_website mspp_website mspp_website_SharePointDocumentLocations
transactioncurrencyid transactioncurrency TransactionCurrency_SharePointDocumentLocation

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name Type Partner
SharePointDocumentLocation_AsyncOperations asyncoperation regardingobjectid_sharepointdocumentlocation
SharePointDocumentLocation_DuplicateBaseRecord duplicaterecord baserecordid_sharepointdocumentlocation
SharePointDocumentLocation_DuplicateMatchingRecord duplicaterecord duplicaterecordid_sharepointdocumentlocation
sharepointdocumentlocation_parent_sharepointdocumentlocation sharepointdocumentlocation parentsiteorlocation_sharepointdocumentlocation
sharepointdocumentlocation_principalobjectattributeaccess principalobjectattributeaccess objectid_sharepointdocumentlocation
SharePointDocumentLocation_ProcessSessions processsession regardingobjectid_sharepointdocumentlocation
SharePointDocumentLocation_SyncErrors syncerror regardingobjectid_sharepointdocumentlocation_syncerror

Operations

The following operations can be used with the sharepointdocumentlocation entity type.

Name Binding
GrantAccess Not Bound
ModifyAccess Not Bound
RetrieveAbsoluteAndSiteCollectionUrl Bound to Entity
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound

See also