summaryrefslogtreecommitdiffstats
path: root/source/rainerscript/functions/rs-parse_json.rst
diff options
context:
space:
mode:
Diffstat (limited to 'source/rainerscript/functions/rs-parse_json.rst')
-rw-r--r--source/rainerscript/functions/rs-parse_json.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/source/rainerscript/functions/rs-parse_json.rst b/source/rainerscript/functions/rs-parse_json.rst
new file mode 100644
index 0000000..269b587
--- /dev/null
+++ b/source/rainerscript/functions/rs-parse_json.rst
@@ -0,0 +1,27 @@
+************
+parse_json()
+************
+
+Purpose
+=======
+
+parse_json(str, container)
+
+Parses the json string ``str`` and places the resulting json object
+into ``container`` where container can be any valid rsyslog variable.
+Returns 0 on success and something otherwise if ``str`` does **not**
+contain valid json.
+
+
+Example
+=======
+
+In the following example the json string is placed into the variable $!parsed.
+The output is placed in variable $.ret
+
+.. code-block:: none
+
+ set $.ret = parse_json("{ \"c1\":\"data\" }", "\$!parsed");
+
+
+