Get Entity Settings

Get list of entity settings used to modify default behaviour for linked entity like servers or server groups

Responses

• 200

---

Success

application/json

• Schema
• Example (from schema)
• Entity settings

---

Schema

• entitySettings object[]

  name string

  Name 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

  values object[]

  value string

  Value set for the specified setting linked to the specified entity

  comment string

  Comment set by user while modifying the specified entity setting for the given entity

  entity object

  id int32

  name string

  type string

  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

{
  "entitySettings": [
    {
      "name": "string",
      "description": "string",
      "acceptableValues": [
        "string"
      ],
      "defaultValue": "string",
      "values": [
        {
          "value": "string",
          "comment": "string",
          "entity": {
            "id": 0,
            "name": "string",
            "type": "string"
          }
        }
      ],
      "isModified": true,
      "type": "Integer",
      "isRestartRequired": true,
      "minValue": 0,
      "maxValue": 0,
      "category": "string"
    }
  ]
}

{
  "entitySettings": [
    {
      "name": "3dfsCfgClient_DEBUGLEVEL",
      "description": "Specifies the default debug level for application. Note that if other means exist to set debug level  those will probably override this method. ",
      "defaultValue": "2",
      "values": [
        {
          "value": "4",
          "comment": "Needed to debug 3dfs application",
          "entity": {
            "name": "oes2018_3",
            "id": 4,
            "type": "Server"
          }
        },
        {
          "value": "3",
          "comment": "Needed to debug 3dfs application",
          "entity": {
            "name": "amsterdam",
            "id": 3,
            "type": "Server"
          }
        }
      ],
      "type": "Integer",
      "isRestartRequired": false,
      "minValue": 0,
      "maxValue": 10,
      "isModified": true,
      "category": "EventManager"
    },
    {
      "name": "AllowEmptySubClientToSucceed",
      "description": "By default, if a subclient is empty, the backup job fails. To allow backup jobs for empty subclients to complete, set the value to 1.",
      "defaultValue": "0",
      "type": "Integer",
      "isRestartRequired": false,
      "minValue": 0,
      "maxValue": 1,
      "category": "MSExchangeDBAgent"
    }
  ]
}

GET /v4/entitysettings    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/webconsole/api

token

curl -L -X GET 'https://localhost/webconsole/api/V4/EntitySettings' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/EntitySettings' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/EntitySettings' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/EntitySettings' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/EntitySettings' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/EntitySettings' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/EntitySettings' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'