Document Response Format in Rest API

if you look at examples and especially IMPLEMENTATION NOTES at developer.opentext.com and look at the CS REST API's you will see that in almost all cases you are actually sending a HTTP POST with form-data parameters so the input really isn't all JSON stuff. When you send a file you have to have the file in a file object ,but almost all of the replies or responses are JSON.I am not entirely sure I understand the question perhaps someone who is more modern in REST will give you an answer.

I would encourage you to use POSTMAN

content-type →application/json; charset=UTF-8 this is what I see when I invoke a REST API using that.

GPesari

Thank you, Appu Nair. I will start using POSTMAN.

Hello All,

I am having the same question. When we get the content of file, it actually respond back in application/pdf format. But not in Base64 string. How to get the response of download document API is base 64?

Best,

Ravi

What would base64 buy you ? curious?

Actually the CS APIs would be called via Angular Application and they would like to get the document. As per them, they need document in Base64 format.

Hello Appu,

Also I have another question, do we have any Health Check API available for CWS? Which tells, is system up & running or not.

Best,

Ravi Dubey

Base64 is very inefficient when you send it on the wire say if you have a 10 MB document and you are trying to open it up on your mobile . You are the programmer , you can change your pdf to Base64 and keep Angular happy 😃 at least that is how I look at it. OT's CS is a Document store as such people store any kind of data large and small.

https://stackoverflow.com/questions/14788130/base64-image-upload-vs-binary-image-upload

CWS was designed as a B2B integration so Health check API's weren't the focus .CWS or SOAP has ceased development other than bug fixes et al.

any idea about Health Check API available for CWS

Hello!

Is there anyone here coding hands-on in java against the REST SDK? I am doing something pretty simple, trying to create a sub-folder and then upload a document into that subfolder. I reviewed the API in detail and I also went through the OT examples that use POSTMAN and REST. They all work fine but they rely on the form submission of a file property when uploading a file. How would you do the same programmatically using java starting from an HttpURLConnection? I am getting HTTP 500 (internal error). I have a difficulty understanding what it means to send the request parameters in the BODY. Does it mean writing in the request stream and not setting body attribute in the header - as that is what the examples would imply. How do I do that?

 apiConnection = (HttpURLConnection) url.openConnection();
apiConnection = (HttpURLConnection) url.openConnection();
		  apiConnection.setDoOutput(true);
		  apiConnection.setRequestMethod("POST");	
		  apiConnection.setDoOutput(true);		  		   

		  String test = "{\"type\":0, \"parent_id\":1885233, \"name\":\"Folder12345\"}";		  		  		
		  apiConnection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");		
		  apiConnection.setRequestProperty("OTDSTicket", ticket);
		  apiConnection.setRequestProperty("Content-Length", ??? );
		  apiConnection.setRequestProperty("body", test);		
		  apiConnection.connect();

Are you perhaps wanting a simple example? I can because I use Java nd REST API and old POJO to send the File to a predetermined location. My code does not create the folder which is very straightforward .I just googled and crafted a form post in java after observing the payload in POSTMan similar to what you have done. Will post something over the weekend.

That is the whole problem: i don't want scripts that use a lot of underlying browser infrastructure. I want a basic java with apiConnection = (HttpURLConnection) url.openConnection();. Can you show me how to do that there?

I took my java file removed somethings and made it into a word document so the reader knows what the REST API code is needing and put a heavily commented java file. Try using the main and change the REST API to how you want and see if you understand. Read my comments in the actual code and java file to see if it helps

"JAVA REST API EXPERIMENTS .docx" can be accessed via the following link: https://knowledge.opentext.com/knowledge/llisapi.dll/properties/79663164

I am looking at your document and the links you shared right now. Thanks. I will get back to you with my progress hopefully shortly.

Can you send or update your document with the exact HTML dump of the FORM that you created to upload a file? I can now use the java code to create the form on the fly but I would like to see all the fields you included in your FORM, so I don't diverge too much from it.

I have shown that in the word document but in case .There is a variable I use called CRLF which is \r\n which is very important in setting boundaries .My Document does not carry metadata.

POST /otcs/cs.exe/api/v2/nodes HTTP/1.1
Host: localhost.nairkn.com
otdsticket: *OTDSSSO**
Cache-Control: no-cache
Postman-Token: 0861d4fa-8ab6-2cdf-a060-1b8a7ee27f91
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

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

{
	"type": 144,
	"parent_id": 2032998,
	"name": "APPU DOCUMENT"
}
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="DocumentHelper.java"
Content-Type: 


------WebKitFormBoundary7MA4YWxkTrZu0gW--

Thank you! It is consistent with the boundaries code I am implementing in java. Do you know if a tool such as SoapUI (used by my client) will be able to issue such forms without programming? They do obtain a security ticket and they pass it along from a previous authentication call. GET calls work fine for us in that test tool.

https://schwiiz.org/2020/04/07/rest-api-opentext-content-server/

you might reach out or talk to several CS Vendors like Answermodules @Patrick_Vitali or Christopher Meyer

https://forums.opentext.com/forums/developer/profile/discussions/Chris%20Meyer

They probably would know this without you reinventing the wheel.