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
Values Label
1 Yes
0 No
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
Values Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the Shared Workspace Pool

Display Name: Status Reason

Default Options
Values Label
1 Active
2 Inactive
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

See also