sharedworkspacepool EntityType
Contains metadata about a container used to store real-time collaboration data. Once claimed, a sharedworkspace record would be created with copied metadata.
- Entity set path:
- [organization URI]/api/data/v9.2/sharedworkspacepools
- Base type:
- crmbaseentity
- Display name:
- Shared Workspace Pool
- Primary key:
- sharedworkspacepoolid
- Primary key attribute:
- 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 | ||||||
|---|---|---|---|---|---|---|---|---|
| claimed | Edm.Boolean |
Enabled when the sharedworkspacepool record has been claimed Display name: Whether or not the sharedworkspacepool record has been claimed or not
Default options
|
||||||
| createdon | Edm.DateTimeOffset |
Date and time when the record was created. Display name: Created On Read only
|
||||||
| discoveryendpoint | Edm.String |
Discovery Endpoint Display name: Discovery Endpoint |
||||||
| importsequencenumber | Edm.Int32 |
Sequence number of the import that created this record. Display name: Import Sequence Number |
||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the record was modified. Display name: Modified On Read only
|
||||||
| name | Edm.String |
Name. Unused, but entity required to have a string PrimaryName field Display name: Name |
||||||
| ordererendpoint | Edm.String |
Orderer Endpoint Display name: Orderer Endpoint |
||||||
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display name: Record Created On |
||||||
| sharedworkspacepoolid | Edm.Guid |
Unique identifier for instance of entity. Corresponds to the FRS container Id Display name: SharedWorkspacePoolId |
||||||
| statecode | Edm.Int32 |
Status of the Shared Workspace Pool Display name: Status
Default options
|
||||||
| statuscode | Edm.Int32 |
Reason for the status of the Shared Workspace Pool Display name: Status Reason
Default options
|
||||||
| storageendpoint | Edm.String |
Storage Endpoint Display name: Storage Endpoint |
||||||
| tenantid | Edm.Guid |
The tenant where the workspace resides Display name: Tenant ID |
||||||
| timezoneruleversionnumber | Edm.Int32 |
For internal use only. Display name: Time Zone Rule Version Number |
||||||
| utcconversiontimezonecode | Edm.Int32 |
Time zone code that was in use when the record was created. Display name: UTC Conversion Time Zone Code |
||||||
| versionnumber | Edm.Int64 |
Version Number Display name: Version Number 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 record. |
| _createdonbehalfby_value | createdonbehalfby |
Unique identifier of the delegate user who created the record. |
| _modifiedby_value | modifiedby |
Unique identifier of the user who modified the record. |
| _modifiedonbehalfby_value | modifiedonbehalfby |
Unique identifier of the delegate user who modified the 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_sharedworkspacepool_createdby |
| createdonbehalfby | systemuser | lk_sharedworkspacepool_createdonbehalfby |
| modifiedby | systemuser | lk_sharedworkspacepool_modifiedby |
| modifiedonbehalfby | systemuser | lk_sharedworkspacepool_modifiedonbehalfby |
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 |
|---|---|---|
| sharedworkspacepool_AsyncOperations | asyncoperation | regardingobjectid_sharedworkspacepool |
| sharedworkspacepool_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_sharedworkspacepool |
| sharedworkspacepool_MailboxTrackingFolders | mailboxtrackingfolder | regardingobjectid_sharedworkspacepool |
| sharedworkspacepool_PrincipalObjectAttributeAccesses | principalobjectattributeaccess | objectid_sharedworkspacepool |
| sharedworkspacepool_ProcessSession | processsession | regardingobjectid_sharedworkspacepool |
| sharedworkspacepool_SyncErrors | syncerror | regardingobjectid_sharedworkspacepool |