Updating custom fields through REST

Hi,
We have custom fields added to a category, and the category applied to a node.

When I get those fields and their information I am using the basic nodes rest call:
'/otcs/llisapi.dll/api/v1/nodes/' + nodeId + '/nodes'

And in this case, one of the fields is named "doc type". Per that call, I find the field identified as "wnf_att_385x_k". Ok, display fine.

But then I want to be able to update that field per REST calls as well. And the closest service I can find for that, is the category node:
'/otcs/llisapi.dll/api/v1/nodes/" + nodeId + "/categories/' + catId

However, when calling that node to check that it has the field I need to update.. it does, but under a different identifier: "97244_17".

Is that the correct call to use for a put to update the field infomration? And if so, is there a good way to match up the field as shown from the Nodes node, and the Categories node?

Thanks
Frank

Find more posts tagged with

Comments

Kevin_Mark

Quoted Frank Beaty on 04/26/2017 12:23 PM:

Hi,
We have custom fields added to a category, and the category applied to a node.

Is that the correct call to use for a put to update the field infomration? And if so, is there a good way to match up the field as shown from the Nodes node, and the Categories node?

Thanks
Frank

The identifier you're seeing '97244_17' is a unique ID for the field with the form '<category id>_<attribute id>'. In this case, the attribute ID for your custom field is 17.

Here is how you would update a node's category field using v2 of the REST API (recommended over v1). The example category has a category ID of 16403, and has 3 fields (text field, text field, integer field):

1) Call "GET api/v2/nodes/<id>" and inspect results.data.categories[0]. Each of the items here refers to a field in your category.

results.data.categories[0]

"16403_2": "aaa",

"16403_3": "bbb",

"16403_4": 123

2) To update the first text field, call "PUT api/v2/nodes/<id>/categories/16403" and have the following parameter in the form body:

16403_2

aaa updated

Beaty_Frank

Ok... that part makes sense.

But as a thought of going inbetween different envrionment, where these tags are a combination of envrionment specific id fields... how do I grab the friendly name of the field to tell which field it is? 27237_5 is all I see listed under the catergories node, and the columns name may or may not match, and also may or may not display a column in the view even though it's populated on the backend.

Is there any accurate way to see that 27237_5 is called "Birth Day" ?

Thanks
Frank

Kevin_Mark

Quoted Frank Beaty on 04/27/2017 04:16 PM:

Ok... that part makes sense.

Is there any accurate way to see that 27237_5 is called "Birth Day" ?

Thanks
Frank

Try this call:

GET api/v2/nodes/<id of your node>?fields=categories&metadata

Inspect results.metadata.categories[0] and you'll see the entries for 27237 and 27237_*. Look for the name field.

Beaty_Frank

I was able to load the category info based using:
function LoadCategoryAttributes(nodeId) {
   return $http({
                method: 'GET',
                url: $config.csUrl + '/otcs/llisapi.dll/api/v2/nodes/' + nodeId + '?fields=categories&metadata',
    headers: {
     OTDSTicket: $auth.Ticket
    }
            }).catch(function (err) {
                 alert("Error: " + err.data);
            });
  }

And update it per:
this.UpdateAttrValue = function(nodeId, catId, attr, value) {
   var obj = {}
   obj[attr.toString()] = value;

   return $http({
                method: 'PUT',
                url: $config.csUrl + '/otcs/llisapi.dll/api/v1/nodes/' + nodeId + '/categories/' + catId + '?' + attr + '=' + encodeURIComponent(value),
    headers: {
     "Content-Type": "application/x-www-form-urlencoded",
     OTDSTicket: $auth.Ticket
    }
            }).catch(function (err) {
                 alert("Error: " + err.data);
            });
  }

Thank you very much!

Steven Herring

Frank,

I read ith interest your question and the subsequent resolution.

I was encouraged to see that you were able to update an attribute inside a category and imagined that in POSTMAN I could quickly get something working. Unfortunately, although I have been able to obtain the token via POST ({{serverurl}}/adm/llisapi.dll/api/v1/auth) and to pass in my header with a specific content type using GET ({{serverurl}}/adm/llisapi.dll/api/v1/nodes/64974011/categories/833007/) successfully but I cannot update using PUT ({{serverurl}}/adm/llisapi.dll/api/v1/nodes/64974011/categories/833007/) successfuly !!

Instead I get:'<title>401 - Unauthorized: Access is denied due to invalid credentials.</title>'.

I wondered if you had any pointers ?

Steven

Steven Herring

I have a support ticket open on this topic but sadly no resolution as yet.

Does anyone have an example (perhaps using POSTMAN) where they have been able to successfully update an attribute value in any category in CS using REST V1 ? Happy to share the POSTMAN export that I have (example working POST and GET but not working PUT ) if it helps !

Steven

Riten

Hello Steven,

I’ve attached a screenshot from Advanced Rest Client that performs category update. Also, note that you will still need to pass in authentication token as part of the headers.

Regards,

Riten

From: eLink Entry: Content Web Services Forum [mailto:otdncontentwebservices971forum@elinkkc.opentext.com]
Sent: Wednesday, January 24, 2018 8:49 AM
To: eLink Recipient <devnull@elinkkc.opentext.com>
Subject: Updating custom fields through REST

Updating custom fields through REST

Posted bysteven.herring@givaudan.com (Herring, Steven) On 01/24/2018 08:42 AM

I have a support ticket open on this topic but sadly no resolution as yet.

Steven

[To post a comment, use the normal reply function]
Topic:	Updating custom fields through REST
Forum:	Content Web Services Forum
Content Server:	My Support

Nizar Ghazal

Hi Steven,

What I do, in POSTMAN, is the following:

GET the category info against a specific node:

GET: http://MY_CONTENT_SERVER/OTCS/cs.exe/api/v1/nodes/455850/categories/328832

See the {node id} followed by the {category id}, which is included, above.

I then want to see what attribute keys are available, so I may update them.

Which, in the http code snippet generation feature of POSTMAN, looks like:
GET /OTCS/cs.exe/api/v1/nodes/455850/categories/328832 HTTP/1.1
Host: MY_CONTENT_SERVER
otcsticket: XXXXXXXXXXXXXXXXXXa+cHqpG83mm67ybOUhACoTJLkjrIDCMs9eVvGUpBwaE=
Cache-Control: no-cache
Postman-Token: 48cb3b40-f274-5918-e537-2266ec364cef

I can then PUT against the same URL, but change one of the String Attributes, based on the AttrID, essentially:

PUT /OTCS/cs.exe/api/v1/nodes/455850/categories/328832 HTTP/1.1
Host: MY_CONTENT_SERVER
otcsticket: XXXXXXXXXXXXXXXXXRQFZa+cHqpG83mm67ybOUhACoTJLkjrIDCMs9eVvGUpBwaE=
Cache-Control: no-cache
Postman-Token: df756ee4-26a3-3664-9754-72188be01a8d
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="328832_2"

Test Test 10000
------WebKitFormBoundary7MA4YWxkTrZu0gW--

So, in POSTMAN, just make sure your Body has form-data selected, in the first KEY field, it's CatID_AttrID, for me, it's 328832_2, but the first GET will tell you where the Attr is, that you want to update. The value is just as string, plain and simple.

Is that sort of what you're looking for?

Steven Herring

Thank you Nizar - appreciate the reply !

In fact I see precisely the same as you for the POST, GET and PUT but instead of the update happening I get a 401 response:

PUT /adm/llisapi.dll/api/v1/nodes/64974011/categories/833007/ HTTP/1.1
Host: {hostname}
OTCSTicket: /73t/pjMPSkk3rdpIuXZmZnxTwIR1zLMIx8lJM6ioiUKGV+W39NIheTB+Ktz/lv+
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
Cache-Control: no-cache
Postman-Token: 6ca3074d-e497-8e5c-760e-05bc4da3a080

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="833007_16"

"EMEA"
------WebKitFormBoundary7MA4YWxkTrZu0gW--

The error is this:

...

            <div class="content-container">
                <fieldset>
                    <h2>401 - Unauthorized: Access is denied due to invalid credentials.</h2>
                    <h3>You do not have permission to view this directory or page using the credentials that you supplied.</h3>
                </fieldset>

...

With the POST (to get the token) and the GET (existing attribute values) things work as expected (and look the same as your useful extract so thank you) but not with the PUT ! I suspected that the PUT verb was not being allowed (although the error does not indicate an issue with the Handler Mappings in IIS) but it seems that the restrictioon is not in place.

Any other ideas ?

Steven Herring

Riten,

Thank you for th reply and the image - sadly I do not see the picture - just a black cross !

I am pretty confident that my simplistic POSTMAN code is OK and correctly formed but for some reason in the environment it does not work.

Steven

AKropp

Hi Steven,

Where are you getting that auth ticket from? It looks weird to me. I generated a random ticket to compare:

Yours: /73t/pjMPSkk3rdpIuXZmZnxTwIR1zLMIx8lJM6ioiUKGV+W39NIheTB+Ktz/lv+

Mine: fBPgjFsiFsfeYCN0vE6c1FJ/KX77irIKO+rclLEpTt5NrjlI7mJiWFbgqDSll0MGfDFS1JFV1w4=

Not that they’re particularly human readable, but I’ve never seen a token that wasn’t end-delimited by the equals sign. Yours also appears to be several bytes shorter in terms of character count. So if you’re throwing a 401 “unauthorized” then I think you’re best off looking more closely at the source of that token.

From: eLink Entry: Content Web Services Forum [mailto:otdncontentwebservices971forum@elinkkc.opentext.com]
Sent: Thursday, January 25, 2018 5:57 AM
To: eLink Recipient <devnull@elinkkc.opentext.com>
Subject: Updating custom fields through REST

Updating custom fields through REST

Posted bysteven.herring@givaudan.com (Herring, Steven) On 01/25/2018 05:55 AM

Thank you Nizar - appreciate the reply !

In fact I see precisely the same as you for the POST, GET and PUT but instead of the update happening I get a 401 response:

PUT /adm/llisapi.dll/api/v1/nodes/64974011/categories/833007/ HTTP/1.1
Host: {hostname}
OTCSTicket: /73t/pjMPSkk3rdpIuXZmZnxTwIR1zLMIx8lJM6ioiUKGV+W39NIheTB+Ktz/lv+
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
Cache-Control: no-cache
Postman-Token: 6ca3074d-e497-8e5c-760e-05bc4da3a080

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="833007_16"

"EMEA"
------WebKitFormBoundary7MA4YWxkTrZu0gW--

The error is this:

...

            <div class="content-container">
                <fieldset>
                    <h2>401 - Unauthorized: Access is denied due to invalid credentials.</h2>
                    <h3>You do not have permission to view this directory or page using the credentials that you supplied.</h3>
                </fieldset>

...

Any other ideas ?

[To post a comment, use the normal reply function]
Topic:	Updating custom fields through REST
Forum:	Content Web Services Forum
Content Server:	My Support

Steven Herring

Alex,

I am not entirely sure - would need further examination of the OScript code used to generate the ticket. However, all seems OK as the auth POST (which is the only way to get an auth response and ticket - eg. POST api/v1/auth) returns a ticket # and allows a subsequent successful get.operation to reveal the attribute values.

When i looked at the OScript code I was surprised to see no mapping for the various PUT operations so perhaps I am attempting to do something that in Rest V1 that is not possible ? This is what I see inside RestAPIMap.SetMap:

.fMap = { \
\ //{ "GET | api/v1/nodes2/{1}/browse", "csnodes|execute|id|{1}|action|browse" }, \
\ //{ "GET | api/v1/nodes2/{1}/nodes2", "nodes|index|node_id|{1}" }, \
\ //{ "GET | api/v1/nodes2/{1}/delete", "csnodes|info|id|{1}|action|delete" }, \
\ //{ "POST | api/v1/nodes2/{1}/browse", "csnodes|execute|id|{1}|action|browse" }, \
\ //{ "POST | api/v1/nodes2/{1}/bogus/{2}", "csnodes|execute|id|{1}|action|browse|bogus|{2}" }, \
\ //{ "POST | api/v1/nodes2/{1}", "csnodes|execute|id|{1}|action|create" }, \
\ //{ "POST | api/v1/nodes2", "csnodes|execute|action|create" } \
}

I am running CS V10

ServerVersion : 10.0.0
ServerVersionMajor : 10
ServerVersionMicro : 0
ServerVersionMinor : 0

Again - thanks for the idea but not sure that it helps me at this stage.

Steven

AKropp

As far as I can see updating category info is available all the way back to 10.0. https://developer.opentext.com/webaccess/#url=%2Fawd%2Fresources%2Fapis%2Fcs-rest-api-for-cs-10

I’d still be inclined to apply Occam’s razor here. 401 unauthorized means what it says on the tin and it should be equally visible in a CS thread log if that’s the case. Why that’s the case is the puzzling part. I’ve never really had any difficulty wrestling with tickets, but then again I never really dabbled with REST much until 16.0.

That said, more along the lines of what I was thinking was whether you were getting your ticket from OTDS or CS directly. At least way up in 16+ there is only OTDS now, but back then they were still pretty distinct and I’m just not sure if there isn’t an extra validation step… otdsticket vs. otcsticket.

From: eLink Entry: Content Web Services Forum [mailto:otdncontentwebservices971forum@elinkkc.opentext.com]
Sent: Friday, January 26, 2018 4:18 AM
To: eLink Recipient <devnull@elinkkc.opentext.com>
Subject: RE Updating custom fields through REST

RE Updating custom fields through REST

Posted bysteven.herring@givaudan.com (Herring, Steven) On 01/26/2018 04:13 AM

Alex,

I am running CS V10

ServerVersion : 10.0.0
ServerVersionMajor : 10
ServerVersionMicro : 0
ServerVersionMinor : 0

Again - thanks for the idea but not sure that it helps me at this stage.

Steven

[To post a comment, use the normal reply function]
Topic:	Updating custom fields through REST
Forum:	Content Web Services Forum
Content Server:	My Support

Steven Herring

As too often with these types of problems the problem was in fact related to the mis-configuration of the web server in respect of webdav. I (eventually) found that several of the web server defined virtual directories had been left inheriting from the root which included the webdav module. By removing this references to webdav in the Handler Mappings for all but the virtual directory concerned with webdav I am now able to run the previously posted code successfully.

Steven

Steven Herring

Quoted Steven Herring on 03/06/2018 05:36 AM:

Steven

Several references but this was the most obvious for reference:

https://developer.opentext.com/awd/forums/questions/4893013#r5366414