Get /api/v3/admin/systemSettings

Operation: GetSystemSettingsNewV3

Summary

Get system settings

Response Parameters

HTTP 200


Body Parameters

Content Type: application/json

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

Responses

HTTP 200

Body

Content Type: application/json
{
  "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
}