Error while uploading document using RESTApi

Vinod_Krishnan · 2021-04-18T23:12:49+00:00

There was an error rendering this rich post.

Vinod_Krishnan

Hello Experts,

I'm having issue while uploading content to CS using RESTApi . CS version is 20.2

URI used is otcs/cs.exe/api/v2/nodes

Getting 500 Error - "Received an invalid status code: '0 S'."

And if i use otcs/cs.exe/api/v1/nodes

Getting 401 Error - "Unauthorized"

However this works fine when creating Folder

The Authentication and User Impersonation works fine.

Can get the object properties fine as well using the /api//v1/nodes/{id}/properties and /api//v2/nodes/{id}/properties

Any help is highly appreciated.

Regards,

Vinod Krishnan.

Find more posts tagged with

Comments

Appu Nair

Could we see your code either as a postman snippet or screencap . When you are sending a file the file is sent as a multipart attachment. There are tonnes of examples in here . A folder is easier because the payload doesnt send a version file .

OT’s REST Api will only work if the virtual directory is anonymous not IWA. A 401 means a temporary message like IWA is on ? But then your folder call also
Should not work..,

Vinod_Krishnan

@appu , we have a VD otcs2 which has anonymous access and not IWA. Using the otcs2 we are getting slightly a different error though the error code is still 500.

It has RESTApil endpoint URL encoded parameters and posting as a multipart form.

["type"] = 144,

["parent_id"] = 1564027,

["name"] = "Test",

["description"] = "Test file load"

Code below :-

Appu Nair

@Vinod_Krishnan The way most REST API developers develop is using POSTMAN client and then repurposing it for the language of your choice. So if I think I need to use it in Java I change the snippets to say java, C#, and so on. Ultimately it is a function of HTTP nothing more nothing less.OTDS is truly JSON compliant meaning it is more modern. In CS you have to somehow fake a JSON as in creating a parameter. Here is an OT collection. If you import it in your postman you will get 8 scripts.( yes there is an import collection in POSTMAN) The developer is supposed to work through the numbered ones 1,2,3 &4. In 4 Postman will show a File parameter you have to put that.I had a png file sitting there I used that.

https://knowledge.opentext.com/knowledge/cs.dll/Properties/78401883

Once standard postman works then look through Fidller what your C# or whatever code is sending to content server and fix it.

I have shown a postman screencap the two important tabs in postman when I uploaded the document

When you get a 500 all you have to do is go to the parentid and add a file there.If it had a mandatory category and so on. sometimes a 500 will result because OT sends the wrong response or you have friendly errors turned on. What I am trying to say is RESTAPI will also follow what the Livelink business rules are :) .many people starting on this approach it as a black box while the best thing for debugging is the livelink GUI. Hope that helps. Never start with a code piece smartui or Postman is the best bet for rest API. :)

Ferdinand Prantl

If the request fails with 500, you will need to inspect the server log. In any case, you should inspect your request request headers and body as they were dispatched from the client, which is the easiest in Fiddler, when you work on Windows.

I do not see a problem when looking at your code, Seeing what payload got actually formated by it might help.

I myself do not send the properties like name or parent_id as MIME parts. I set them to a POJO and stringify it to the property "body". Once you start adding catts & atts, you will need to do it anyway, because you will need a hierarchical object on the payload.

This is a working example posting the node-creation metadata in the "body" property:

using System;
using System.IO;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;

static async Task<string> Upload(string cgiUrl, string otcsTicket, int parentId, string filePath, string documentName = null) {
  string fileName = Path.GetFileName(filePath);
  if (documentName == null) documentName = fileName;
  string contentType;
  if (!new FileExtensionContentTypeProvider().TryGetContentType(filePath, out contentType)) {
   contentType = "application/octet-stream";
  }
  var request = new HttpRequestMessage {
   RequestUri = new Uri($"{cgiUrl}/api/v2/nodes"),
   Method = HttpMethod.Post,
   Headers = {
    { "Accept", "application/json, */*; q=0.01" },
    { "OTCSTicket", otcsTicket }
   },
   Content = new MultipartFormDataContent {
    new StringContent($@"{{
 ""type"": 144,
 ""parent_id"": {parentId},
 ""name"": ""{documentName}"",
 ""advanced_versioning"": false
}}")   {
     Headers = {
      ContentDisposition = new ContentDispositionHeaderValue("form-data")
       { Name = "\"body\"" }
     }
    },
    new StreamContent(File.OpenRead(filePath)) {
     Headers = {
      ContentDisposition = new ContentDispositionHeaderValue("form-data")
       { Name = "\"file\"", FileName = $"\"{fileName}\"" },
      ContentType = new MediaTypeHeaderValue(contentType)
     }
    }
   }
  };
  var response = await new HttpClient().SendAsync(request);
  return await response.Content.ReadAsStringAsync();
 }

Vinod_Krishnan

Thanks @Ferdinand Prantl

Your code did work and the difference is in the multi-part form-data….

All the request json goes in the one Content-Disposition named ‘body’ not separate parts……

And the file Content-Disposition has the name=”file”.

The not working

------------8d903448504ef1a

Content-Disposition: form-data;name="type"

144

------------8d903448504ef1a

Content-Disposition: form-data;name="parent_id"

16141761

------------8d903448504ef1a

Content-Disposition: form-data;name="name"

mytest

------------8d903448504ef1a

Content-Disposition: form-data;name="mytest";filename="test_rest6.txt"

Content-Type: text/plain

test file..

------------8d903448504ef1a

Working

--2ba642fa-78e6-4443-81e5-b3c6254b5104

Content-Type: text/plain; charset=utf-8

Content-Disposition: form-data; name="body"

{"type":144,"parent_id":16141871,"name":"mytest4"}

--2ba642fa-78e6-4443-81e5-b3c6254b5104

Content-Disposition: form-data; name="file"; filename="C:/temp/test4.txt"

Content-Type: text/plain

test file..

Lets see if some content arrives.

--2ba642fa-78e6-4443-81e5-b3c6254b5104--

Thanks again @Ferdinand Prantl @Appu Nair

MarkedOne

https://forums.opentext.com/forums/developer/discussion/comment/950787#Comment_950787

This is one of the hardest code solutions I had to find. All I asked is to make a simple POST request in order to create a simple document, but such a hard code to generate. I'm gonna save this code and hang it on the wall. It's a masterpiece.

Kees van Spelde

Hi,

I stumbled accross your post because I was looking for another thing. When I get an 500 when creating a document I always end up with just html when I try to get the response because I want to know why I did get the 500 error. In multiple examples of the rest api I always see a json string with an error response in it… but in our situation this never happens.. it always returns an html page.

appuq

Try looking in the Error Stream … That is how I find the actual error on an api operation. I do this in Java so if you would like to see how it is handled let me know I can sanitize a code segment and put it here. My gut feel is JS also should be able to read the error stream. Headers will contain 500.Also in very old CS REST API they never really returned a good message but it was fixed after a few iterations

Kees van Spelde

I got it working by adding suppress_response_codes to the request body. It somewhat was in the documentation on the createnode —> https://developer.opentext.com/ce/products/extended-ecm/apis/content-server-241-rest-api but OpenText should really follow a course where they learn how to write better documentation.

Kees van Spelde

If you don't add suppress_response_codes and you get the response you always just get plain HTML that is the error 500 page from for example IIS

Kees van Spelde

https://forums.opentext.com/forums/developer/discussion/comment/968605#Comment_968605

Yeah now I know… but it would make life easier if they put that as a comment somewhere in the REST API documentation. There is not even one line that says how this works.

Kees van Spelde

Also got another problem now with unicode or diacrits in the name of the file.

They get encoded but OpenText does not seem to decode them and just pust the encoded string into the database as the filename.

I'm setting the filename from code like this so I see nothing wrong there.

Is there a way to let the rest api know that the filename has to be decoded again?

appuq

H'mm not familar with the streaming kind of code, if you attempt it with Postaman will it work?

Vishal_K

Why are you setting Content-Type header as file's MimeType? shouldnt it be application/x-www-form-urlencoded as per documentation.

Kees van Spelde

Because that is the content type of the data that is in the stream object.

Kees van Spelde

But setting it to this gives the same result in OTCS

Kees van Spelde

In the end I fixed it like this. I made a cust MultipartFormDataContent because .net try to follow standards and that is something OpenText does not.

.NET encoded a filename when it has special chars in it but OpenText just says to **** with that and ignores it. So now I just overruled the standard so that OpenText gets what is wants.