Get Global Settings

Select

SaaS

Customer Managed

Get list of global settings used to modify system default behaviour

Responses

• 200

---

Success

application/json

• Schema
• Example (from schema)
• Global settings

---

Schema

• globalSettings object[]

  name string

  Name of the setting

  displayLabel string

  Display Label of the setting

  description string

  Description of the setting

  acceptableValues string[]

  Specifies values which are acceptable when modifying the setting value. This will only be returned if there are specific set of values which can be accepted.

  defaultValue string

  Value used to get default system behaviour

  value string

  Value of the setting if the setting was modified.

  comment string

  Comment set by the user while modifying the setting

  isModified boolean

  Specifies if the setting is already modified by the user

  type string

  Possible values: [Integer, String, Boolean, Multi String]

  Type of the setting

  isRestartRequired boolean

  Specifies if it is required to restart the services for any changes to take effect

  minValue int32

  Specifies minimum value that can be set to modify specified global setting. It is only returned if the setting type is Integer

  maxValue int32

  Specifies maximum value that can be set to modify specified global setting. It is only returned if the setting type is Integer

  category string

  Category to which setting belongs

{
  "globalSettings": [
    {
      "name": "string",
      "displayLabel": "string",
      "description": "string",
      "acceptableValues": [
        "string"
      ],
      "defaultValue": "string",
      "value": "string",
      "comment": "string",
      "isModified": true,
      "type": "Integer",
      "isRestartRequired": true,
      "minValue": 0,
      "maxValue": 0,
      "category": "string"
    }
  ]
}

{
  "globalSettings": [
    {
      "name": "AccountLockDuration",
      "description": "Use this additional setting to set the number of seconds a locked account remains locked. ",
      "defaultValue": "0",
      "type": "Integer",
      "isRestartRequired": true,
      "minValue": 0,
      "maxValue": 2147483647,
      "category": "CommServDB.GxGlobalParam"
    },
    {
      "name": "ActivateHPECatalyst",
      "description": "Use this additional setting to show or hide HP Store Once library creation in the UI.",
      "defaultValue": "False",
      "type": "Boolean",
      "isRestartRequired": false,
      "value": "True",
      "isModified": true,
      "comment": "Needed to show HP store",
      "category": "CommServDB.GxGlobalParam"
    },
    {
      "name": "AddDecisionPointInformation",
      "description": "Set to 1 to add debugging information to collect file identifying reason entry was added and where in code that decision was made Set to 0 to disable (default)",
      "defaultValue": "0",
      "type": "Integer",
      "isRestartRequired": false,
      "minValue": 0,
      "maxValue": 1,
      "acceptableValues": [
        "0",
        "1"
      ],
      "category": "CommServDB.GxGlobalParam"
    }
  ]
}

Loading...