Operation: EditSystemSettingsV202405
Edit system settings
Type Reference: SystemSettingsRequestV202405
| Parameter | Description | Type |
|---|---|---|
| defaultTopmostSpaceId | Default topmost space ID for new users Required (defined) | integer |
| billPayCutoverEndDate | Cut over date when EnergyCAP officially takes over bill payments. In order to modify this date, the user needs to have Special Permission (ECAP) and LicenseFeatureEnergyCAPPayments. It’s not possible to change the field to null since the value is mandatory for (ECAP) and LicenseFeatureEnergyCAPPayments. For non (ECAP) and/or non LicenseFeatureEnergyCAPPayments users, use null or inform same value provided in the GET endpoint. Required (defined) |
string |
| defaultTopmostCollectionId | Default topmost collection ID for new users Required (defined) | integer |
| organizationName | The organization name Required (defined) | string |
| displayOrganizationNameInHeader | Indicates whether or not organization name should be displayed in the application header Required | boolean |
| organizationLogo | The organization logo May be a base64-encoded PNG, JPG, or SVG image or a URI for an image hosted online A null value will clear the saved image Min length of 5 Required (defined) |
string |
| automaticLogoutMinutes | Number of minutes after which users will be automatically logged out Must be between 10 and 780 Required (defined) | integer |
| defaultCountry | Default country for new users Required (defined) | string |
| defaultMeterTimeZoneId | ID of the default time zone for new meters Required | integer |
| defaultDateFormat | Default date format for new users One of ‘MM/dd/yyyy’, ‘dd/MM/yyyy’ Case sensitive Required (defined) | string |
| defaultTopmostCostCenterId | Default topmost cost center ID for new users Required (defined) | integer |
| defaultTopmostPlaceId | Default topmost place ID for new users Required (defined) | integer |
| defaultUserRoleId | Default user role ID for new users Required (defined) | integer |
| monthsToExcludeFromCharts | Months to exclude from charts, including the current month. Set to 2 months by default. Ex. If the current month is October, A value of 0 will not exclude any months, A value of 1 will exclude the month of October, A value of 2 will exclude October and September, A value of 3 will exclude October, September, and August, A value of 13 will exclude October and the last full year of data. A null value will preserve the existing setting. Must be between 0 and 13 Required (defined) |
integer |
{
"defaultTopmostSpaceId": 1,
"billPayCutoverEndDate": "2025-10-17",
"defaultTopmostCollectionId": 1,
"organizationName": "string",
"displayOrganizationNameInHeader": false,
"organizationLogo": "string",
"automaticLogoutMinutes": 1,
"defaultCountry": "string",
"defaultMeterTimeZoneId": 1,
"defaultDateFormat": "string",
"defaultTopmostCostCenterId": 1,
"defaultTopmostPlaceId": 1,
"defaultUserRoleId": 1,
"monthsToExcludeFromCharts": 1
}Type Reference: SystemSettingsResponse
| Parameter | Description | Type |
|---|---|---|
| organizationName | The organization name | string |
| displayOrganizationNameInHeader | Indicates whether or not organization name should be displayed in the application header | boolean |
| organizationLogo | The organization logo May be a base64-encoded PNG, JPG, or SVG image or a URI for an image hosted online A null value will clear the saved image |
string |
| automaticLogoutMinutes | Number of minutes after which users will be automatically logged out | integer |
| defaultCountry | Default country for new users | string |
| defaultMeterTimeZone | TimeZoneResponse | |
| timeZoneId | The time zone id | integer |
| timeZoneCode | The time zone code | string |
| timeZoneInfo | The time zone info | string |
| gmtOffset | The time zone gmt offset | number |
| daylightSavingsObserved | Indicates if the time zone observes daylight savings time or not | boolean |
| defaultDateFormat | Default date format for new users | string |
| defaultTopmostPlace | PlaceChild | |
| placeType | PlaceTypeResponse | |
| placeTypeId | The place type identifier | integer |
| placeTypeCode | The place type code | string |
| placeTypeInfo | The place type info | string |
| structure | Indicates if the place is a structure | boolean |
| icon | Icon | |
| code | The icon code Must be between 0 and 64 characters Required when Color is set | string |
| color | The icon color Must be between 0 and 32 characters Required when Code is set | string |
| placeEntityType | PlaceEntityTypeV202406 | |
| placeEntityTypeId | The place entity type identifier | integer |
| placeEntityTypeInfo | The place entity type name | string |
| isSystemPlaceType | Flag to indicate if the place type is a system-level place type | boolean |
| isDataRolledUp | Tells whether or not the place’s data is rolled up to its parents. | boolean |
| placeId | The place identifier | integer |
| placeCode | The place code | string |
| placeInfo | The place info | string |
| defaultCostCenter | CostCenterChild | |
| costCenterId | The cost center identifier | integer |
| costCenterCode | The cost center code | string |
| costCenterInfo | The cost center info | string |
| defaultCollection | CollectionChild | |
| collectionId | The collection identifier | integer |
| collectionCode | The collection code | string |
| collectionInfo | The collection info | string |
| collectionIcon | Icon | |
| code | The icon code Must be between 0 and 64 characters Required when Color is set | string |
| color | The icon color Must be between 0 and 32 characters Required when Code is set | string |
| defaultTopmostSpace | PlaceChild | |
| placeType | PlaceTypeResponse | |
| placeTypeId | The place type identifier | integer |
| placeTypeCode | The place type code | string |
| placeTypeInfo | The place type info | string |
| structure | Indicates if the place is a structure | boolean |
| icon | Icon | |
| code | The icon code Must be between 0 and 64 characters Required when Color is set | string |
| color | The icon color Must be between 0 and 32 characters Required when Code is set | string |
| placeEntityType | PlaceEntityTypeV202406 | |
| placeEntityTypeId | The place entity type identifier | integer |
| placeEntityTypeInfo | The place entity type name | string |
| isSystemPlaceType | Flag to indicate if the place type is a system-level place type | boolean |
| isDataRolledUp | Tells whether or not the place’s data is rolled up to its parents. | boolean |
| placeId | The place identifier | integer |
| placeCode | The place code | string |
| placeInfo | The place info | string |
| defaultUserRole | SystemUserRoleChild | |
| userRoleId | The user role identifier | integer |
| userRoleInfo | The user role name | string |
| monthsToExcludeFromCharts | Number of months to exclude from powerview charts | integer |
| billPayCutoverEndDate | Cut over date when EnergyCAP officially takes over bill payments | string |
{
"organizationName": "string",
"displayOrganizationNameInHeader": false,
"organizationLogo": "string",
"automaticLogoutMinutes": 1,
"defaultCountry": "string",
"defaultMeterTimeZone": {
"timeZoneId": 1,
"timeZoneCode": "string",
"timeZoneInfo": "string",
"gmtOffset": 1.0,
"daylightSavingsObserved": false
},
"defaultDateFormat": "string",
"defaultTopmostPlace": {
"placeType": {
"placeTypeId": 1,
"placeTypeCode": "string",
"placeTypeInfo": "string",
"structure": false,
"icon": {
"code": "string",
"color": "string"
},
"placeEntityType": {
"placeEntityTypeId": 1,
"placeEntityTypeInfo": "string"
},
"isSystemPlaceType": false
},
"isDataRolledUp": false,
"placeId": 1,
"placeCode": "string",
"placeInfo": "string"
},
"defaultCostCenter": {
"costCenterId": 1,
"costCenterCode": "string",
"costCenterInfo": "string"
},
"defaultCollection": {
"collectionId": 1,
"collectionCode": "string",
"collectionInfo": "string",
"collectionIcon": {
"code": "string",
"color": "string"
}
},
"defaultTopmostSpace": {
"placeType": {
"placeTypeId": 1,
"placeTypeCode": "string",
"placeTypeInfo": "string",
"structure": false,
"icon": {
"code": "string",
"color": "string"
},
"placeEntityType": {
"placeEntityTypeId": 1,
"placeEntityTypeInfo": "string"
},
"isSystemPlaceType": false
},
"isDataRolledUp": false,
"placeId": 1,
"placeCode": "string",
"placeInfo": "string"
},
"defaultUserRole": {
"userRoleId": 1,
"userRoleInfo": "string"
},
"monthsToExcludeFromCharts": 1,
"billPayCutoverEndDate": "2025-10-17"
}