Example of PUT REST Request to update category attributes

Hi,
Would anyone be able to provide an example of a PUT request that updates a category attribute on a document? My below attempt results in a 500 internal server error so it appears to be structured incorrectly.

$http.put('/contentserver/api/v1/nodes/2614353/categories/2621276?{2621276}_{2}=MyVal');

In the above 2614353 is the id (document) and 2621276 is the category_id. The attribute i wish to update is #2.

API - PUT /nodes/{id}/categories/{category_id}/

Thanks in advance

Find more posts tagged with

API

Comments

Ferdinand Prantl

Try this:

var cgiUrl = 'http://myserver/otcs/cs';
$.put(cgiUrl + '/api/v1/nodes/2614353/categories/2621276', {
  '2621276_2': ...,
  ...
});

Attribute keys are in the format {category_id}_[{set_id}_{set_row}]_{attribute_id}. [] means optional, {} are placeholder delimiters; those are not contained in the actual attribute key.

Gareth Newell

Thanks Ferdinand. Not sure what I am doing wrong below. Using Fiddler I can see the parameters being passed in the request.

        var params = {
            '2621276_2':'test'
        };
        $http.put('/contentserver/api/v1/nodes/2614353/categories/2621276', params);

Ferdinand Prantl

What is the error you're getting?

What is the actual URL you PUT to? The '/contentserver/api/...' is not in the /virtual_folder/cgi_script/api/... format.

Gareth Newell

Hi Ferdinand,

I have configured the reverse proxy server to map contentserver as follows

contentserver=enterprise/otcs/llisapi.dll

With the following request I am not receiving an error, in fact I receive a status of 200.

        var params = {
            "2621276_3": "hello",
            "2621276_5": "world"
        };  

        $http({
            method: "PUT",
            url: "/contentserver/api/v1/nodes/2614353/categories/2621276",

            headers: {
              "Content-Type": "application/x-www-form-urlencoded"
            },
            params: params
        }).success(function (response) {
            console.log(response);
        }).error(function (response){
            console.log(response);
        });

Analyzing the request in fiddler:

PUT /contentserver/api/v1/nodes/2614353/categories/2621276?2621276_3=test&2621276_5=test HTTP/1.1

However none of the attributes are being updated in CS.

Thanks.

Ferdinand Prantl

Ah, I see, you map the URL path to one identifier. I take back that the URL is wrong. You code is correct.

The PUT requests return 200 and an empty object literal {} when the call succeeds. What you see would be a bug in the CS REST API. What CS Update do you run?

Gareth Newell

Yes I receive the 200 response however there is no response object literal.

CS version = Content Server 10.5 Update 2014-12 (version 10.5.0.10)

Ferdinand Prantl

You server is fresh enough. You receive an unexpected response and no changes happened on the server. It is not obvious what might go wrong.

You could try if the debug logging does not show more about the request handler or if the SQL logging shows updates of the attribute tables.

Gareth Newell

Digging a little deeper it appears CS isn't receiving the params from the AngularJS request. From what I have read AngularJS transmits data using Content-Type: application/json and { "foo": "bar" } JSON serialization, which isn't unserialized by the the content server. For anyone using AngularJS a workaround is to use the transformRequest property on the request object to pass urlencoded data.

       var params = {
        "2621276_3": "hello",
        "2621276_5": "world"
       };  

       $http({
            method: "PUT",
            url: "/contentserver/api/v1/nodes/2614353/categories/2621276",
            transformRequest: function (obj) {
                var str = [];
                for (var p in obj)
                    str.push(encodeURIComponent(p) + "=" + encodeURIComponent(obj[p]));
                return str.join("&");
            },
            params: params
        }).success(function (response) {
            console.log(response);
        }).error(function (response) {
            console.log(response);
        });

Link to workaround source

Ferdinand Prantl

True, the application/json content type is not supported for request bodies of POSTs and PUTs in all currently released CS REST API versions. You have to use either application/x-www-form-urlencoded or multipart/form-data.

It is painful especially if you have JSON as input, or if you have a nested structure ready for POST /nodes/:id. As a workaround, you can pass the single form field body with all JSON parameters serialized:

transformRequest: function (obj) {
  return "body=" + encodeURIComponent(JSON.stringify(obj));
}

I am not sure if you can pass a string to params and if AngularJS chooses the form content type in that case. If it does, it could be even shorter:

params: "body=" + encodeURIComponent(JSON.stringify(params))