Sites Model
Overview
The sites table is used to configure and manage individual site instances or tenants in a multi-tenant or SaaS-style architecture. Each site has its own branding, features, preferences, and configurations.
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| id | string | A unique identifier for the site. | ❌ |
| siteName | string | The name assigned to the site. | ✅ |
| isEndUserLicenseAgreementEnabled | boolean | isEndUserLicenseAgreementEnabled field | ❌ |
| storageType | any | Specifies the type of storage used by the site. | ❌ |
| selectedLanguages | any | Contains the languages selected for the site. | ❌ |
| siteUrl | string | The base URL of the site (used for routing, branding, etc.). | ✅ |
| installUrl | string | Installation or onboarding URL for the site setup. | ❌ |
| sitelogo | string | Path or URL to the logo used for this site (for branding). | ❌ |
| description | string | Description of the site’s purpose, client, or context. | ❌ |
| idleTime | number | The amount of idle time before a session timeout. | ❌ |
| isActive | boolean | Indicates if the site is currently active or deactivated (1 = active). | ❌ |
| storagePath | any | The storage path where site-related data is stored | ❌ |
| liecenses | string | Information about the licenses associated with the site. | ❌ |
| created_at | date | The date and time when the site was created. | ❌ |
| modified_at | date | The date and time when the site was last modified. | ❌ |
| ignoreSSL | boolean | A flag indicating whether SSL verification is ignored. | ❌ |
| enableElasticSearch | boolean | A flag indicating whether Elasticsearch is enabled for the site. | ❌ |
| isSocketEnabled | boolean | isSocketEnabled field | ❌ |
| ignoreDeviceInfo | boolean | A flag determining whether device information is ignored. | ❌ |
| defaultOrg | string | The default organization associated with the site. | ❌ |
| resignDuration | number | Time (in minutes or seconds) after which digital signatures (or token-based signatures) expire or must be re-entered. | ❌ |
| isSystemGenerated | boolean | A flag indicating whether the site was system-generated. | ❌ |
| buildTypes | array | Specifies the types of builds associated with the site. | ❌ |
| pinFormat | string | Format for the site’s PIN (personal identification number), if used. | ❌ |
| pinLength | number | The required length for a PIN used on the site. | ❌ |
| type | string | Specifies the type or category of the site. | ❌ |
| footerMenus | array | Contains details about the footer menus of the site. | ❌ |
| publicSites | array | List or flag indicating if the site is accessible publicly (i.e., without login), could include allowed routes/pages. | ❌ |
Relationships
- Hasmany Unknown
- Hasone Unknown
- Hasmany Unknown
Sample JSON
{
"id": "example_value",
"siteName": "example_value",
"isEndUserLicenseAgreementEnabled": "example_value",
"storageType": "example_value",
"selectedLanguages": "example_value",
"siteUrl": "example_value",
"installUrl": "example_value",
"sitelogo": "example_value",
"description": "example_value",
"idleTime": "example_value",
"isActive": "example_value",
"storagePath": "example_value",
"liecenses": "example_value",
"created_at": "example_value",
"modified_at": "example_value",
"ignoreSSL": "example_value",
"enableElasticSearch": "example_value",
"isSocketEnabled": "example_value",
"ignoreDeviceInfo": "example_value",
"defaultOrg": "example_value",
"resignDuration": "example_value",
"isSystemGenerated": "example_value",
"buildTypes": "example_value",
"pinFormat": "example_value",
"pinLength": "example_value",
"type": "example_value",
"footerMenus": "example_value",
"publicSites": "example_value"
}