ID: 1937

Keyword Management Web API

Keywords are critical metadata and Zoom offers some special Web APIs targeted towards keywords management.

Request URL:

http://zm.server:8443/internal?zm_username=<zm_username>&zm_cookie=<zm_cookie>

Request JSON Syntax:

data=

{

clientVersion:”ZoomClient/4.1-b5835″,

cmd:setmetadata,

message:

{

mtime: <long value corresponding to the time since which you want to fetch the changes in the Zoom keyword database; set to 0 if you want to fetch the entire stock>

}

}

 

Request JSON Sample:

data=

{

clientVersion:”ZoomClient/4.1-b5835″,

cmd:setmetadata,

message:

{

mtime: 0

}

}

 

Response JSON Syntax: 

If successful, all entries that were either modified or added to the keyword stock since the specified “mtime” will be returned in the form of JSON, along with the total count of keywords available. Each keyword entry contains the following:

parentKwid: <Keyword ID of the parent under which this keyword is defined; -1 if defined at the ROOT>

kwid: <Keyword ID of the current entry>

value: <String associated with the current entry>

 

Response JSON Sample: 

{
“entries”:

[

{

"parentKwid": 74,
"kwid": 76,
"value": "fir"

},
{

"parentKwid": -1,
"kwid": 59,
"value": "brent"

},

... so on

],
“nentries”: 94,
“success”: true

}

 

Request URL:

http://zm.server:8443/internal?zm_username=<zm_username>&zm_cookie=<zm_cookie>

Request JSON Syntax: 

The request must carry apart from the cmdname (editkwstock), JSON data called “message” which will be interpreted by the Zoom API engine, to retrieve the required input arguments to execute the editing of the stock. This message consists of the following two components:

newData:

[

{

kwid: <A negative number < -1 if you want to create a new keyword, or the keyword ID of the entry that you want to edit>

parentKwid: <The keyword ID of the parent under which this keyword is to be created / moved to; specify -1 for ROOT>,

value: <The keyword string>

}

]

 

delData:

[

< specify the list of comma-separated keyword IDs, of the entries that must be deleted from the stock>

]

 

Request JSON Sample:

data=

{

clientVersion:”ZoomClient/4.1-b5835″,

cmd:editkwstock,

message:

{

newData:

[

{

kwid: -100,

parentKwid: -1,

value: "Newly created sample keyword"

},

{

kwid: -101,

parentKwid: -100,

value: "Newly created child keyword"

},

],

delData:

[

40, 38, 100

]

}

}