Method

config.get

The whole Configuration, or one setting by path, with defaults filled in; secrets shown only as set or unset.

Reads red-ale's Configuration: the settings GnuCash keeps outside the book (accounting period, document link folder, report options, import settings, quote services, limits). Give a dotted path for one setting (quotes.network); without it you get the whole Configuration, with defaults filled in and secrets shown only as set or unset. It works with no book open. An unknown path is invalid-params.

Examples

{"jsonrpc":"2.0","id":1,"method":"config.get","params":{"path":"quotes.network"}}

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "path": "quotes.network",
    "value": false,
    "unknown": [],
    "problems": [],
    "configFile": null
  }
}

red-ale exec config.get '{"path":"quotes.network"}'

{
  "path": "quotes.network",
  "value": false,
  "unknown": [],
  "problems": [],
  "configFile": null
}

{"name":"config.get","arguments":{"path":"quotes.network"}}

{
  "structuredContent": {
    "path": "quotes.network",
    "value": false,
    "unknown": [],
    "problems": [],
    "configFile": null
  }
}

Effect: read.

Params

Params of config.get.

• path (string or null): A setting path, keys joined with . (import.settings.matchThreshold, quotes.services.alphavantage); absent for the whole Configuration.

Result

The result of config.get.

• path (string or null): The path asked for; null for the whole Configuration.
• value (any, required): The value, defaults filled in, each secret shown as {"set": true|false}. null for a map entry that does not exist.
• unknown (array of string, required): Keys in the file, at or below the path, that declare no setting. They are kept and do nothing.
• problems (array of ProblemInfo, required): Settings, at or below the path, whose values in the file do not match the schema.
• configFile (string or null): The Configuration file; null for a process started with --no-config, whose Configuration is in memory.