sharepointsite EntityType

  • Article

 

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

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

Entity Set path:[organization URI]/api/data/v8.2/sharepointsites

Base Type: crmbaseentity EntityType

Display Name: SharePoint Site

Primary Key: sharepointsiteid

Primary Name Attribute: name

Properties

Lookup Properties

Single-valued navigation properties

Collection-valued navigation properties

Operations bound to sharepointsite

Operations using the sharepointsite 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 site.

Display Name: Absolute URL

createdon

Edm.DateTimeOffset

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

Display Name: Created On

Read-only property

description

Edm.String

Description: Description of the SharePoint site record.

Display Name: Description

exchangerate

Edm.Decimal

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

Display Name: Exchange Rate

Read-only property

folderstructureentity

Edm.String

Description: Entity on which the folder structure for Microsoft Dynamics 365 records will be created in SharePoint.

Display Name: Entity for SharePoint Folder Structure

importsequencenumber

Edm.Int32

Description: Sequence number of the import that created this record.

Display Name: Import Sequence Number

isdefault

Edm.Boolean

Description: Indicates whether the SharePoint site is the default site or not.

Default Options:

1 : Yes
0 : No

Display Name: Default Site

isgridpresent

Edm.Boolean

Description: Indicates if SharePoint Grid is present or not.

Default Options:

1 : Yes
0 : No

Display Name: List component is installed

ispowerbisite

Edm.Boolean

Description: Allows embedding of Power BI Reports available in this SharePoint site.

Default Options:

1 : Yes
0 : No

Display Name: Allow Embedding of Power BI Reports

lastvalidated

Edm.DateTimeOffset

Description: Date and time when the SharePoint site URL was last validated.

Display Name: Last Validated

modifiedon

Edm.DateTimeOffset

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

Display Name: Modified On

Read-only property

name

Edm.String

Description: Name of the SharePoint site 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 site.

Display Name: Relative URL

servicetype

Edm.Int32

Description: Shows the service type of location of the SharePoint site.

Default Options:

0 : SharePoint
1 : OneDrive
2 : Shared with me

Display Name: Service Type

sharepointsiteid

Edm.Guid

Description: Unique identifier of the SharePoint site in Dynamics 365

Display Name: SharePoint Site ID

sitecollectionid

Edm.Guid

Description: For internal use only.

Read-only property

statecode

Edm.Int32

Description: Status of the SharePoint site record.

Default Options:

0 : Active
1 : Inactive

Display Name: Status

statuscode

Edm.Int32

Description: Reason for the status of the SharePoint site 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 site.

Display Name: SharePoint Site Owner

utcconversiontimezonecode

Edm.Int32

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

validationstatus

Edm.Int32

Description: Validation status of the SharePoint site URL.

Default Options:

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

Display Name: Last Validation Status

validationstatuserrorcode

Edm.Int32

Description: Reason for validation status of the URL

Default Options:

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.

Display Name: Additional Information

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 site record.

_createdonbehalfby_value

createdonbehalfby

Unique identifier of the delegate user who created the SharePoint site record.

_modifiedby_value

modifiedby

Unique identifier of the user who last modified the SharePoint site record.

_modifiedonbehalfby_value

modifiedonbehalfby

Unique identifier of the delegate user who modified the SharePoint site record.

_ownerid_value

ownerid

Unique identifier of the user or team who owns the SharePoint site.

_owningbusinessunit_value

owningbusinessunit

Unique identifier for the business unit that owns the document location record.

_owningteam_value

owningteam

Unique identifier of the team that owns the SharePoint site record.

_owninguser_value

owninguser

Unique identifier of the user who owns the SharePoint site record.

_parentsite_value

parentsite

Unique identifier of the parent SharePoint site.

_transactioncurrencyid_value

transactioncurrencyid

Unique identifier of the currency associated with the SharePoint site 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_sharepointsitebase_createdby

createdonbehalfby

systemuser EntityType

lk_sharepointsitebase_createdonbehalfby

modifiedby

systemuser EntityType

lk_sharepointsitebase_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_sharepointsitebase_modifiedonbehalfby

ownerid

principal EntityType

owner_sharepointsite

owningbusinessunit

businessunit EntityType

business_unit_sharepointsites

owningteam

team EntityType

team_sharepointsite

owninguser

systemuser EntityType

user_sharepointsite

parentsite

sharepointsite EntityType

sharepointsite_parentsite_sharepointsite

transactioncurrencyid

transactioncurrency EntityType

TransactionCurrency_SharePointSite

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_parent_sharepointsite

sharepointdocumentlocation EntityType

parentsiteorlocation_sharepointsite

SharePointSite_AsyncOperations

asyncoperation EntityType

regardingobjectid_sharepointsite

SharePointSite_DuplicateBaseRecord

duplicaterecord EntityType

baserecordid_sharepointsite

SharePointSite_DuplicateMatchingRecord

duplicaterecord EntityType

duplicaterecordid_sharepointsite

sharepointsite_parentsite_sharepointsite

sharepointsite EntityType

parentsite

SharePointSite_SyncErrors

syncerror EntityType

regardingobjectid_sharepointsite_syncerror

Operations bound to sharepointsite

The following operations are bound to the sharepointsite entity type.

Name

Bound to

RetrieveAbsoluteAndSiteCollectionUrl Function

Entity

Operations using the sharepointsite entity type.

The following operations use the sharepointsite 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