Applications.Cms.WebSites Entity

Namespace: Applications.Cms

Contains the public web sites. Entity: Cms_Web_Sites (Obsoleted in version 22.1.6.73)

Note

OBSOLETE! Do not use!

Default Visualization

Default Display Text Format:
{Name}
Default Search Members:
Name
Name Data Member:
Name
Category: Definitions
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Tree

• Applications.Cms.WebSites
  • Applications.Cms.NewsWebModules
  • Applications.Cms.ProductCatalogWebModules
  • Applications.Cms.StaticWebModules
  • Applications.Cms.WebModules
  • Applications.Cms.WebSiteLanguages

Attributes

Name	Type	Description
BaseUrl	string (256) nullable	The base url (address) of the web site. Filter(like)
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
IsPublished	boolean	Specifies whether the site is published for public Internet access. Required Default(false) Filter(eq)
Name	string (256)	Multilanguage web site name. Required Filter(like)
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

References

Name	Type	Description
EnterpriseCompany	EnterpriseCompanies	The enterprise company to which this web site belongs. Required Filter(multi eq)
PublicUserList	PublicUserLists (nullable)	OBSOLETE! Do not use! The list of users used to authorize the users on the site. Obsolete Filter(multi eq) Obsoleted in version 25.1.1.64 Obsolete

Child Collections

Name	Type	Description
Languages	WebSiteLanguages	List of WebSiteLanguage(Applications.Cms.WebSiteLanguages.md) child objects, based on the Applications.Cms.WebSiteLanguage.WebSite(Applications.Cms.WebSiteLanguages.md#website) back reference
WebModules	WebModules	List of WebModule child objects, based on the Applications.Cms.WebModule.WebSite back reference

Attribute Details

BaseUrl

The base url (address) of the web site. Filter(like)

Type: string (256) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 256
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

IsPublished

Specifies whether the site is published for public Internet access. Required Default(false) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault

Name

Multilanguage web site name. Required Filter(like)

Type: string (256)
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 256
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Reference Details

EnterpriseCompany

The enterprise company to which this web site belongs. Required Filter(multi eq)

Type: EnterpriseCompanies
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

PublicUserList

OBSOLETE! Do not use! The list of users used to authorize the users on the site. Obsolete Filter(multi eq) Obsoleted in version 25.1.1.64 Obsolete

Type: PublicUserLists (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

• customPropertyCode
  The code of the custom property
  Type: string

• search
  The search text - searches by value or description. Can contain wildcard character %.
  Type: string
  Optional: True
  Default Value: null

• exactMatch
  If true the search text should be equal to the property value
  Type: boolean
  Optional: True
  Default Value: False

• orderByDescription
  If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
  Type: boolean
  Optional: True
  Default Value: False

• top
  The top clause - default is 10
  Type: int32
  Optional: True
  Default Value: 10

• skip
  The skip clause - default is 0
  Type: int32
  Optional: True
  Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST

Parameters

• user
  The user.
  Type: Users

• notificationClass
  The notification class.
  Type: string

• subject
  The notification subject.
  Type: string

CreateCopy

Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST

Business Rules

None

Front-End Business Rules

None

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/Applications_Cms_WebSites?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Applications_Cms_WebSites?$top=10