CS 16 REST API - how to do a call with JSON data

HFCDev

Hi,

  in the REST API to update a node's languages, the API specifies a PUT request for /v1/nodes/:id and where you pass name and description as parameters in the body of the request. In a posting here( https://developer.opentext.com/webaccess/#url=/awd/forums/questions/6672161&tab=501), I asked about how you get JSON data to the REST API. Perhaps this forum is a better place for that question. 

I have some jquery that looks like this:

        var name = root.find('input[name="src-name"]').val();        var desc = root.find('input[name="src-desc"]').val();        var queryString = 'name=' + encodeURIComponent(name) + "&description=" + encodeURIComponent(desc);        queryString += "&body=" + strPayload; // str payload is {'name_multilingual' :{de:'Deutsch Name', fr:'Nom'...etc} which has been stringified.                $.ajax({                url: this.urlprefix + 'nodes/' + id,                beforeSend: function(xHdr) {                    xHdr.setRequestHeader("otcsticket", otcsticket);                },                method: 'PUT',                dataType: 'json',                data: 'body=' + encodeURIComponent(strPayload),                success: function(response) {                    console.log(response);                },                error: function(jqXHR, status, error) {                    console.log("Got error from server");                    console.log(status);                    console.log(error);                }        });

So my question is what is the correct way to call the REST API to pass it names and descriptions to update in multiple languages?

Thanks

-Hugh

HFCDev

After some experimentation and a few responses on developer.opentext.com, I found a solution that worked.  The correct approach is very similar but you need to pass in Name and Description as parameters in the stringified JSON you are sending in the "body" parameter. That is, you would do something like:

var payload = {};payload['name'] = '[Name in user language]';payload['name_multilingual'] = {'de' :'Deutsch Name', 'en' : 'English Name', 'fr' : 'Nom Francais' ...};payload['description'] = '[Document description in user language]';payload['description_multilingual'] = {'de' : Deutsch Beschriebung'....};$.ajax({				url: this.urlprefix + 'nodes/' + id, 				beforeSend: function(xHdr) {					xHdr.setRequestHeader("otcsticket", otcsticket);				},				method: 'PUT', 				dataType: 'json',				data: 'body=' + encodeURIComponent(JSON.stringify(payload)),				success: function(response) {					console.log(response);				},				    error: function(jqXHR, status, error) {					console.log("Got error from server");					console.log(status);					console.log(error);				}		});

Thought I'd answer my own question in case someone is later asking about this.  For OT, the documentation needs to be a bit clearer about using the body parameter to pass JSON objects to the API. That's probably the least clear aspect of it all.  It is certainly not mentioned anywhere in the Swagger docs for the node update command.

-Hugh