Systems.Config.WebHosts Entity

Namespace: Systems.Config

Contains the names and https certificates of the different host names used to host sites. Entity: Sys_Web_Hosts (Introduced in version 19.1)

Renames

Old name: Systems.Core.WebHosts
New name: Systems.Config.WebHosts
Version: 24.1.5.35
Case: 35911

Default Visualization

Default Display Text Format:
{Name}
Default Search Members:
Name
Name Data Member:
Name
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

Systems.Config.WebHosts

Attributes

Name	Type	Description
CertificateContents	byte[] nullable	The contents of the web host certificate. null means to use the server system certificate.
CertificateExpiryDate	date nullable	The expiry date of the certificate. Can be used to track the expiration of the web host certificates. When null, the expiry date was not provided by the user, when uploading the certificate. `Filter(multi eq;ge;le)`
CertificateOriginal Filename	string (254) nullable	The original name of the file, used to upload the certificate. Used only for reference purposes. When null, means that the user did not provide that information when uploading the certificate. `Filter(eq;like)`
CertificatePassword	string (max) nullable	The password, which should be used to decrypt the certificate. null when the certificate has no password or the system certificate is used.
CertificateType	string (3)	The type of certificate uploaded. Currently, only PFX is supported. `Required` `Default("PFX")` `Filter(multi eq)`
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
Name	string (max)	The unique Internet name of the host. Should NOT include protocol name and should NOT include any forward slashes. This is just the dot-separated host name. `Required` `Filter(multi eq;like)`
Notes	string (max) nullable	Notes for this WebHost.
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.

Attribute Details

CertificateContents

The contents of the web host certificate. null means to use the server system certificate.

Type: byte[] nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

CertificateExpiryDate

The expiry date of the certificate. Can be used to track the expiration of the web host certificates. When null, the expiry date was not provided by the user, when uploading the certificate. Filter(multi eq;ge;le)

Type: date nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan, EqualsIn
Supports Order By: False
Show in UI: ShownByDefault

CertificateOriginalFilename

The original name of the file, used to upload the certificate. Used only for reference purposes. When null, means that the user did not provide that information when uploading the certificate. Filter(eq;like)

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

CertificatePassword

The password, which should be used to decrypt the certificate. null when the certificate has no password or the system certificate is used.

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

CertificateType

The type of certificate uploaded. Currently, only PFX is supported. Required Default("PFX") Filter(multi eq)

Type: string (3)
Category: System
Supported Filters: Equals, EqualsIn
Supports Order By: False
Maximum Length: 3
Default Value: PFX
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

Name

The unique Internet name of the host. Should NOT include protocol name and should NOT include any forward slashes. This is just the dot-separated host name. Required Filter(multi eq;like)

Type: string (max)
Category: System
Supported Filters: Equals, Like, EqualsIn
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

Notes

Notes for this WebHost.

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

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