eDocs - Rest API - Update a document

Laubstein · 2021-07-08T23:00:26+00:00

There was an error rendering this rich post.

Hi,

I need to update the contents of a document, checking the document`s endpoints of the Rest API: https://developer.opentext.com/apis/9ca24bb2-a89a-446a-96dc-3138b8a5622f/eDOCS%20REST%20API#tag/documents I could not find a way to do it.

I known it is possible to do with the DM COM API as follows:

Is there a way to do it using the Rest API and which endpoint to use and what are the required parameters?

Ps: I don`t want to create a new version of the document.

Thanks.

Find more posts tagged with

eDOCS

Comments

Al Slapsys

New document: POST .../documents

New version: POST .../documents/<id>/

New sub version: POST .../documents/<id>/versions/<versionid>

Replace existing version: PUT .../documents/<id>/versions/<versionid>

Venugangad

I do not find the restApi for PUT .../documents/<id>/versions/<versionid> in the api document reference https://developer.opentext.com/apis/9ca24bb2-a89a-446a-96dc-3138b8a5622f/eDOCS%20REST%20API#tag/documents .

Please help to get that.

Laubstein

Hi @Venugangad , I am having a really hard time trying to integrate with the Rest API, I am mixing Rest and COM calls because the Rest API is poorly documented.

When I try to use the PUT .../documents/<id>/versions/<versionid> with Content-Type: multipart/form-data setting the file alone or with a simplified data structure it does not work and returns:

{

"ERROR": {

"message": "",

"rapi_code": 1

}

We are in the same boat, if you figure out how to make it work, please let me know, I would be very happy not to have to use the COM API.

Al Slapsys

Looking back at my previous answer, I incorrectly left the last component as "versionid" instead of changing it to the version label. Sorry for the confusion

Replace existing version: PUT .../documents/<id>/versions/<versionlabel>

To get more information you could turn up REST API logging. This is done through the "edocs.cfg" file found under the REST API's "edocs" folder. Set the "LoggingLevel" from INFO to DEBUG and restart the REST API

The log file would include something like this:

Format: <Time stamp> <ip address> [<userid>][<threadid>] <logginglevel>: <error message>

Venugangad

thanks For your reply..

Able to create subversion with Post..

But I am getting below error when I try with PUT(override);

2021-07-27 17:41:35,783 [ 10.141.41.215][SYSTEM][9624]DEBUG: REQUEST ERROR

PUT /edocsapi/v1.0/documents/937/versions/1D?library=EDOCSPPDEV2

The parameter is incorrect.

2021-07-27 17:41:35,783 [ 127.0.0.1][SYSTEM][9624]WARNING: BAD REQUEST [PUT]

Al Slapsys

@Venugangad which version of the REST API are you using?

Venugangad

I am using 16.7.2

Al Slapsys

Could you post the portion of the DM Server log that shows all the interactions with that document?

Venugangad

we already logging all the logs, please refer below screenshot

Venugangad

Even, I have changed to log calls, still getting below error in api logs

2021-07-30 13:20:08,421 [ 10.118.34.211][SYSTEM][11836]DEBUG: REQUEST ERROR

PUT /edocsapi/v1.0/documents/937/versions/1D?library=EDOCSPPDEV2

The parameter is incorrect.

2021-07-30 13:20:08,421 [ 127.0.0.1][SYSTEM][11836]WARNING: BAD REQUEST [PUT]

Venugangad

edocs logs.txt

adding logs

Al Slapsys

The DM Server log shows the error:

PutDoc <@<!Start OUTPUT For CallId<80027> ( Status<-2147221039 (0x800401D1)>)

The "Document is unlocked" error would indicate that the document wasn't locked/checked out prior to attempting to replace it.

Venugangad

Thanks a lot Al Slapsys.. it works fine. You saved my time.

Thanks a lot.

Venugangad

adding server logs

Server log :

2021-07-30 13:29:29.526 +05:30 [WRN] PutDoc failed in 68.8209 ms. ErrorCode=0x-2147221039 ErrorMessage=SHAREPOINT-SRV: SHAREPOINT-SRV: Document is unlocked.

{CallParameters: { library: "EDOCSPPDEV2", documentNumber: 937, versionId: 4684 }, User: "edocsPPdev2/ARUL", CallerAddress: "10.234.82.164", SourceContext: "DmSvr", MachineName: "SHAREPOINT-SRV", ThreadId: 62, CorrelationId: "8f06cd61-cb77-40a8-b85e-08bbc2b5688a"}

2021-07-30 13:29:29.541 +05:30 [WRN] UpdateObject failed in 15.3438 ms. ErrorCode=0x-2147221039 ErrorMessage=SHAREPOINT-SRV: SHAREPOINT-SRV: Document is unlocked.

{CallParameters: { Properties: { Count: 3, Names: ["%OBJECT_IDENTIFIER", "%STATUS", "%TARGET_LIBRARY"], Values: ["937", "%UNLOCK", "EDOCSPPDEV2"] } }, DmObjectType: "DEF_PROF", User: "edocsPPdev2/ARUL", CallerAddress: "10.234.82.164", SourceContext: "DmSvr", MachineName: "SHAREPOINT-SRV", ThreadId: 62, CorrelationId: "d08ef69a-3e20-480f-bbb6-2802f26c1882"}

another log file:

Fri Jul 30 2021 13:29:29.465: PutDoc <@<! StartCallId<80027>( ,

DST<EDOCSPPDEV2/ARUL> Timezone<UTC>,

"EDOCSPPDEV2",

937,

4684)!>@>

Fri Jul 30 2021 13:29:29.533: Release <@<! StartCallId<80028>( ,

Interface<000000DB38961B50>)!>@>

PutDoc <@<!Start OUTPUT For CallId<80027> ( Status<-2147221039 (0x800401D1)>)

End OUTPUT for CallId<80027> Elapsed Time = 64 ms.!>@>

Fri Jul 30 2021 13:29:29.540: UpdateObject <@<! StartCallId<80029>( ,

DST<EDOCSPPDEV2/ARUL> Timezone<UTC>,

"DEF_PROF",

Property Values, Count:3

"%OBJECT_IDENTIFIER" = <BSTR: "937">,

"%STATUS" = <BSTR: "%UNLOCK">,

"%TARGET_LIBRARY" = <BSTR: "EDOCSPPDEV2">

>)!>@>

UpdateObject <@<!Start OUTPUT For CallId<80029> ( Status<-2147221039 (0x800401D1)>)

End OUTPUT for CallId<80029> Elapsed Time = 15 ms.!>@>

Venugangad

adding logs

Server log :

2021-07-30 13:29:29.526 +05:30 [WRN] PutDoc failed in 68.8209 ms. ErrorCode=0x-2147221039 ErrorMessage=SHAREPOINT-SRV: SHAREPOINT-SRV: Document is unlocked.

2021-07-30 13:29:29.541 +05:30 [WRN] UpdateObject failed in 15.3438 ms. ErrorCode=0x-2147221039 ErrorMessage=SHAREPOINT-SRV: SHAREPOINT-SRV: Document is unlocked.

another log file:

Fri Jul 30 2021 13:29:29.465: PutDoc <@<! StartCallId<80027>( ,

DST<EDOCSPPDEV2/ARUL> Timezone<UTC>,

"EDOCSPPDEV2",

937,

4684)!>@>

Fri Jul 30 2021 13:29:29.533: Release <@<! StartCallId<80028>( ,

Interface<000000DB38961B50>)!>@>

PutDoc <@<!Start OUTPUT For CallId<80027> ( Status<-2147221039 (0x800401D1)>)

End OUTPUT for CallId<80027> Elapsed Time = 64 ms.!>@>

Fri Jul 30 2021 13:29:29.540: UpdateObject <@<! StartCallId<80029>( ,

DST<EDOCSPPDEV2/ARUL> Timezone<UTC>,

"DEF_PROF",

Property Values, Count:3

"%OBJECT_IDENTIFIER" = <BSTR: "937">,

"%STATUS" = <BSTR: "%UNLOCK">,

"%TARGET_LIBRARY" = <BSTR: "EDOCSPPDEV2">

>)!>@>

UpdateObject <@<!Start OUTPUT For CallId<80029> ( Status<-2147221039 (0x800401D1)>)

End OUTPUT for CallId<80029> Elapsed Time = 15 ms.!>@>

Venugangad

adding logs

Server log :

2021-07-30 13:29:29.526 +05:30 [WRN] PutDoc failed in 68.8209 ms. ErrorCode=0x-2147221039 ErrorMessage=SHAREPOINT-SRV: SHAREPOINT-SRV: Document is unlocked.

2021-07-30 13:29:29.541 +05:30 [WRN] UpdateObject failed in 15.3438 ms. ErrorCode=0x-2147221039 ErrorMessage=SHAREPOINT-SRV: SHAREPOINT-SRV: Document is unlocked.

another log file:

Fri Jul 30 2021 13:29:29.465: PutDoc <@<! StartCallId<80027>( ,

DST<EDOCSPPDEV2/ARUL> Timezone<UTC>,

"EDOCSPPDEV2",

937,

4684)!>@>

Fri Jul 30 2021 13:29:29.533: Release <@<! StartCallId<80028>( ,

Interface<000000DB38961B50>)!>@>

PutDoc <@<!Start OUTPUT For CallId<80027> ( Status<-2147221039 (0x800401D1)>)

End OUTPUT for CallId<80027> Elapsed Time = 64 ms.!>@>

Fri Jul 30 2021 13:29:29.540: UpdateObject <@<! StartCallId<80029>( ,

DST<EDOCSPPDEV2/ARUL> Timezone<UTC>,

"DEF_PROF",

Property Values, Count:3

"%OBJECT_IDENTIFIER" = <BSTR: "937">,

"%STATUS" = <BSTR: "%UNLOCK">,

"%TARGET_LIBRARY" = <BSTR: "EDOCSPPDEV2">

>)!>@>

UpdateObject <@<!Start OUTPUT For CallId<80029> ( Status<-2147221039 (0x800401D1)>)

End OUTPUT for CallId<80029> Elapsed Time = 15 ms.!>@>

Venugangad

adding logs

Server log :

2021-07-30 13:29:29.526 +05:30 [WRN] PutDoc failed in 68.8209 ms. ErrorCode=0x-2147221039 ErrorMessage=SHAREPOINT-SRV: SHAREPOINT-SRV: Document is unlocked.

2021-07-30 13:29:29.541 +05:30 [WRN] UpdateObject failed in 15.3438 ms. ErrorCode=0x-2147221039 ErrorMessage=SHAREPOINT-SRV: SHAREPOINT-SRV: Document is unlocked.

another log file:

Fri Jul 30 2021 13:29:29.465: PutDoc <@<! StartCallId<80027>( ,

DST<EDOCSPPDEV2/ARUL> Timezone<UTC>,

"EDOCSPPDEV2",

937,

4684)!>@>

Fri Jul 30 2021 13:29:29.533: Release <@<! StartCallId<80028>( ,

Interface<000000DB38961B50>)!>@>

PutDoc <@<!Start OUTPUT For CallId<80027> ( Status<-2147221039 (0x800401D1)>)

End OUTPUT for CallId<80027> Elapsed Time = 64 ms.!>@>

Fri Jul 30 2021 13:29:29.540: UpdateObject <@<! StartCallId<80029>( ,

DST<EDOCSPPDEV2/ARUL> Timezone<UTC>,

"DEF_PROF",

Property Values, Count:3

"%OBJECT_IDENTIFIER" = <BSTR: "937">,

"%STATUS" = <BSTR: "%UNLOCK">,

"%TARGET_LIBRARY" = <BSTR: "EDOCSPPDEV2">

>)!>@>

UpdateObject <@<!Start OUTPUT For CallId<80029> ( Status<-2147221039 (0x800401D1)>)

End OUTPUT for CallId<80029> Elapsed Time = 15 ms.!>@>

Venugangad

adding logs,

Server log :

2021-07-30 13:29:29.526 +05:30 [WRN] PutDoc failed in 68.8209 ms. ErrorCode=0x-2147221039 ErrorMessage=SHAREPOINT-SRV: SHAREPOINT-SRV: Document is unlocked.

2021-07-30 13:29:29.541 +05:30 [WRN] UpdateObject failed in 15.3438 ms. ErrorCode=0x-2147221039 ErrorMessage=SHAREPOINT-SRV: SHAREPOINT-SRV: Document is unlocked.

another log file:

Fri Jul 30 2021 13:29:29.465: PutDoc <@<! StartCallId<80027>( ,

DST<EDOCSPPDEV2/ARUL> Timezone<UTC>,

"EDOCSPPDEV2",

937,

4684)!>@>

Fri Jul 30 2021 13:29:29.533: Release <@<! StartCallId<80028>( ,

Interface<000000DB38961B50>)!>@>

PutDoc <@<!Start OUTPUT For CallId<80027> ( Status<-2147221039 (0x800401D1)>)

End OUTPUT for CallId<80027> Elapsed Time = 64 ms.!>@>

Fri Jul 30 2021 13:29:29.540: UpdateObject <@<! StartCallId<80029>( ,

DST<EDOCSPPDEV2/ARUL> Timezone<UTC>,

"DEF_PROF",

Property Values, Count:3

"%OBJECT_IDENTIFIER" = <BSTR: "937">,

"%STATUS" = <BSTR: "%UNLOCK">,

"%TARGET_LIBRARY" = <BSTR: "EDOCSPPDEV2">

>)!>@>

UpdateObject <@<!Start OUTPUT For CallId<80029> ( Status<-2147221039 (0x800401D1)>)

End OUTPUT for CallId<80029> Elapsed Time = 15 ms.!>@>

Venugangad

Server log :

2021-07-30 13:29:29.526 +05:30 [WRN] PutDoc failed in 68.8209 ms. ErrorCode=0x-2147221039 ErrorMessage=SHAREPOINT-SRV: SHAREPOINT-SRV: Document is unlocked.

2021-07-30 13:29:29.541 +05:30 [WRN] UpdateObject failed in 15.3438 ms. ErrorCode=0x-2147221039 ErrorMessage=SHAREPOINT-SRV: SHAREPOINT-SRV: Document is unlocked.

another log file:

Fri Jul 30 2021 13:29:29.465: PutDoc <@<! StartCallId<80027>( ,

DST<EDOCSPPDEV2/ARUL> Timezone<UTC>,

"EDOCSPPDEV2",

937,

4684)!>@>

Fri Jul 30 2021 13:29:29.533: Release <@<! StartCallId<80028>( ,

Interface<000000DB38961B50>)!>@>

PutDoc <@<!Start OUTPUT For CallId<80027> ( Status<-2147221039 (0x800401D1)>)

End OUTPUT for CallId<80027> Elapsed Time = 64 ms.!>@>

Fri Jul 30 2021 13:29:29.540: UpdateObject <@<! StartCallId<80029>( ,

DST<EDOCSPPDEV2/ARUL> Timezone<UTC>,

"DEF_PROF",

Property Values, Count:3

"%OBJECT_IDENTIFIER" = <BSTR: "937">,

"%STATUS" = <BSTR: "%UNLOCK">,

"%TARGET_LIBRARY" = <BSTR: "EDOCSPPDEV2">

>)!>@>

UpdateObject <@<!Start OUTPUT For CallId<80029> ( Status<-2147221039 (0x800401D1)>)

End OUTPUT for CallId<80029> Elapsed Time = 15 ms.!>@>

Venugangad

Server log :

2021-07-30 13:29:29.526 +05:30 [WRN] PutDoc failed in 68.8209 ms. ErrorCode=0x-2147221039 ErrorMessage=SHAREPOINT-SRV: SHAREPOINT-SRV: Document is unlocked.

2021-07-30 13:29:29.541 +05:30 [WRN] UpdateObject failed in 15.3438 ms. ErrorCode=0x-2147221039 ErrorMessage=SHAREPOINT-SRV: SHAREPOINT-SRV: Document is unlocked.

another log file:

Fri Jul 30 2021 13:29:29.465: PutDoc <@<! StartCallId<80027>( ,

DST<EDOCSPPDEV2/ARUL> Timezone<UTC>,

"EDOCSPPDEV2",

937,

4684)!>@>

Fri Jul 30 2021 13:29:29.533: Release <@<! StartCallId<80028>( ,

Interface<000000DB38961B50>)!>@>

PutDoc <@<!Start OUTPUT For CallId<80027> ( Status<-2147221039 (0x800401D1)>)

End OUTPUT for CallId<80027> Elapsed Time = 64 ms.!>@>

Fri Jul 30 2021 13:29:29.540: UpdateObject <@<! StartCallId<80029>( ,

DST<EDOCSPPDEV2/ARUL> Timezone<UTC>,

"DEF_PROF",

Property Values, Count:3

"%OBJECT_IDENTIFIER" = <BSTR: "937">,

"%STATUS" = <BSTR: "%UNLOCK">,

"%TARGET_LIBRARY" = <BSTR: "EDOCSPPDEV2">

>)!>@>

UpdateObject <@<!Start OUTPUT For CallId<80029> ( Status<-2147221039 (0x800401D1)>)

End OUTPUT for CallId<80029> Elapsed Time = 15 ms.!>@>

Venugangad

Server log :

2021-07-30 13:29:29.526 +05:30 [WRN] PutDoc failed in 68.8209 ms. ErrorCode=0x-2147221039 ErrorMessage=SHAREPOINT-SRV: SHAREPOINT-SRV: Document is unlocked.

2021-07-30 13:29:29.541 +05:30 [WRN] UpdateObject failed in 15.3438 ms. ErrorCode=0x-2147221039 ErrorMessage=SHAREPOINT-SRV: SHAREPOINT-SRV: Document is unlocked.

another log file:

Fri Jul 30 2021 13:29:29.465: PutDoc <@<! StartCallId<80027>( ,

DST<EDOCSPPDEV2/ARUL> Timezone<UTC>,

"EDOCSPPDEV2",

937,

4684)!>@>

Fri Jul 30 2021 13:29:29.533: Release <@<! StartCallId<80028>( ,

Interface<000000DB38961B50>)!>@>

PutDoc <@<!Start OUTPUT For CallId<80027> ( Status<-2147221039 (0x800401D1)>)

End OUTPUT for CallId<80027> Elapsed Time = 64 ms.!>@>

Fri Jul 30 2021 13:29:29.540: UpdateObject <@<! StartCallId<80029>( ,

DST<EDOCSPPDEV2/ARUL> Timezone<UTC>,

"DEF_PROF",

Property Values, Count:3

"%OBJECT_IDENTIFIER" = <BSTR: "937">,

"%STATUS" = <BSTR: "%UNLOCK">,

"%TARGET_LIBRARY" = <BSTR: "EDOCSPPDEV2">

>)!>@>

UpdateObject <@<!Start OUTPUT For CallId<80029> ( Status<-2147221039 (0x800401D1)>)

End OUTPUT for CallId<80029> Elapsed Time = 15 ms.!>@>