report.deleteConfiguration

Delete a saved report configuration.

Deletes a saved configuration and returns it as it was. Report templates cannot be deleted. It only changes the Configuration, not the book.

Examples

Example: with no book.

JSON-RPC

Request:

{"jsonrpc":"2.0","id":1,"method":"report.saveConfiguration","params":{"name":"March balance sheet","report":"Balance Sheet"}}

Response:

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": "…"
}

Request:

{"jsonrpc":"2.0","id":2,"method":"report.deleteConfiguration","params":{"configuration":"March balance sheet"}}

Response:

{
  "jsonrpc": "2.0",
  "id": 2,
  "result": {
    "deleted": {
      "name": "March balance sheet",
      "kind": "saved",
      "…": "…"
    }
  }
}

Request:

{"jsonrpc":"2.0","id":3,"method":"report.deleteConfiguration","params":{"configuration":"March balance sheet"}}

Response:

{
  "jsonrpc": "2.0",
  "id": 3,
  "error": {
    "code": 2000,
    "message": "…",
    "data": {
      "kind": "configuration",
      "help": "error/not-found",
      "…": "…"
    }
  }
}

Command line

red-ale exec --script - <<'EOF'
report.saveConfiguration {"name":"March balance sheet","report":"Balance Sheet"}
report.deleteConfiguration {"configuration":"March balance sheet"}
report.deleteConfiguration {"configuration":"March balance sheet"}
EOF

It fails with exit status 2, printing on standard error:

{
  "error": {
    "code": 2000,
    "message": "…",
    "data": {
      "kind": "configuration",
      "help": "error/not-found",
      "…": "…"
    }
  }
}

MCP tool call

Tool call:

{"name":"report.saveConfiguration","arguments":{"name":"March balance sheet","report":"Balance Sheet"}}

Result:

{
  "content": [
    {
      "type": "text",
      "text": "\"…\""
    }
  ]
}

Tool call:

{"name":"report.deleteConfiguration","arguments":{"configuration":"March balance sheet"}}

Result:

{
  "structuredContent": {
    "deleted": {
      "name": "March balance sheet",
      "kind": "saved",
      "…": "…"
    }
  }
}

Tool call:

{"name":"report.deleteConfiguration","arguments":{"configuration":"March balance sheet"}}

Result:

{
  "isError": true,
  "structuredContent": {
    "error": {
      "code": 2000,
      "name": "not-found",
      "message": "…",
      "data": {
        "kind": "configuration",
        "help": "error/not-found",
        "…": "…"
      }
    }
  }
}

Effect: destructive, on the Configuration only.

Params

Params of report.deleteConfiguration.

configuration (ReportRef, required): The saved configuration, by GUID or name.

Result

The result of report.deleteConfiguration.

deleted (ReportInfo, required): The configuration deleted.