sharepointsite EntityType
SharePoint site from where documents can be managed in Microsoft Dynamics 365.
- Entity set path:
- [organization URI]/api/data/v9.2/sharepointsites
- Base type:
- crmbaseentity
- Display name:
- SharePoint Site
- Primary key:
- sharepointsiteid
- 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 site. Display name: Absolute URL |
||||||||||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the SharePoint site record was created. Display name: Created On Read only
|
||||||||||||||||
| description | Edm.String |
Description of the SharePoint site record. Display name: Description |
||||||||||||||||
| exchangerate | Edm.Decimal |
Exchange rate between the currency associated with the SharePoint site record and the base currency. Display name: Exchange Rate Read only
|
||||||||||||||||
| folderstructureentity | Edm.String |
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 |
Sequence number of the import that created this record. Display name: Import Sequence Number |
||||||||||||||||
| isdefault | Edm.Boolean |
Indicates whether the SharePoint site is the default site or not. Display name: Default Site
Default options
|
||||||||||||||||
| isgridpresent | Edm.Boolean |
Indicates if SharePoint Grid is present or not. Display name: List component is installed
Default options
|
||||||||||||||||
| ispowerbisite | Edm.Boolean |
Allows embedding of Power BI Reports available in this SharePoint site. Display name: Allow Embedding of Power BI Reports
Default options
|
||||||||||||||||
| lastvalidated | Edm.DateTimeOffset |
Date and time when the SharePoint site URL was last validated. Display name: Last Validated |
||||||||||||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the SharePoint site record was last modified. Display name: Modified On Read only
|
||||||||||||||||
| name | Edm.String |
Name of the SharePoint site 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 site. Display name: Relative URL |
||||||||||||||||
| servicetype | Edm.Int32 |
Shows the service type of location of the SharePoint site. Display name: Service Type
Default options
|
||||||||||||||||
| sharepointsiteid | Edm.Guid |
Unique identifier of the SharePoint site in Dynamics 365 Display name: SharePoint Site ID |
||||||||||||||||
| sitecollectionid | Edm.Guid |
For internal use only. Read only
|
||||||||||||||||
| statecode | Edm.Int32 |
Status of the SharePoint site record. Display name: Status
Default options
|
||||||||||||||||
| statuscode | Edm.Int32 |
Reason for the status of the SharePoint site record. Display name: Status Reason
Default options
|
||||||||||||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. |
||||||||||||||||
| userid | Edm.Guid |
Choose the user who owns the SharePoint site. Display name: SharePoint Site Owner |
||||||||||||||||
| utcconversiontimezonecode | Edm.Int32 |
Time zone code that was in use when the record was created. |
||||||||||||||||
| validationstatus | Edm.Int32 |
Validation status of the SharePoint site URL. Display name: Last Validation Status
Default options
|
||||||||||||||||
| validationstatuserrorcode | Edm.Int32 |
Reason for validation status of the URL Display name: Additional Information
Default options
|
||||||||||||||||
| 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 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 | lk_sharepointsitebase_createdby |
| createdonbehalfby | systemuser | lk_sharepointsitebase_createdonbehalfby |
| modifiedby | systemuser | lk_sharepointsitebase_modifiedby |
| modifiedonbehalfby | systemuser | lk_sharepointsitebase_modifiedonbehalfby |
| ownerid | principal | owner_sharepointsite |
| owningbusinessunit | businessunit | business_unit_sharepointsites |
| owningteam | team | team_sharepointsite |
| owninguser | systemuser | user_sharepointsite |
| parentsite | sharepointsite | sharepointsite_parentsite_sharepointsite |
| transactioncurrencyid | transactioncurrency | 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 | parentsiteorlocation_sharepointsite |
| SharePointSite_AsyncOperations | asyncoperation | regardingobjectid_sharepointsite |
| SharePointSite_DuplicateBaseRecord | duplicaterecord | baserecordid_sharepointsite |
| SharePointSite_DuplicateMatchingRecord | duplicaterecord | duplicaterecordid_sharepointsite |
| sharepointsite_parentsite_sharepointsite | sharepointsite | parentsite |
| sharepointsite_principalobjectattributeaccess | principalobjectattributeaccess | objectid_sharepointsite |
| SharePointSite_ProcessSessions | processsession | regardingobjectid_sharepointsite |
| SharePointSite_SyncErrors | syncerror | regardingobjectid_sharepointsite_syncerror |
Operations
The following operations can be used with the sharepointsite entity type.
| Name | Binding |
|---|---|
| GrantAccess | Not Bound |
| ModifyAccess | Not Bound |
| RetrieveAbsoluteAndSiteCollectionUrl | Bound to Entity |
| RetrievePrincipalAccess | Not Bound |
| RetrieveSharedPrincipalsAndAccess | Not Bound |
| RevokeAccess | Not Bound |