Systems.Core.WebSites Entity

Namespace: Systems.Core

Contains the web sites, which are hosted for the database. Entity: Sys_Web_Sites (Introduced in version 19.1)

Default Visualization

Default Display Text Format:
{Id}: {EnterpriseCompanyId}
Default Search Members:
__
Category: Settings
Show in UI: ShownByDefault

Aggregate

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

Aggregate Tree

Attributes

Name Type Description
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id guid
IsActive boolean Indicates whether the web site is active and will be instantiated upon next web server restart. Required Default(true) Filter(eq)
IsPrivate boolean Specifies that the web site address will not be publicly listed. The web site itself will still be publicly accessible; only its URL would not be listed in the auto-discovery service. Required Default(false) Filter(eq) Introduced in version 23.1.0.8
Notes string (max) nullable Notes for this WebSite.
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.
RelativeUrl string (254) nullable The relative Url of the site. This is the text after the first slash after the protocol and host name. The text should not include the protocol and host name. null means that the site will be hosted as the root site in the speicified web host.
SettingsJson string (max) nullable The field specifies the JSON settings for this website. null means that there are no specific settings for this website. Introduced in version 23.1.0.37
WebSiteType WebSiteType The type of web site - Api, Client Center, Id, etc. Required Filter(multi eq)

References

Name Type Description
EnterpriseCompany EnterpriseCompanies (nullable) The enterprise company, for which is the site. null means, that the web site should not be enterprise company specific. Filter(multi eq)
TrustedApplication TrustedApplications (nullable) The trusted application related to this web site. Filter(multi eq) Introduced in version 20.1
WebHost WebHosts (nullable) The web host in which to host the site. Filter(multi eq)

Attribute Details

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

IsActive

Indicates whether the web site is active and will be instantiated upon next web server restart. Required Default(true) Filter(eq)

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

IsPrivate

Specifies that the web site address will not be publicly listed. The web site itself will still be publicly accessible; only its URL would not be listed in the auto-discovery service. Required Default(false) Filter(eq) Introduced in version 23.1.0.8

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

Notes

Notes for this WebSite.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
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

RelativeUrl

The relative Url of the site. This is the text after the first slash after the protocol and host name. The text should not include the protocol and host name. null means that the site will be hosted as the root site in the speicified web host.

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

SettingsJson

The field specifies the JSON settings for this website. null means that there are no specific settings for this website. Introduced in version 23.1.0.37

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

WebSiteType

The type of web site - Api, Client Center, Id, etc. Required Filter(multi eq)

Type: WebSiteType
Category: System
Allowed values for the WebSiteType(Systems.Core.WebSites.md#websitetype) data attribute
Allowed Values (Systems.Core.WebSitesRepository.WebSiteType Enum Members)

Value Description
API Allows external applications to access the ERP resources using REST API.. Stored as 'API'.
Database Value: 'API'
Model Value: 0
Domain API Value: 'API'
ClientCenter Allows community users to access ERP resources. Requires working ID site.. Stored as 'CC'.
Database Value: 'CC'
Model Value: 1
Domain API Value: 'ClientCenter'
ECommerce ECommerce value. Stored as 'EC'.
Database Value: 'EC'
Model Value: 2
Domain API Value: 'ECommerce'
LEGALBG LEGALBG value. Stored as 'LEG'.
Database Value: 'LEG'
Model Value: 3
Domain API Value: 'LEGALBG'
SocialInteractions SocialInteractions value. Stored as 'SI'.
Database Value: 'SI'
Model Value: 4
Domain API Value: 'SocialInteractions'
DigitalMarketplace DigitalMarketplace value. Stored as 'DM'.
Database Value: 'DM'
Model Value: 5
Domain API Value: 'DigitalMarketplace'
WebClientApplication WebClientApplication value. Stored as 'APP'.
Database Value: 'APP'
Model Value: 6
Domain API Value: 'WebClientApplication'
TableAPI TableAPI value. Stored as 'TAP'.
Database Value: 'TAP'
Model Value: 7
Domain API Value: 'TableAPI'
DataAccessAPI DataAccessAPI value. Stored as 'DAP'.
Database Value: 'DAP'
Model Value: 8
Domain API Value: 'DataAccessAPI'
LEGALUK LEGALUK value. Stored as 'LUK'.
Database Value: 'LUK'
Model Value: 9
Domain API Value: 'LEGALUK'
OLAP OLAP value. Stored as 'OLP'.
Database Value: 'OLP'
Model Value: 10
Domain API Value: 'OLAP'

Supported Filters: Equals, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

Reference Details

EnterpriseCompany

The enterprise company, for which is the site. null means, that the web site should not be enterprise company specific. Filter(multi eq)

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

TrustedApplication

The trusted application related to this web site. Filter(multi eq) Introduced in version 20.1

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

WebHost

The web host in which to host the site. Filter(multi eq)

Type: WebHosts (nullable)
Indexed: True
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

Creates a notification and sends 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 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

Front-End Business Rules

API

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

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