topic Re: Data Method Load example in JSON-RPC in NSO Developer Hub Discussions

Data Method Load example in JSON-RPC

lukepatrick — Thu, 05 Sep 2019 20:42:18 GMT

Looking for an example of the Data Method: Load in JSON-RPC.

I've seen the documentation:

{"th": <integer>,
"data": <string>
"path": <string, default: "/">
"format": <"json" | "xml", default: "xml">
"mode": <"create" | "merge" | "replace", default: "merge">}

Though anything I seem to try - attempting json-data - doesn't seem to work. The RPC always returns a

"reason": "invalid_trailing_data"

Re: Data Method Load example in JSON-RPC

perander — Fri, 06 Sep 2019 07:14:06 GMT

From the NSO Web UI Book, the load method's parameters are as stated

{"th": <integer>,
 "data": <string>
 "path": <string, default: "/">
 "format": <"json" | "xml", default: "xml">
 "mode": <"create" | "merge" | "replace", default: "merge">}

Did the JSON payload include a comma after the "data" string? It seems that the documentation is missing these, which results in invalid JSON.

A valid JSON-RPC parameter payload for the "load" method would loke something like

{"th": 42,
 "data": "<config xmlns="http://tail-f.com/ns/config/1.0"><wrapper xmlns="urn:model"><name>create</name></wrapper></config>",
 "mode": "create"}

Note that it should be possible to omit parameters with default values.

Re: Data Method Load example in JSON-RPC

perander — Fri, 06 Sep 2019 09:03:56 GMT

Of course the XML data above needs to escape quotes, e.g. ..."data": "<config xmlns=\"...\">...</config>".

Re: Data Method Load example in JSON-RPC

lukepatrick — Fri, 06 Sep 2019 13:13:03 GMT

thank you for the response.

Yes, we did notice the missing comma's and have included those.

Do you have a working example with JSON as the data parameter payload?

Re: Data Method Load example in JSON-RPC

perander — Mon, 09 Sep 2019 08:57:38 GMT

Given the following YANG model

module ex { 
    namespace "urn:ex";
    prefix ex;

    leaf value { type int32; }
}

The following JSON-RPC payload loads config

{"jsonrpc": "2.0",
 "method": "load",
 "params":
   {"th": 1,
    "data": "{\"ex:value\":42}",
    "mode": "create",
    "format": "json"},
 "id":1}