sharedworkspacepool table/entity reference

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.

Contains metadata about a container used to store real-time collaboration data. Once claimed, a sharedworkspace record would be created with copied metadata.

Added by: Real-time Collaboration App Solution

Messages

Message Web API Operation SDK class or method
Create POST /sharedworkspacepools
See Create
CreateRequest or
Create
Delete DELETE /sharedworkspacepools(sharedworkspacepoolid)
See Delete
DeleteRequest or
Delete
Retrieve GET /sharedworkspacepools(sharedworkspacepoolid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET /sharedworkspacepools
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
Update PATCH /sharedworkspacepools(sharedworkspacepoolid)
See Update
UpdateRequest or
Update

Properties

Property Value
CollectionSchemaName sharedworkspacepools
DisplayCollectionName Shared Workspace Pools
DisplayName Shared Workspace Pool
EntitySetName sharedworkspacepools
IsBPFEntity False
LogicalCollectionName sharedworkspacepools
LogicalName sharedworkspacepool
OwnershipType None
PrimaryIdAttribute sharedworkspacepoolid
PrimaryNameAttribute name
SchemaName sharedworkspacepool

Writable columns/attributes

These columns/attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

Claimed

Property Value
Description Enabled when the sharedworkspacepool record has been claimed
DisplayName Whether or not the sharedworkspacepool record has been claimed or not
IsValidForForm False
IsValidForRead True
LogicalName claimed
RequiredLevel SystemRequired
Type Boolean

Claimed Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: 0

DiscoveryEndpoint

Property Value
Description Discovery Endpoint
DisplayName Discovery Endpoint
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName discoveryendpoint
MaxLength 256
RequiredLevel SystemRequired
Type String

ImportSequenceNumber

Property Value
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

Name

Property Value
Description Name. Unused, but entity required to have a string PrimaryName field
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName name
MaxLength 256
RequiredLevel None
Type String

OrdererEndpoint

Property Value
Description Orderer Endpoint
DisplayName Orderer Endpoint
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName ordererendpoint
MaxLength 256
RequiredLevel SystemRequired
Type String

OverriddenCreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time that the record was migrated.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

sharedworkspacepoolId

Property Value
Description Unique identifier for instance of entity. Corresponds to the FRS container Id
DisplayName SharedWorkspacePoolId
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName sharedworkspacepoolid
RequiredLevel SystemRequired
Type Uniqueidentifier

statecode

Property Value
Description Status of the Shared Workspace Pool
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

statecode Choices/Options

Value Label DefaultStatus InvariantName
0 Active 1 Active
1 Inactive 2 Inactive

statuscode

Property Value
Description Reason for the status of the Shared Workspace Pool
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

statuscode Choices/Options

Value Label State
1 Active 0
2 Inactive 1

StorageEndpoint

Property Value
Description Storage Endpoint
DisplayName Storage Endpoint
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName storageendpoint
MaxLength 256
RequiredLevel SystemRequired
Type String

TenantId

Property Value
Description The tenant where the workspace resides
DisplayName Tenant ID
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName tenantid
RequiredLevel SystemRequired
Type Uniqueidentifier

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

CreatedBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the user who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was created.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the delegate user who created the record.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the user who modified the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the delegate user who modified the record.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

VersionNumber

Added by: Active Solution Solution

Property Value
Description Version Number
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

sharedworkspacepool_SyncErrors

Added by: System Solution Solution

Same as the sharedworkspacepool_SyncErrors many-to-one relationship for the syncerror table/entity.

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName sharedworkspacepool_SyncErrors
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

sharedworkspacepool_AsyncOperations

Added by: System Solution Solution

Same as the sharedworkspacepool_AsyncOperations many-to-one relationship for the asyncoperation table/entity.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName sharedworkspacepool_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

sharedworkspacepool_MailboxTrackingFolders

Added by: System Solution Solution

Same as the sharedworkspacepool_MailboxTrackingFolders many-to-one relationship for the mailboxtrackingfolder table/entity.

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName sharedworkspacepool_MailboxTrackingFolders
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

sharedworkspacepool_ProcessSession

Added by: System Solution Solution

Same as the sharedworkspacepool_ProcessSession many-to-one relationship for the processsession table/entity.

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName sharedworkspacepool_ProcessSession
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

sharedworkspacepool_BulkDeleteFailures

Added by: System Solution Solution

Same as the sharedworkspacepool_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure table/entity.

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName sharedworkspacepool_BulkDeleteFailures
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

sharedworkspacepool_PrincipalObjectAttributeAccesses

Added by: System Solution Solution

Same as the sharedworkspacepool_PrincipalObjectAttributeAccesses many-to-one relationship for the principalobjectattributeaccess table/entity.

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName sharedworkspacepool_PrincipalObjectAttributeAccesses
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related table. Listed by SchemaName.

lk_sharedworkspacepool_createdby

Added by: System Solution Solution

See the lk_sharedworkspacepool_createdby one-to-many relationship for the systemuser table/entity.

lk_sharedworkspacepool_createdonbehalfby

Added by: System Solution Solution

See the lk_sharedworkspacepool_createdonbehalfby one-to-many relationship for the systemuser table/entity.

lk_sharedworkspacepool_modifiedby

Added by: System Solution Solution

See the lk_sharedworkspacepool_modifiedby one-to-many relationship for the systemuser table/entity.

lk_sharedworkspacepool_modifiedonbehalfby

Added by: System Solution Solution

See the lk_sharedworkspacepool_modifiedonbehalfby one-to-many relationship for the systemuser table/entity.

See also

Dataverse table/entity reference
Web API Reference
sharedworkspacepool EntityType