Shared Workspace Pool (sharedworkspacepool) table/entity reference

Article
11/09/2024

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

Messages

The following table lists the messages for the Shared Workspace Pool (sharedworkspacepool) table. Messages represent operations that can be performed on the table. They may also be events.

Name Is Event?	Web API Operation	SDK for .NET
`Create` Event: True	`POST` /sharedworkspacepools See Create	Create records
`Delete` Event: True	`DELETE` /sharedworkspacepools(sharedworkspacepoolid) See Delete	Delete records
`Retrieve` Event: True	`GET` /sharedworkspacepools(sharedworkspacepoolid) See Retrieve	Retrieve records
`RetrieveMultiple` Event: True	`GET` /sharedworkspacepools See Query data	Query data
`Update` Event: True	`PATCH` /sharedworkspacepools(sharedworkspacepoolid) See Update	Update records
`Upsert` Event: False	`PATCH` /sharedworkspacepools(sharedworkspacepoolid) See Upsert a table row	UpsertRequest

Properties

The following table lists selected properties for the Shared Workspace Pool (sharedworkspacepool) table.

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

Writable columns/attributes

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

Claimed
DiscoveryEndpoint
ImportSequenceNumber
Name
OrdererEndpoint
OverriddenCreatedOn
sharedworkspacepoolId
statecode
statuscode
StorageEndpoint
TenantId
TimeZoneRuleVersionNumber
UTCConversionTimeZoneCode

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
GlobalChoiceName	`sharedworkspacepool_claimed`
DefaultValue	False
True Label	Yes
False Label	No

DiscoveryEndpoint

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

ImportSequenceNumber

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

Name

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

OrdererEndpoint

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

OverriddenCreatedOn

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

sharedworkspacepoolId

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

statecode

Property	Value
Description	Status of the workspace
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	`statecode`
RequiredLevel	SystemRequired
Type	State
DefaultFormValue
GlobalChoiceName	`sharedworkspacepool_statecode`

statecode Choices/Options

Value	Details
0	Label: Active DefaultStatus: 1 InvariantName: `Active`
1	Label: Inactive DefaultStatus: 2 InvariantName: `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
DefaultFormValue
GlobalChoiceName	`sharedworkspacepool_statuscode`

statuscode Choices/Options

Value	Details
1	Label: Active State:0 TransitionData: None
2	Label: Inactive State:1 TransitionData: None

StorageEndpoint

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

TenantId

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

TimeZoneRuleVersionNumber

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

UTCConversionTimeZoneCode

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

Read-only columns/attributes

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

CreatedBy
CreatedOn
CreatedOnBehalfBy
ModifiedBy
ModifiedOn
ModifiedOnBehalfBy
VersionNumber

CreatedBy

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

CreatedOn

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

CreatedOnBehalfBy

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
Type	Lookup
Targets	systemuser

ModifiedBy

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

ModifiedOn

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

ModifiedOnBehalfBy

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
Type	Lookup
Targets	systemuser

VersionNumber

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

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

lk_sharedworkspacepool_createdby
lk_sharedworkspacepool_createdonbehalfby
lk_sharedworkspacepool_modifiedby
lk_sharedworkspacepool_modifiedonbehalfby

lk_sharedworkspacepool_createdby

One-To-Many Relationship: systemuser lk_sharedworkspacepool_createdby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`createdby`
ReferencingEntityNavigationPropertyName	`createdby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_sharedworkspacepool_createdonbehalfby

One-To-Many Relationship: systemuser lk_sharedworkspacepool_createdonbehalfby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`createdonbehalfby`
ReferencingEntityNavigationPropertyName	`createdonbehalfby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_sharedworkspacepool_modifiedby

One-To-Many Relationship: systemuser lk_sharedworkspacepool_modifiedby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`modifiedby`
ReferencingEntityNavigationPropertyName	`modifiedby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

lk_sharedworkspacepool_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_sharedworkspacepool_modifiedonbehalfby

Property	Value
ReferencedEntity	`systemuser`
ReferencedAttribute	`systemuserid`
ReferencingAttribute	`modifiedonbehalfby`
ReferencingEntityNavigationPropertyName	`modifiedonbehalfby`
IsHierarchical
CascadeConfiguration	Archive: `NoCascade` Assign: `NoCascade` Delete: `NoCascade` Merge: `NoCascade` Reparent: `NoCascade` RollupView: `NoCascade` Share: `NoCascade` Unshare: `NoCascade`

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

sharedworkspacepool_AsyncOperations
sharedworkspacepool_BulkDeleteFailures
sharedworkspacepool_MailboxTrackingFolders
sharedworkspacepool_PrincipalObjectAttributeAccesses
sharedworkspacepool_ProcessSession
sharedworkspacepool_SyncErrors

sharedworkspacepool_AsyncOperations

Many-To-One Relationship: asyncoperation sharedworkspacepool_AsyncOperations

Property	Value
ReferencingEntity	`asyncoperation`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`sharedworkspacepool_AsyncOperations`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

sharedworkspacepool_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure sharedworkspacepool_BulkDeleteFailures

Property	Value
ReferencingEntity	`bulkdeletefailure`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`sharedworkspacepool_BulkDeleteFailures`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

sharedworkspacepool_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder sharedworkspacepool_MailboxTrackingFolders

Property	Value
ReferencingEntity	`mailboxtrackingfolder`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`sharedworkspacepool_MailboxTrackingFolders`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

sharedworkspacepool_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess sharedworkspacepool_PrincipalObjectAttributeAccesses

Property	Value
ReferencingEntity	`principalobjectattributeaccess`
ReferencingAttribute	`objectid`
ReferencedEntityNavigationPropertyName	`sharedworkspacepool_PrincipalObjectAttributeAccesses`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

sharedworkspacepool_ProcessSession

Many-To-One Relationship: processsession sharedworkspacepool_ProcessSession

Property	Value
ReferencingEntity	`processsession`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`sharedworkspacepool_ProcessSession`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

sharedworkspacepool_SyncErrors

Many-To-One Relationship: syncerror sharedworkspacepool_SyncErrors

Property	Value
ReferencingEntity	`syncerror`
ReferencingAttribute	`regardingobjectid`
ReferencedEntityNavigationPropertyName	`sharedworkspacepool_SyncErrors`
IsCustomizable	`True`
AssociatedMenuConfiguration	AvailableOffline: True Behavior: `DoNotDisplay` Group: `Details` Label: MenuId: null Order: QueryApi: null ViewId: `00000000-0000-0000-0000-000000000000`

Share via