nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

What form does the Content Server REST Add Version API call take

HFCDev

I'm trying to use Content Server's REST API to append a version to a document. Specifically, I'm trying to use /api/v2/nodes/{nodeId}/versions API call. I'd like to get this one working before I start trying to use the large file upload API.

Strangely, unlike the case for creating a net new document, CS is expecting an x-www-form-urlencoded request as opposed to FormData. With the latter, you can upload as a stream, and from Postman, you can make the parameter of type File which will allow you to choose the file to be embedded in the request. In the documentation, it specifies that the body is expected to have a file parameter of type string($binary) which I presume to mean a stringified version of the file contents. I tried with just the file parameter in my request to be just some text, i.e "This is some text content to be appended as a version", and I tried the same but with a body parameter with file as a JSON param (i.e. {"file": "This is some text…."}

Neither work. With or without the CS file upload setting set, they fail. it looks like Content Server is looking for a filename in the file parameter - which would be meaningless unless I am able to stream the file contents into the request somehow.

Can anyone tell me how I should be formatting an Add Version request in Postman? If I can get it working there, I can figure out how to get it working elsewhere.

Thanks in advance

Find more posts tagged with

Note:

If there are Accepted Answers, those will be shown by default. You can switch to 'All Replies' by selecting the tab below.

Button

Accepted answers

HFCDev

I got it working! I had to remove the body param and just upload the file object. So, my Postman looks like this:

All comments

appuq

I have always done it as a File where you are sending multipart form data is that not working for you? doyou just need a Postman screencap for AddVersion?

HFCDev

Actually, that's exactly what I'm looking for. I tried it as multipart/form, and in my node JS app, used a FormData() object, but it was erroring out. The documentation stated x-www-form-urlencoded. When you choose that content type in Postman, it doesn't let you pass a reference to the file - it's expecting the file field to be the entire file contents (the documentation declares the file parameter as string($binary).

appuq

For me it cannot ever pass in as a file Object for what its worth heres how it would look in postman

now the body has to have this in JSON

{ "file": "E:\\UserInstalled\\upload\\appu.docx", "file_content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "file_filename": "appu"}

The HTTP POST will look like this POST /otcs/cs.exe/api/v2/nodes/209636/versions HTTP/1.1
Host: hhhhhhhhhh:8080
otdsticket: OTDSSSOAaxBQ33YsnD83SwAA
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Length: 311

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

{
"file": "E:\UserInstalled\upload\appu.docx",
"file_content_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"file_filename": "appu"
}
------WebKitFormBoundary7MA4YWxkTrZu0gW-- I have taken this code from postman and wrapped it in a blog posting using java see this link towards bottom it has a java source file https://appukili.wordpress.com/2022/04/17/take-some-rest/

HSS2021

In bruno, it lets me send the file as a file object, using Multipart Form:

for body since its not viewable all I added was: {"external_modify_date":"2026-09-14T20:33:17.385Z"}

HFCDev

I'm still missing something. It appears you're passing a local path, not one that Content Server would know anything about. I created the following JSON for my file to append as a version:

{
"file": "/home/hugh/Downloads/StickControl-page2.pdf",
"file_content_type": "application/pdf",
"file_name": "StickControl-page2.pdf"
}

If I put this in the body param in my Postman and Content Type to FormData, I get this error: Body parameter is invalid:

Now, if I set content type to x-www-form-urlencoded and pass the same JSON as the body, I get the following:

I guess part of my confusion here is exactly what file path am I passing? If I pass the client local file path, that path cannot exist on the server. So where is Content Server getting the actual file content from for the add version call? For document create it was very simple. You can use formdata as opposed to x-form-urlencoded, meaning you can pass a file parameter which is just a read stream from nodeJS filesytem util (fs), i.e.

const formData = new FormData();

formData.append("body", JSON.stringify(payload));

formData.append('file', fs.createReadStream(filespec));

where payload is the JSON where you specify object type, destination Content Server name, roles, categories, etc.

HFCDev

I got it working! I had to remove the body param and just upload the file object. So, my Postman looks like this:

appuq

I am including my Postman Collection the two varieties of AddVersion here can you import that and see the file from tx to json and you can see the paylod

https://knowledge.opentext.com/knowledge/llisapi.dll/Properties/83404212

HFCDev

Thanks….good to do a comparison. I noticed that in your create doc, you have the file embedded in the body param, at least a file path. For mine, I do what you did in your AddVersion, which is having both a body and a file param, where the file param is of type file. I managed to get this to work now for both add version and create net new.

AbelJM

@HFCDev If you need to programmatically create document versions directly within Content Server—whether triggered by a specific event or an external API call—consider using Content Scripts from Module Suite. It is a powerful add-on for Content Server designed to significantly accelerate development.