Document Upload using REST API

Hi, I was playing with REST API using powershell and I am stuck at an issue while uploading the document.

#Upload document
$Url = "http://localhost/otcs/llisapi.dll/api/v1/nodes"
$headers = @{
'OTCSTICKET' = "rg9nm0p2qYmlGnAbb9hDrktXYd8p6+X0cdjmCoGX/PNYKTy7hYOp2kS/rjJnihMg5neaI8DkWoWvfrgJss8YT9DyEd4cKWqT"
}
$Body=@{
type="144"
parent_id="9362"
name="Environment Details"
file="C:/Temp/EnvironmentDetails.txt"
description="environment details"
}
Invoke-RestMethod -Method Post -Uri $Url -Headers $headers -Body $Body

When I execute it, I receive an error "Error: File could not be found within the upload directory."

After some investigation I found that if I provide path of the files in upload directory specified in Content Server Server Parameters, file gets uploaded successfully but for any other path, I receive above error.

Has anyone encountered similar error? REST API documentation doesnt indicate that file has to be in Opentext upload folder.

Find more posts tagged with

Comments

appuGmail

That to me looks like you have to change the file="C:/Temp/EnvironmentDetails.txt" to match what you have configured for your Livelink server's Upload directory.

I am not even sure you can attach files that way. In actuality, no client program will have access to the Livelink servers upload directory as a file path. We usually send the file using an attachment object

to the form itself. Examples are in developer.opentext.com

Ciao,

..... appnair appunair( Livelink Rocks )

Well, if I called the wrong number, why did you answer the phone?
James Thurber, New Yorker cartoon caption, June 5, 1937

On Fri, Jan 11, 2019 at 4:18 AM eLink Entry: Content Server Development Forum <development@elinkkc.opentext.com> wrote:

Document Upload using REST API Posted byvishal.kashelkar@capgemini.com (Kashellkar, Vishal)On 01/11/2019 05:13 AM

Hi, I was playing with REST API using powershell and I am stuck at an issue while uploading the document. #Upload document
$Url = "http://localhost/otcs/llisapi.dll/api/v1/nodes"
$headers = @{
'OTCSTICKET' = "rg9nm0p2qYmlGnAbb9hDrktXYd8p6+X0cdjmCoGX/PNYKTy7hYOp2kS/rjJnihMg5neaI8DkWoWvfrgJss8YT9DyEd4cKWqT"
}
$Body=@{
type="144"
parent_id="9362"
name="Environment Details"
file="C:/Temp/EnvironmentDetails.txt"
description="environment details"
}
Invoke-RestMethod -Method Post -Uri $Url -Headers $headers -Body $BodyWhen I execute it, I receive an error "Error: File could not be found within the upload directory." After some investigation I found that if I provide path of the files in upload directory specified in Content Server Server Parameters, file gets uploaded successfully but for any other path, I receive above error.Has anyone encountered similar error? REST API documentation doesnt indicate that file has to be in Opentext upload folder.
[To post a comment, use the normal reply function]
Forum: Content Server Development Forum
Content Server: My Support

AKropp

Did a little searching and it looks like there’s an -InFile switch for that Invoke-Restmethod command that might do the trick. There’s some posts here that might help since the MS doc on it is pretty vague:https://stackoverflow.com/questions/42395638/how-to-use-invoke-restmethod-to-upload-jpg (or just search for “Invoke-Restmethod infile” on the engine of your choice). Basically with the original syntax you have you’re telling the server to look at its own file system for that path/file which is why it works when you put the file on the server first.

I can’t say I’ve used PS all that much so hopefully that points you in the right direction.

From: eLink Entry: Content Server Development Forum <development@elinkkc.opentext.com>
Sent: Friday, January 11, 2019 8:59 AM
To: eLink Recipient <devnull@elinkkc.opentext.com>
Subject: [EXTERNAL] - Re Document Upload using REST API

[EXTERNAL] - Re Document Upload using REST API

Posted byappnair@gmail.com (Nair, Krishnankutty) On 01/11/2019 08:58 AM

That to me looks like you have to change the file="C:/Temp/EnvironmentDetails.txt" to match what you have configured for your Livelink server's Upload directory.

to the form itself. Examples are indeveloper.opentext.com

Ciao,

..... appnair appunair( Livelink Rocks )

Well, if I called the wrong number, why did you answer the phone?
James Thurber, New Yorker cartoon caption, June 5, 1937

On Fri, Jan 11, 2019 at 4:18 AM eLink Entry: Content Server Development Forum <development@elinkkc.opentext.co m> wrote:

Document Upload using REST API

Posted byvishal.kashelkar@capgemini.com (Kashellkar, Vishal) On 01/11/2019 05:13 AM

Hi, I was playing with REST API using powershell and I am stuck at an issue while uploading the document.
#Upload document
$Url = "http://localhost/otcs/llisapi.dll/api/v1/nodes"
$headers = @{
'OTCSTICKET' = "rg9nm0p2qYmlGnAbb9hDrktXYd8p6+X0cdjmCoGX/PNYKTy7hYOp2kS/rjJnihMg5neaI8DkWoWvfrgJss8YT9DyEd4cKWqT"
}
$Body=@{
type="144"
parent_id="9362"
name="Environment Details"
file="C:/Temp/EnvironmentDetails.txt"
description="environment details"
}
Invoke-RestMethod -Method Post -Uri $Url -Headers $headers -Body $Body
When I execute it, I receive an error "Error: File could not be found within the upload directory."
After some investigation I found that if I provide path of the files in upload directory specified in Content Server Server Parameters, file gets uploaded successfully but for any other path, I receive above error.
Has anyone encountered similar error? REST API documentation doesnt indicate that file has to be in Opentext upload folder.
[To post a comment, use the normal reply function]
Forum:
Content Server Development Forum
Content Server:
My Support

[To post a comment, use the normal reply function]
Topic:	Document Upload using REST API
Forum:	Content Server Development Forum
Content Server:	My Support

Kashellkar_Vishal

Hi,

thanks for your reply. Yes, as I had mentioned in OP, if I provide the Livelink upload directory path then it works.

I tried to replicate the issue using Postman and it gave me same error. I then made some change to 'file" parameter and it worked. Basically I changed the type of "file" parameter from Text to File and it worked.

Now trying to find how to achieve the same in powershell.

Quoted Krishnankutty Nair on 01/11/2019 11:08 AM:

That to me looks like you have to change the file="C:/Temp/EnvironmentDetails.txt" to match what you have configured for your Livelink server's Upload directory.

to the form itself. Examples are in developer.opentext.com

Ciao,

..... appnair appunair( Livelink Rocks )

Well, if I called the wrong number, why did you answer the phone?
James Thurber, New Yorker cartoon caption, June 5, 1937

On Fri, Jan 11, 2019 at 4:18 AM eLink Entry: Content Server Development Forum <development@elinkkc.opentext.com> wrote:

Document Upload using REST API Posted by vishal.kashelkar@capgemini.com (Kashellkar, Vishal) On 01/11/2019 05:13 AM

Hi, I was playing with REST API using powershell and I am stuck at an issue while uploading the document.

#Upload document
$Url = "http://localhost/otcs/llisapi.dll/api/v1/nodes"
$headers = @{
'OTCSTICKET' = "rg9nm0p2qYmlGnAbb9hDrktXYd8p6+X0cdjmCoGX/PNYKTy7hYOp2kS/rjJnihMg5neaI8DkWoWvfrgJss8YT9DyEd4cKWqT"
}
$Body=@{
type="144"
parent_id="9362"
name="Environment Details"
file="C:/Temp/EnvironmentDetails.txt"
description="environment details"
}
Invoke-RestMethod -Method Post -Uri $Url -Headers $headers -Body $Body

When I execute it, I receive an error "Error: File could not be found within the upload directory."

After some investigation I found that if I provide path of the files in upload directory specified in Content Server Server Parameters, file gets uploaded successfully but for any other path, I receive above error.

Has anyone encountered similar error? REST API documentation doesnt indicate that file has to be in Opentext upload folder.

[To post a comment, use the normal reply function]
Forum: Content Server Development Forum
Content Server: My Support

Kashellkar_Vishal

Hi Alex,

Thanks for your reply. Unfortunately -inFile switch didnt work for me. I've realised that I am sending the data as Body instead of sending it as Form data.

I am new to Powershell so I think once I figure out how to pass the data as formdata, it should work in powershell.

I'll share the details once I get it working.

Quoted Alex Kropp on 01/11/2019 11:42 AM:

Did a little searching and it looks like there’s an -InFile switch for that Invoke-Restmethod command that might do the trick. There’s some posts here that might help since the MS doc on it is pretty vague: https://stackoverflow.com/questions/42395638/how-to-use-invoke-restmethod-to-upload-jpg (or just search for “Invoke-Restmethod infile” on the engine of your choice). Basically with the original syntax you have you’re telling the server to look at its own file system for that path/file which is why it works when you put the file on the server first.

I can’t say I’ve used PS all that much so hopefully that points you in the right direction.

[EXTERNAL] - Re Document Upload using REST API

Posted by appnair@gmail.com (Nair, Krishnankutty) On 01/11/2019 08:58 AM

That to me looks like you have to change the file="C:/Temp/EnvironmentDetails.txt" to match what you have configured for your Livelink server's Upload directory.

to the form itself. Examples are in developer.opentext.com

Ciao,

..... appnair appunair( Livelink Rocks )

Well, if I called the wrong number, why did you answer the phone?
James Thurber, New Yorker cartoon caption, June 5, 1937

On Fri, Jan 11, 2019 at 4:18 AM eLink Entry: Content Server Development Forum <development@elinkkc.opentext.co m> wrote:

Document Upload using REST API

Posted by vishal.kashelkar@capgemini.com (Kashellkar, Vishal) On 01/11/2019 05:13 AM

Hi, I was playing with REST API using powershell and I am stuck at an issue while uploading the document.

#Upload document
$Url = "http://localhost/otcs/llisapi.dll/api/v1/nodes"
$headers = @{
'OTCSTICKET' = "rg9nm0p2qYmlGnAbb9hDrktXYd8p6+X0cdjmCoGX/PNYKTy7hYOp2kS/rjJnihMg5neaI8DkWoWvfrgJss8YT9DyEd4cKWqT"
}
$Body=@{
type="144"
parent_id="9362"
name="Environment Details"
file="C:/Temp/EnvironmentDetails.txt"
description="environment details"
}
Invoke-RestMethod -Method Post -Uri $Url -Headers $headers -Body $Body

When I execute it, I receive an error "Error: File could not be found within the upload directory."

After some investigation I found that if I provide path of the files in upload directory specified in Content Server Server Parameters, file gets uploaded successfully but for any other path, I receive above error.

Has anyone encountered similar error? REST API documentation doesnt indicate that file has to be in Opentext upload folder.

[To post a comment, use the normal reply function]

Forum:

Content Server Development Forum

Content Server:

My Support

[To post a comment, use the normal reply function]
Topic:	Document Upload using REST API
Forum:	Content Server Development Forum
Content Server:	My Support

appuGmail

OK, I never saw that but thought how is somebody going to get access to the LL Server File system?

Does AK's method work. I do not know PowerShell to be good about it

Unless you were developing an application server side like a bulk load I see no way your application will be able to get File system access to the actual Livelink server

Typically the FileContent is delivered to the temp or in this case a file upload directory and Livelink application puts it into an External File System

This is a sample file I use to test FileUploads but it is javascript.

********************JavaScript code*********************************

function fCreateDoc (file) {

alert("CreateDoc: " + myTicket);

var myBody = { type: "144", parent_id: ParentID, name: file.name };

formData = new FormData();

formData.append('body', JSON.stringify(myBody));

formData.append('file', file);

$(document).ready(function(){

var url = baseURL+'/api/v1/nodes';

$.support.cors = true;

$.ajax({

url:url,

type:"POST",

crossDomain: true,

data:formData,

processData: false,

contentType: false,

headers: { "OTCSTICKET": myTicket },

success:function(res){

alert("success!");

alert(res);

error:function(res){

alert("Bad thing happened! " + res.statusText);

alert(res);

console.log("Bad thing happend! " + res.statusText);

console.log(res);

}

});

}

the file Object is a File control that shows a local file system.

For e.g my Form has it defined as.

I believe this is similar to what OT developers post at Developer

This apparently works in my simple CS16 system

Ciao,

..... appnair appunair( Livelink Rocks )

Well, if I called the wrong number, why did you answer the phone?
James Thurber, New Yorker cartoon caption, June 5, 1937

On Fri, Jan 11, 2019 at 10:14 AM eLink Entry: Content Server Development Forum <development@elinkkc.opentext.com> wrote:

[EXTERNAL] - Re Document Upload using REST API Posted byvishal.kashelkar@capgemini.com (Kashellkar, Vishal)On 01/11/2019 11:08 AM

Hi,thanks for your reply. Yes, as I had mentioned in OP, if I provide the Livelink upload directory path then it works. I tried to replicate the issue using Postman and it gave me same error. I then made some change to 'file" parameter and it worked. Basically I changed the type of "file" parameter from Text to File and it worked.Now trying to find how to achieve the same in powershell.Quoted Krishnankutty Nair on 01/11/2019 11:08 AM:

That to me looks like you have to change the file="C:/Temp/EnvironmentDetails.txt" to match what you have configured for your Livelink server's Upload directory.
I am not even sure you can attach files that way. In actuality, no client program will have access to the Livelink servers upload directory as a file path. We usually send the file using an attachment object
to the form itself. Examples are in developer.opentext.com

Ciao,
..... appnair appunair( Livelink Rocks )
Well, if I called the wrong number, why did you answer the phone?
James Thurber, New Yorker cartoon caption, June 5, 1937

On Fri, Jan 11, 2019 at 4:18 AM eLink Entry: Content Server Development Forum <development@elinkkc.opentext.com> wrote:
Document Upload using REST API Posted by vishal.kashelkar@capgemini.com (Kashellkar, Vishal) On 01/11/2019 05:13 AM

Hi, I was playing with REST API using powershell and I am stuck at an issue while uploading the document.

#Upload document
$Url = "http://localhost/otcs/llisapi.dll/api/v1/nodes"
$headers = @{
'OTCSTICKET' = "rg9nm0p2qYmlGnAbb9hDrktXYd8p6+X0cdjmCoGX/PNYKTy7hYOp2kS/rjJnihMg5neaI8DkWoWvfrgJss8YT9DyEd4cKWqT"
}
$Body=@{
type="144"
parent_id="9362"
name="Environment Details"
file="C:/Temp/EnvironmentDetails.txt"
description="environment details"
}
Invoke-RestMethod -Method Post -Uri $Url -Headers $headers -Body $Body

When I execute it, I receive an error "Error: File could not be found within the upload directory."

After some investigation I found that if I provide path of the files in upload directory specified in Content Server Server Parameters, file gets uploaded successfully but for any other path, I receive above error.

Has anyone encountered similar error? REST API documentation doesnt indicate that file has to be in Opentext upload folder.

[To post a comment, use the normal reply function]
Forum: Content Server Development Forum
Content Server: My Support

[To post a comment, use the normal reply function]
Topic:	Document Upload using REST API
Forum:	Content Server Development Forum
Content Server:	My Support

Steve Bauman

I'm having this same issue with the same error as well. It seems you can't actually upload files using cURL or any backend process that posts HTTP requests for that matter. It appears only JavaScript async uploads are supported - which is dissapointing.

I've also discovered that you can place the file in your configured "Uploads" folder in OpenText Content Server first, and then call the API via a background process - but actually performing the upload does not work.

Kashellkar_Vishal

Had some time again to followup with this issue I had faced and finally managed to get it working. its not pretty but it works. I have not tested it with large documents.

#This powershell function uploads the text document into Content server using REST APIs

function Node-Upload
{
#define parameters accepted by this function
param([string]$URL, [string]$CsToken, [string]$filePath)

$fileContent = [IO.File]::ReadAllText($filePath)

#Upload document
$headers = @{
'OTCSTICKET' = $CsToken
'Content-Type' = 'application/x-www-form-urlencoded'
'Accept' = '*/*'
'accept-encoding' = 'gzip, deflate'
'Cache-Control' = 'no-cache'
}

$fileBytes = [System.IO.File]::ReadAllBytes($FilePath)
$fileEnc = [System.Text.Encoding]::GetEncoding('UTF-8').GetString($fileBytes)
$boundary = [System.Guid]::NewGuid().ToString()
$LF = "`r`n"

$bodyLines = (
"--$boundary",
"Content-Disposition: form-data; name=`"file`"; filename=`"temp.txt`"",
"Content-Type: application/octet-stream$LF",
$fileEnc,
"--$boundary",
"Content-Disposition: form-data; name=`"type`"$LF",
144,
"--$boundary",
"Content-Disposition: form-data; name=`"parent_id`"$LF",
2000,
"--$boundary",
"Content-Disposition: form-data; name=`"name`"$LF",
'my name',
"--$boundary",
"Content-Disposition: form-data; name=`"description`"$LF",
'my test description',
"--$boundary--$LF"
) -join $LF

$paramURL = $URL + "/api/v2/nodes"
$contentType = "multipart/form-data; boundary=`"$boundary`"'"
$documentNode = Invoke-RestMethod -Method Post -Uri $paramURL -Headers $headers -Body $bodyLines -ContentType $contentType
}

C_Kent_Jordan

Thanks for your powershell example @Kashellkar_Vishal , Working on a similar project, had issues with the encoding in the PS script that produced a corrupt file version added to OTCS.

had to use the below as UTF-8 was total mess and Windows-1252 encoding produced exactly the correct size but all PDF / Office formats were still corrupt.

$encodingScheme = [System.Text.Encoding]::GetEncoding("iso-8859-1")

$FileEnc = $encodingScheme.GetString($FileBytes)

This was on a windows server 2016 with $PSVersionTable

PSVersion 5.1.17763.1007

PSEdition Desktop

PSCompatibleVersions {1.0, 2.0, 3.0, 4.0...}

BuildVersion 10.0.17763.1007

CLRVersion 4.0.30319.42000

WSManStackVersion 3.0

PSRemotingProtocolVersion 2.3

SerializationVersion 1.1.0.1

Another lesson learned is that OTCS Rest will reject any form POST that does not have "name=file" which standard powershell and .Net components do not support (or at least I have not found a way to add / override). So @Kashellkar_Vishal has the only valid approach in Powershell to creating the multipart form that I have found.

Regards,

Kent

ThomasHeusser

I try to do a ajax / javascript upload and I get the same error Error:

{"errMsg":{"detail":null,"message":"Error: File could not be found within the upload directory.","prefix":"Error adding new item."},"ok":false}

i can not find the mentioned solution on "developer". Where should i find this?

has anyone a working solution with javascript / ajax to upload a file to a given ParaentID

Thomas

Kashellkar_Vishal

@Appu Nair has posted an example of document upload using Javascript in this thread. Have you tried that?

ThomasHeusser

Yes, i did, yesterday, it figured out, my Problem was the handling of <input type="file" ...>

Yesterday night it worked with this:

form.append("file", $('#myFile')[0].files[0]);

Today i get with the same code the error:

{"error":"Authentication Required"}

I do not understand it yet, because in the step before i got a valid token i use for the upload:

{"errMsg":"","ok":true,"token":"xWHiTlovNWvKNkixppoGCUPHKUbir2T6pfzA2yClDZS2F3PVArGAEVcn1UuG2dxGOB2Dtxqafjc="}

Kashellkar_Vishal

I assume, you used that token in header of the upload call. In that case it should work.

Appu Nair

Make sure you get a OTDStoken and use that
The call then gets called by header
OTDSTicket instead of OTCSTicket. If that works consistently as against OTCSTicket I would assume that your livelink servers are using full octets in security Params .For best results use the setting ‘ Do not use IP for authenticaction’ in that screen for every livelink server that needs to perform rest api
The tricky part when using postman is the file is a type of File object which you pick from the file system don’t think of it like C:\temp.txt you have to use the filepicker that is probably what I use in the js file I posted .

There is a parameter called body which you build in the Body area of Postman , the file goes in the same place

OE6PMG

Just for the completeness of this thread as I couldn't find a lot of information on the web on how to do it with Powershell beside this thread.

Kashellkar_Vishal was creating the multipart/form-data request manually - which works well and is the only way to do it with any version up to Powershell 5.1.

At least with versions >=7.0 of Powershell you can do it the following way:

# create a form object where you put all OT necessary informations into - including the file 
# you want to upload. Simply use Get-Item for the file - no need to to encode any more.
$form = @{
        file = Get-Item -Path $fullpath
        type = 144
        parent_id = $parentid
        name = $item.name
    }
$contentType = "multipart/form-data"

# use the param -Form for the Rest method
$result = Invoke-RestMethod -Method Post -Uri $api_url -Form $form -Headers $header -ContentType $contentType

I also struggled with the 2GB limit per file - but also here Powershell 7.x seems to have solved it using the Get-Item command - whereas [System.IO.File]::ReadAllBytes(...) will still throw an error.

Just thought I'd share here for the next people searching for such a solution.