sharepointdocumentlocation EntityType

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Description: 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/v8.2/sharepointdocumentlocations

Base Type: crmbaseentity EntityType

Display Name: Document Location

Primary Key: sharepointdocumentlocationid

Primary Name Attribute: name

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Operations bound to sharepointdocumentlocation

Operations using the sharepointdocumentlocation entity type.

Properties

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

Name

Type

Details

absoluteurl

Edm.String

Description: Absolute URL of the SharePoint document location.

Display Name: Absolute URL

createdon

Edm.DateTimeOffset

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

Display Name: Created On

Read-only property

description

Edm.String

Description: Description of the SharePoint document location record.

Display Name: Description

exchangerate

Edm.Decimal

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

Display Name: Exchange Rate

Read-only property

importsequencenumber

Edm.Int32

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

Display Name: Import Sequence Number

locationtype

Edm.Int32

Description: Location type of the SharePoint document location.

Default Options:

0 : General
1 : Dedicated for OneNote Integration

Display Name: Location Type

modifiedon

Edm.DateTimeOffset

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

Display Name: Modified On

Read-only property

name

Edm.String

Description: Name of the SharePoint document location record.

Display Name: Name

overriddencreatedon

Edm.DateTimeOffset

Description: Date and time that the record was migrated.

Display Name: Record Created On

relativeurl

Edm.String

Description: Relative URL of the SharePoint document location.

Display Name: Relative URL

servicetype

Edm.Int32

Description: Shows the service type of the SharePoint site.

Default Options:

0 : SharePoint
1 : OneDrive
2 : Shared with me

Display Name: Service Type

sharepointdocumentlocationid

Edm.Guid

Description: Unique identifier of the SharePoint document location record.

Display Name: SharePoint Document Location ID

sitecollectionid

Edm.Guid

Description: For internal use only.

Read-only property

statecode

Edm.Int32

Description: Status of the SharePoint document location record.

Default Options:

0 : Active
1 : Inactive

Display Name: Status

statuscode

Edm.Int32

Description: Reason for the status of the SharePoint document location record.

Default Options:

1 : Active
2 : Inactive

Display Name: Status Reason

timezoneruleversionnumber

Edm.Int32

Description: For internal use only.

userid

Edm.Guid

Description: Choose the user who owns the SharePoint document location.

Display Name: SharePoint Document Location Owner

utcconversiontimezonecode

Edm.Int32

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

versionnumber

Edm.Int64

Description:

Read-only property

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 Retrieve data about lookup properties

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_knowledgearticle

regardingobjectid_account

regardingobjectid_quote

regardingobjectid_product

regardingobjectid_lead

regardingobjectid_salesliterature

regardingobjectid_opportunity

regardingobjectid_kbarticle

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 EntityType

lk_sharepointdocumentlocationbase_createdby

createdonbehalfby

systemuser EntityType

lk_sharepointdocumentlocationbase_createdonbehalfby

modifiedby

systemuser EntityType

lk_sharepointdocumentlocationbase_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_sharepointdocumentlocationbase_modifiedonbehalfby

ownerid

principal EntityType

owner_sharepointdocumentlocation

owningbusinessunit

businessunit EntityType

business_unit_sharepointdocumentlocation

owningteam

team EntityType

team_sharepointdocumentlocation

owninguser

systemuser EntityType

user_sharepointdocumentlocation

parentsiteorlocation_sharepointdocumentlocation

sharepointdocumentlocation EntityType

sharepointdocumentlocation_parent_sharepointdocumentlocation

parentsiteorlocation_sharepointsite

sharepointsite EntityType

sharepointdocumentlocation_parent_sharepointsite

regardingobjectid_account

account EntityType

Account_SharepointDocumentLocation

regardingobjectid_kbarticle

kbarticle EntityType

KbArticle_SharepointDocumentLocation

regardingobjectid_knowledgearticle

knowledgearticle EntityType

knowledgearticle_SharePointDocumentLocations

regardingobjectid_lead

lead EntityType

Lead_SharepointDocumentLocation

regardingobjectid_opportunity

opportunity EntityType

Opportunity_SharepointDocumentLocation

regardingobjectid_product

product EntityType

Product_SharepointDocumentLocation

regardingobjectid_quote

quote EntityType

Quote_SharepointDocumentLocation

regardingobjectid_salesliterature

salesliterature EntityType

SalesLiterature_SharepointDocumentLocation

transactioncurrencyid

transactioncurrency EntityType

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 EntityType

regardingobjectid_sharepointdocumentlocation

SharePointDocumentLocation_DuplicateBaseRecord

duplicaterecord EntityType

baserecordid_sharepointdocumentlocation

SharePointDocumentLocation_DuplicateMatchingRecord

duplicaterecord EntityType

duplicaterecordid_sharepointdocumentlocation

sharepointdocumentlocation_parent_sharepointdocumentlocation

sharepointdocumentlocation EntityType

parentsiteorlocation_sharepointdocumentlocation

SharePointDocumentLocation_SyncErrors

syncerror EntityType

regardingobjectid_sharepointdocumentlocation_syncerror

Operations bound to sharepointdocumentlocation

The following operations are bound to the sharepointdocumentlocation entity type.

Name

Bound to

RetrieveAbsoluteAndSiteCollectionUrl Function

Entity

Operations using the sharepointdocumentlocation entity type.

The following operations use the sharepointdocumentlocation entity type in a parameter or return type.

Name

How used

Description

RetrieveAbsoluteAndSiteCollectionUrl Function

entity Parameter

Retrieves the absolute URL and the site collection URL for a SharePoint location record in Microsoft Dynamics 365.

See Also

Use the Microsoft Dynamics 365 Web API
Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright