Returns the defaults of Settings › General › System configuration and a revision that identifies this state. Pass the revision to Patch system settings so that a change made by someone else in the meantime is not overwritten. New in 10.00.

Method and path	GET /plugin/datafor/api/system/settings/snapshot
Permission	Administrator
Content type	None

Parameters

None.

Example

curl -u admin:password "http://localhost:28080/datafor/plugin/datafor/api/system/settings/snapshot"

{
  "success": true,
  "code": "200",
  "data": {
    "settings": {
      "report-default-color-scheme": "default",
      "week-start-day": "monday",
      "chart-default-max-rows": "5000"
    },
    "revision": "<64-hex-character-revision>",
    "tenant": "/pentaho/tenant0"
  }
}

Field	Description
settings	The stored values of the twelve keys listed in Patch system settings. A key that was never set is left out; the console then shows its default.
revision	Fingerprint of the current values. It changes whenever one of the twelve keys changes.
tenant	Tenant the settings belong to.

Errors

code	When
"403"	The caller is not an administrator (msg: no permission).
"500"	The settings could not be read.

Related: System Configuration