LogicalDOC Community Wiki - User contributions [en]

RESTful Guide with curl

2025-10-30T07:59:45Z

Blucecio: /* Sample usage */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|The examples in this article may not work with your LogicalDOC; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result is:

<pre>
{
"folder":[
{
"attributes":[],
"creation":"2025-10-30 08:54:42 +0100",
"creator":"Dejah Thoris",
"description":"",
"hidden":0,
"id":2794107,
"lastModified":"2025-10-30 08:54:42 +0100",
"name":"alpha",
"parentId":4,
"position":1,
"securityRef":1069,
"templateId":null,
"templateLocked":0,
"type":0
},
{
"attributes":[],
"creation":"2025-10-30 08:54:49 +0100",
"creator":"Dejah Thoris",
"description":"",
"hidden":0,
"id":2794108,
"lastModified":"2025-10-30 08:54:49 +0100",
"name":"beta",
"parentId":4,
"position":1,
"securityRef":1069,
"templateId":null,
"templateLocked":0,
"type":0
}
]
}
</pre>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result in XML is:

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</syntaxhighlight>

This is a Java client for the same call:

<syntaxhighlight lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</syntaxhighlight>

== Folder ==
Let's create a new folder:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple
</syntaxhighlight>

Creates a path of folders starting from the folder with ID 4 (Default folder)
<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath
</syntaxhighlight>

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"
</syntaxhighlight>

Or also from a HTML form:

<syntaxhighlight lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</syntaxhighlight>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

<syntaxhighlight lang="bash">
$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"
</syntaxhighlight>

Upload: updates the content of an existing document generating a new version
<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update
</syntaxhighlight>

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

<syntaxhighlight lang="bash">
$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion
</syntaxhighlight>

=== Download ===

And now download it:

<syntaxhighlight lang="bash">
$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456
</syntaxhighlight>

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command
<syntaxhighlight lang="bash">
$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf
</syntaxhighlight>

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<syntaxhighlight lang="bash">
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</syntaxhighlight>

Download the converted .PDF file (latest version of the document)
<syntaxhighlight lang="bash">
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</syntaxhighlight>

=== Versioning ===
Checkout an existing document<br/>

<syntaxhighlight lang="bash">
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"
</syntaxhighlight>

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"
</syntaxhighlight>

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find
</syntaxhighlight>

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890"
</syntaxhighlight>

== Upload Resource ==

Uploads a resource of an existing document: thumbnail, tile, or preview.<br/>
The following example uploads the tile image (suffix: tile.png)

<syntaxhighlight lang="bash">
curl -X "POST" ^
"http://localhost:8080/services/rest/document/uploadResource" ^
-H "accept: */*" ^
-H "Authorization: Basic YWRtaW46YWRtaW4=" ^
-H "Content-Type: multipart/form-data" ^
-F "docId=10075" ^
-F "fileVersion=1.0" ^
-F "suffix=tile.png" ^
-F "content=@folder32.png;type=image/png"
</syntaxhighlight>

== Enterprise Methods ==
Additional search methods available in commercial versions of LogicalDOC

=== Enterprise Searches ===

This call will query the document table and count the documents in folder: /Default (folder ID = 4)

<syntaxhighlight lang="bash">
$ curl -X POST "http://localhost:8080/services/rest/enterpriseSearch/queryDocuments" \
-H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4=" -H "Content-Type: application/x-www-form-urlencoded" \
-d "select=COUNT(*)&where=DOC.ld_folderid%3D4&maxResults=2000000"
</syntaxhighlight>

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/9.1.1/index.html LogicalDOC REST API reference v9.1.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2025-08-22T13:14:54Z

Blucecio: /* Enterprise Searches */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|The examples in this article may not work with your LogicalDOC; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result is:

<pre>
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</pre>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result in XML is:

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</syntaxhighlight>

This is a Java client for the same call:

<syntaxhighlight lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</syntaxhighlight>

== Folder ==
Let's create a new folder:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple
</syntaxhighlight>

Creates a path of folders starting from the folder with ID 4 (Default folder)
<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath
</syntaxhighlight>

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"
</syntaxhighlight>

Or also from a HTML form:

<syntaxhighlight lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</syntaxhighlight>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

<syntaxhighlight lang="bash">
$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"
</syntaxhighlight>

Upload: updates the content of an existing document generating a new version
<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update
</syntaxhighlight>

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

<syntaxhighlight lang="bash">
$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion
</syntaxhighlight>

=== Download ===

And now download it:

<syntaxhighlight lang="bash">
$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456
</syntaxhighlight>

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command
<syntaxhighlight lang="bash">
$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf
</syntaxhighlight>

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<syntaxhighlight lang="bash">
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</syntaxhighlight>

Download the converted .PDF file (latest version of the document)
<syntaxhighlight lang="bash">
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</syntaxhighlight>

=== Versioning ===
Checkout an existing document<br/>

<syntaxhighlight lang="bash">
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"
</syntaxhighlight>

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"
</syntaxhighlight>

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find
</syntaxhighlight>

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890"
</syntaxhighlight>

== Upload Resource ==

Uploads a resource of an existing document: thumbnail, tile, or preview.<br/>
The following example uploads the tile image (suffix: tile.png)

<syntaxhighlight lang="bash">
curl -X "POST" ^
"http://localhost:8080/services/rest/document/uploadResource" ^
-H "accept: */*" ^
-H "Authorization: Basic YWRtaW46YWRtaW4=" ^
-H "Content-Type: multipart/form-data" ^
-F "docId=10075" ^
-F "fileVersion=1.0" ^
-F "suffix=tile.png" ^
-F "content=@folder32.png;type=image/png"
</syntaxhighlight>

== Enterprise Methods ==
Additional search methods available in commercial versions of LogicalDOC

=== Enterprise Searches ===

This call will query the document table and count the documents in folder: /Default (folder ID = 4)

<syntaxhighlight lang="bash">
$ curl -X POST "http://localhost:8080/services/rest/enterpriseSearch/queryDocuments" \
-H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4=" -H "Content-Type: application/x-www-form-urlencoded" \
-d "select=COUNT(*)&where=DOC.ld_folderid%3D4&maxResults=2000000"
</syntaxhighlight>

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/9.1.1/index.html LogicalDOC REST API reference v9.1.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2025-08-22T13:14:05Z

Blucecio: /* Enterprise Searches */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|The examples in this article may not work with your LogicalDOC; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result is:

<pre>
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</pre>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result in XML is:

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</syntaxhighlight>

This is a Java client for the same call:

<syntaxhighlight lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</syntaxhighlight>

== Folder ==
Let's create a new folder:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple
</syntaxhighlight>

Creates a path of folders starting from the folder with ID 4 (Default folder)
<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath
</syntaxhighlight>

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"
</syntaxhighlight>

Or also from a HTML form:

<syntaxhighlight lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</syntaxhighlight>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

<syntaxhighlight lang="bash">
$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"
</syntaxhighlight>

Upload: updates the content of an existing document generating a new version
<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update
</syntaxhighlight>

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

<syntaxhighlight lang="bash">
$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion
</syntaxhighlight>

=== Download ===

And now download it:

<syntaxhighlight lang="bash">
$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456
</syntaxhighlight>

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command
<syntaxhighlight lang="bash">
$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf
</syntaxhighlight>

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<syntaxhighlight lang="bash">
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</syntaxhighlight>

Download the converted .PDF file (latest version of the document)
<syntaxhighlight lang="bash">
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</syntaxhighlight>

=== Versioning ===
Checkout an existing document<br/>

<syntaxhighlight lang="bash">
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"
</syntaxhighlight>

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"
</syntaxhighlight>

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find
</syntaxhighlight>

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890"
</syntaxhighlight>

== Upload Resource ==

Uploads a resource of an existing document: thumbnail, tile, or preview.<br/>
The following example uploads the tile image (suffix: tile.png)

<syntaxhighlight lang="bash">
curl -X "POST" ^
"http://localhost:8080/services/rest/document/uploadResource" ^
-H "accept: */*" ^
-H "Authorization: Basic YWRtaW46YWRtaW4=" ^
-H "Content-Type: multipart/form-data" ^
-F "docId=10075" ^
-F "fileVersion=1.0" ^
-F "suffix=tile.png" ^
-F "content=@folder32.png;type=image/png"
</syntaxhighlight>

== Enterprise Methods ==
Additional search methods available in commercial versions of LogicalDOC

=== Enterprise Searches ===

This call will query the document table and count the documents in folder: /Default (folder ID = 4)

<syntaxhighlight lang="bash">
$ curl -X POST "http://localhost:8080/services/rest/enterpriseSearch/queryDocuments" \
-H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4=" -H "Content-Type: application/x-www-form-urlencoded" \
-d "select=COUNT(*)&where=DOC.ld_folderid%3D4&maxResults=2000000"
</syntaxhighlight>

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/9.1.1/index.html LogicalDOC REST API reference v9.1.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2025-08-22T13:13:26Z

Blucecio: Added enterpriseSearch example

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|The examples in this article may not work with your LogicalDOC; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result is:

<pre>
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</pre>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result in XML is:

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</syntaxhighlight>

This is a Java client for the same call:

<syntaxhighlight lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</syntaxhighlight>

== Folder ==
Let's create a new folder:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple
</syntaxhighlight>

Creates a path of folders starting from the folder with ID 4 (Default folder)
<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath
</syntaxhighlight>

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"
</syntaxhighlight>

Or also from a HTML form:

<syntaxhighlight lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</syntaxhighlight>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

<syntaxhighlight lang="bash">
$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"
</syntaxhighlight>

Upload: updates the content of an existing document generating a new version
<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update
</syntaxhighlight>

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

<syntaxhighlight lang="bash">
$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion
</syntaxhighlight>

=== Download ===

And now download it:

<syntaxhighlight lang="bash">
$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456
</syntaxhighlight>

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command
<syntaxhighlight lang="bash">
$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf
</syntaxhighlight>

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<syntaxhighlight lang="bash">
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</syntaxhighlight>

Download the converted .PDF file (latest version of the document)
<syntaxhighlight lang="bash">
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</syntaxhighlight>

=== Versioning ===
Checkout an existing document<br/>

<syntaxhighlight lang="bash">
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"
</syntaxhighlight>

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"
</syntaxhighlight>

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find
</syntaxhighlight>

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890"
</syntaxhighlight>

== Upload Resource ==

Uploads a resource of an existing document: thumbnail, tile, or preview.<br/>
The following example uploads the tile image (suffix: tile.png)

<syntaxhighlight lang="bash">
curl -X "POST" ^
"http://localhost:8080/services/rest/document/uploadResource" ^
-H "accept: */*" ^
-H "Authorization: Basic YWRtaW46YWRtaW4=" ^
-H "Content-Type: multipart/form-data" ^
-F "docId=10075" ^
-F "fileVersion=1.0" ^
-F "suffix=tile.png" ^
-F "content=@folder32.png;type=image/png"
</syntaxhighlight>

== Enterprise Methods ==
Additional search methods available in commercial versions of LogicalDOC

=== Enterprise Searches ===

This call will query the document table and count the documents in folder: /Default (folder ID = 4)

<syntaxhighlight lang="bash">
$ curl -X POST "http://localhost:8080/services/rest/enterpriseSearch/queryDocuments" \
-H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4=" -H "Content-Type: application/x-www-form-urlencoded" \
-d "select=COUNT(*)&where=DOC.ld_folderid%3D4&maxResults=2000000"
</syntaxhighlight>

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/9.1.1/index.html LogicalDOC REST API reference v9.1.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

Docker Migration

2025-08-18T13:15:36Z

Blucecio: added category

{{TOCright}} __TOC__

Sometimes you want to migrate your running Docker container to another more recent image(but same LogicalDOC's application version). This How-To describe a plan to migrate a LogicalDOC Docker installation to another container, please note that this activity is delicate and may lead to data loss.

{{Advice|This guide refers to a basic single-server deployment scenario. <b><u>Please be aware that this procedure is not covered by the standard support contract</u>.</b> <u>In case something goes wrong during the migration process, the support team cannot offer any help and LogicalDOC is not liable for any data loss</u>.<br/> In case you want this delicate matter to be handled professionally, please write to sales@logicaldoc.com for a quote.}}

== Assumptions ==
* Both the current container and the new one are the <b>same version</b>.
* Both the current container and the new one use the <b>same database engine</b>

== Definitions ==
* '''logicaldoc''': represents the name of the current container of the installation to migrate
* '''logicaldoc_new''': represents the name of the new container

== Step 1: Backup of the relevant files and folders from current container ==
* Extract the relevant files and folders with these commands:
$ docker cp logicaldoc:/LogicalDOC/conf conf
$ docker cp logicaldoc:/LogicalDOC/repository repository

== Step 2: Stop the current container ==
docker stop logicaldoc

== Step 3: Run the new container ==
<u>It is really important to install the same version of LogicalDOC as the old system and also provide the same database connection parameters and port mappings.</u>
* Assuming your release is the 8.9.3, this could be a sample command to run the new container:
$ docker run -d --name='''logicaldoc_new''' -p 8080:8080 --env LDOC_USERNO='''<YOUR_LICENSE_CODE>''' --env DB_ENGINE=mysql --env DB_HOST=logicaldoc-db --link logicaldoc-db logicaldoc/logicaldoc:'''8.9.3'''
* Wait the new contained to complete the installation, check you are able to log into LogicalDOC as user admin like you used to do in the old container.

== Step 4: Restore the relevant file in the new contanier ==
* Now, with the new container up and running, restore the files backed but from the old system
$ docker cp conf/. logicaldoc_new:/LogicalDOC/conf
$ docker cp repository/. logicaldoc_new:/LogicalDOC/repository

== Step 4: Rename the containers ==
* These instructions will rename the containers so that the new one will replace the old one
$ docker rename logicaldoc logicaldoc_old
$ docker rename logicaldoc_new logicaldoc

[[Category: Migration]]
[[Category: Docker]]

Main Page

2025-05-30T14:26:19Z

Blucecio:

<div style="border: 1px solid rgb(170, 170, 170); padding: 0.4em; background-color: rgb(238, 238, 238);">
<span style="font-size: 150%;">Welcome to the '''LogicalDOC'''<sup>™</sup> Wiki</span>
</div>

{| width="100%" cellspacing="10" align="center" class="logicaldoc_table"
|-
| width="33%" valign="top" class="logicaldoc_hubbox" | <div class="logicaldoc_hubtitle">'''Users'''</div> <div class="logicaldoc_boxcontents">
{| cellpadding="3" style="margin: 0pt;"
|-
| valign="top" | [[Image:80px-Crystal Clear app display.png]]<br>
|
*[http://docs.logicaldoc.com User Guides]
*[http://issues.logicaldoc.com Reporting bugs and feature requests]
*[http://forums.logicaldoc.com Community Forums]
*[[Translate LogicalDOC|Translate LogicalDOC]]
*[[CMIS|CMIS Interface]]
*[[WebDAV|WebDAV Interface]]
*[[LogicalDOC Joomla Explorer|LogicalDOC Joomla explorer]]
*[[LogicalDOC WordPress Explorer|LogicalDOC WordPress explorer]]
*[[Connect_Webex_Audio|Connect Webex Audio]]
*[[Release Notes|Release Notes]]
|}
</div>
| width="33%" valign="top" class="logicaldoc_hubbox" | <div class="logicaldoc_hubtitle">'''System Administrators'''</div> <div class="logicaldoc_boxcontents">
{| cellpadding="3" style="margin: 0pt;"
|-
| valign="top" | [[Image:80px-Crystal Clear app terminal.png]]<br>
|
*[[Quick Install]]
*[[Installation using MySQL database|Installation using MySQL]]
*[[Installation using Oracle|Installation using Oracle]]
*[[Docker|LogicalDOC Docker container]]
*[[Virtual Appliance|Virtual Appliance]]
*[[MySQL_Timezone|MySQL timezone issue]]
*[[SSL_Configuration_using_Certificate|SSL Configuration using Certificate]]
*[[SSL_Configuration_using_Java_Keystore|SSL Configuration using Java Keystore]]
*[[SwitchToJava11|Switch from Java8 to Java11 on Windows]]

*[[Switch_to_Java17_on_Windows|Switch from Java11 to Java17 on Windows]]
*[[Switch_to_Java17_on_Linux|Switch from Java11 to Java17 on Linux]]
*[[Switch_to_Java21_on_Windows|Switch from Java17 to Java21 on Windows]]
*[[Switch_to_Java21_on_Linux|Switch from Java17 to Java21 on Linux]]
*[[Tuning_Memory_Usage_On_Windows|Tuning memory usage on Windows]]
*[[Changing_Java_Virtual_Machine_On_Windows|Changing the Java Virtual Machine on Windows]]
*[[Java Options|Java Options]]
*[[Server Migration|How to migrate to a new server]]
*[[Docker Migration|How to migrate to a new docker container]]
*[[How to configure an Apache load balancer]]
*[[IndexConverter|How to prepare the Index for the next generation LogicalDOC 8.5]]
*[[Upgrade Tesseract OCR|Upgrade Tesseract OCR]]
*[[Upgrade Docker container|Recommended Update Procedure for Docker container]]
|}
</div>

| width="33%" valign="top" class="logicaldoc_hubbox" | <div class="logicaldoc_hubtitle">'''Developers'''</div> <div class="logicaldoc_boxcontents_small">
{| cellpadding="3" style="margin: 0pt;"
|-
| valign="top" | [[Image:80px-Crystal Clear app tutorials.png]]
|
*[[Web Services|Web Services API]]
*[[RESTful Guide with curl|RESTful Guide with curl]]
*[[Building from sources|Building from the Sources]]
*[[Developer Guide|Developer Guide]]
*[[Java_Options|Java Options]]
*[[Plug-in System|Plug-in System]]
*[[Blueprints|Blueprints]]
*[http://logicaldoc.sourceforge.net/site/ Maven2 generated Site]
*[[BPM: Workflowsystem|BPM Workflow System]]
*[[Architecture|Architecture]]
*[[Benchmark LogicalDOC|Benchmark]]
*[[External Authentication|External Authentication]]
*[[Store filenames with emoticons|Store filenames with emoticons]]
|}
</div>
|}

<br> '''LogicalDOC''' is a Web-based, open source document management software that is very simple to use and suitable for organizations of any size and type.<br>

LogicalDOC uses the best-of-breed Java technologies such as Spring, Hibernate and AJAX and can run on any system, from Windows to Linux or MAC OS X.

The features included in the community edition — including workflow light, version control and the full-text search engine - help manage the document lifecycle, encourage cooperation, allow to quickly find the document you need without wasting time.

The application is implemented as a plugin system that allows you to easily add new features through the ability to engage the various extension points predisposed. Moreover, the presence of Web services ensures that LogicalDOC can be easily integrated with other systems.

<br> LogicalDOC Community Edition is licensed under the [http://www.gnu.org/licenses/lgpl-3.0.html GNU LGPL version 3.0]

<br> LogicalDOC is available in several flavors:

*'''[https://www.logicaldoc.com/download-logicaldoc-community LogicalDOC Community Edition]:''' A free download, with access to the source code under the LGPLv3 open source license
*'''[https://www.logicaldoc.com/try LogicalDOC Enterprise Edition]:''' A full-featured and commercially supported edition of LogicalDOC

<br>
<div style="text-align: center;">
[https://www.logicaldoc.com/product/overview '''About LogicalDOC'''] | [https://www.logicaldoc.com/try '''Download Software'''] | [https://www.logicaldoc.com/support/professional-support '''Professional Support'''] | [http://docs.logicaldoc.com '''Documentation'''] <br>
</div>

Main Page

2025-05-30T13:14:20Z

Blucecio:

<div style="border: 1px solid rgb(170, 170, 170); padding: 0.4em; background-color: rgb(238, 238, 238);">
<span style="font-size: 150%;">Welcome to the '''LogicalDOC'''<sup>™</sup> Wiki</span>
</div>

{| width="100%" cellspacing="10" align="center"
|-
| width="33%" valign="top" class="logicaldoc_hubbox" | <div class="logicaldoc_hubtitle">'''Users'''</div> <div class="logicaldoc_boxcontents">
{| cellpadding="3" style="margin: 0pt;"
|-
| valign="top" | [[Image:80px-Crystal Clear app display.png]]<br>
|
*[http://docs.logicaldoc.com User Guides]
*[http://issues.logicaldoc.com Reporting bugs and feature requests]
*[http://forums.logicaldoc.com Community Forums]
*[[Translate LogicalDOC|Translate LogicalDOC]]
*[[CMIS|CMIS Interface]]
*[[WebDAV|WebDAV Interface]]
*[[LogicalDOC Joomla Explorer|LogicalDOC Joomla explorer]]
*[[LogicalDOC WordPress Explorer|LogicalDOC WordPress explorer]]
*[[Connect_Webex_Audio|Connect Webex Audio]]
*[[Release Notes|Release Notes]]
|}
</div>
| width="33%" valign="top" class="logicaldoc_hubbox" | <div class="logicaldoc_hubtitle">'''System Administrators'''</div> <div class="logicaldoc_boxcontents">
{| cellpadding="3" style="margin: 0pt;"
|-
| valign="top" | [[Image:80px-Crystal Clear app terminal.png]]<br>
|
*[[Quick Install]]
*[[Installation using MySQL database|Installation using MySQL]]
*[[Installation using Oracle|Installation using Oracle]]
*[[Docker|LogicalDOC Docker container]]
*[[Virtual Appliance|Virtual Appliance]]
*[[MySQL_Timezone|MySQL timezone issue]]
*[[SSL_Configuration_using_Certificate|SSL Configuration using Certificate]]
*[[SSL_Configuration_using_Java_Keystore|SSL Configuration using Java Keystore]]
*[[SwitchToJava11|Switch from Java8 to Java11 on Windows]]

*[[Switch_to_Java17_on_Windows|Switch from Java11 to Java17 on Windows]]
*[[Switch_to_Java17_on_Linux|Switch from Java11 to Java17 on Linux]]
*[[Switch_to_Java21_on_Windows|Switch from Java17 to Java21 on Windows]]
*[[Switch_to_Java21_on_Linux|Switch from Java17 to Java21 on Linux]]
*[[Tuning_Memory_Usage_On_Windows|Tuning memory usage on Windows]]
*[[Changing_Java_Virtual_Machine_On_Windows|Changing the Java Virtual Machine on Windows]]
*[[Java Options|Java Options]]
*[[Server Migration|How to migrate to a new server]]
*[[Docker Migration|How to migrate to a new docker container]]
*[[How to configure an Apache load balancer]]
*[[IndexConverter|How to prepare the Index for the next generation LogicalDOC 8.5]]
*[[Upgrade Tesseract OCR|Upgrade Tesseract OCR]]
*[[Upgrade Docker container|Recommended Update Procedure for Docker container]]
|}
</div>

| width="33%" valign="top" class="logicaldoc_hubbox" | <div class="logicaldoc_hubtitle">'''Developers'''</div> <div class="logicaldoc_boxcontents_small">
{| cellpadding="3" style="margin: 0pt;"
|-
| valign="top" | [[Image:80px-Crystal Clear app tutorials.png]]
|
*[[Web Services|Web Services API]]
*[[RESTful Guide with curl|RESTful Guide with curl]]
*[[Building from sources|Building from the Sources]]
*[[Developer Guide|Developer Guide]]
*[[Java_Options|Java Options]]
*[[Plug-in System|Plug-in System]]
*[[Blueprints|Blueprints]]
*[http://logicaldoc.sourceforge.net/site/ Maven2 generated Site]
*[[BPM: Workflowsystem|BPM Workflow System]]
*[[Architecture|Architecture]]
*[[Benchmark LogicalDOC|Benchmark]]
*[[External Authentication|External Authentication]]
*[[Store filenames with emoticons|Store filenames with emoticons]]
|}
</div>
|}

<br> '''LogicalDOC''' is a Web-based, open source document management software that is very simple to use and suitable for organizations of any size and type.<br>

LogicalDOC uses the best-of-breed Java technologies such as Spring, Hibernate and AJAX and can run on any system, from Windows to Linux or MAC OS X.

The features included in the community edition — including workflow light, version control and the full-text search engine - help manage the document lifecycle, encourage cooperation, allow to quickly find the document you need without wasting time.

The application is implemented as a plugin system that allows you to easily add new features through the ability to engage the various extension points predisposed. Moreover, the presence of Web services ensures that LogicalDOC can be easily integrated with other systems.

<br> LogicalDOC Community Edition is licensed under the [http://www.gnu.org/licenses/lgpl-3.0.html GNU LGPL version 3.0]

<br> LogicalDOC is available in several flavors:

*'''[https://www.logicaldoc.com/download-logicaldoc-community LogicalDOC Community Edition]:''' A free download, with access to the source code under the LGPLv3 open source license
*'''[https://www.logicaldoc.com/try LogicalDOC Enterprise Edition]:''' A full-featured and commercially supported edition of LogicalDOC

<br>
<div style="text-align: center;">
[https://www.logicaldoc.com/product/overview '''About LogicalDOC'''] | [https://www.logicaldoc.com/try '''Download Software'''] | [https://www.logicaldoc.com/support/professional-support '''Professional Support'''] | [http://docs.logicaldoc.com '''Documentation'''] <br>
</div>

RESTful Guide with curl

2025-05-30T09:58:56Z

Blucecio: /* Upload Resource */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result is:

<pre>
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</pre>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result in XML is:

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</syntaxhighlight>

This is a Java client for the same call:

<syntaxhighlight lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</syntaxhighlight>

== Folder ==
Let's create a new folder:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple
</syntaxhighlight>

Creates a path of folders starting from the folder with ID 4 (Default folder)
<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath
</syntaxhighlight>

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"
</syntaxhighlight>

Or also from a HTML form:

<syntaxhighlight lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</syntaxhighlight>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

<syntaxhighlight lang="bash">
$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"
</syntaxhighlight>

Upload: updates the content of an existing document generating a new version
<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update
</syntaxhighlight>

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

<syntaxhighlight lang="bash">
$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion
</syntaxhighlight>

=== Download ===

And now download it:

<syntaxhighlight lang="bash">
$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456
</syntaxhighlight>

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command
<syntaxhighlight lang="bash">
$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf
</syntaxhighlight>

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<syntaxhighlight lang="bash">
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</syntaxhighlight>

Download the converted .PDF file (latest version of the document)
<syntaxhighlight lang="bash">
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</syntaxhighlight>

=== Versioning ===
Checkout an existing document<br/>

<syntaxhighlight lang="bash">
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"
</syntaxhighlight>

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"
</syntaxhighlight>

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find
</syntaxhighlight>

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890"
</syntaxhighlight>

== Upload Resource ==

Uploads a resource of an existing document: thumbnail, tile, or preview.<br/>
The following example uploads the tile image (suffix: tile.png)

<syntaxhighlight lang="bash">
curl -X "POST" ^
"http://localhost:8080/services/rest/document/uploadResource" ^
-H "accept: */*" ^
-H "Authorization: Basic YWRtaW46YWRtaW4=" ^
-H "Content-Type: multipart/form-data" ^
-F "docId=10075" ^
-F "fileVersion=1.0" ^
-F "suffix=tile.png" ^
-F "content=@folder32.png;type=image/png"
</syntaxhighlight>

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/9.1.1/index.html LogicalDOC REST API reference v9.1.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2025-05-30T09:53:55Z

Blucecio: /* Convert a document to PDF */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result is:

<pre>
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</pre>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result in XML is:

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</syntaxhighlight>

This is a Java client for the same call:

<syntaxhighlight lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</syntaxhighlight>

== Folder ==
Let's create a new folder:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple
</syntaxhighlight>

Creates a path of folders starting from the folder with ID 4 (Default folder)
<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath
</syntaxhighlight>

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"
</syntaxhighlight>

Or also from a HTML form:

<syntaxhighlight lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</syntaxhighlight>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

<syntaxhighlight lang="bash">
$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"
</syntaxhighlight>

Upload: updates the content of an existing document generating a new version
<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update
</syntaxhighlight>

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

<syntaxhighlight lang="bash">
$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion
</syntaxhighlight>

=== Download ===

And now download it:

<syntaxhighlight lang="bash">
$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456
</syntaxhighlight>

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command
<syntaxhighlight lang="bash">
$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf
</syntaxhighlight>

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<syntaxhighlight lang="bash">
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</syntaxhighlight>

Download the converted .PDF file (latest version of the document)
<syntaxhighlight lang="bash">
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</syntaxhighlight>

=== Versioning ===
Checkout an existing document<br/>

<syntaxhighlight lang="bash">
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"
</syntaxhighlight>

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"
</syntaxhighlight>

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find
</syntaxhighlight>

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890"
</syntaxhighlight>

== Upload Resource ==

Uploads a resource of an existing document: thumbnail, tile, or preview.<br/>
The following example uploads the tile image (suffix: tile.png)

<pre>
curl -X "POST" ^
"http://localhost:8080/services/rest/document/uploadResource" ^
-H "accept: */*" ^
-H "Authorization: Basic YWRtaW46YWRtaW4=" ^
-H "Content-Type: multipart/form-data" ^
-F "docId=10075" ^
-F "fileVersion=1.0" ^
-F "suffix=tile.png" ^
-F "content=@folder32.png;type=image/png"
</pre>

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/9.1.1/index.html LogicalDOC REST API reference v9.1.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2025-05-30T09:53:04Z

Blucecio: /* Delete */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result is:

<pre>
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</pre>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result in XML is:

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</syntaxhighlight>

This is a Java client for the same call:

<syntaxhighlight lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</syntaxhighlight>

== Folder ==
Let's create a new folder:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple
</syntaxhighlight>

Creates a path of folders starting from the folder with ID 4 (Default folder)
<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath
</syntaxhighlight>

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"
</syntaxhighlight>

Or also from a HTML form:

<syntaxhighlight lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</syntaxhighlight>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

<syntaxhighlight lang="bash">
$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"
</syntaxhighlight>

Upload: updates the content of an existing document generating a new version
<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update
</syntaxhighlight>

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

<syntaxhighlight lang="bash">
$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion
</syntaxhighlight>

=== Download ===

And now download it:

<syntaxhighlight lang="bash">
$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456
</syntaxhighlight>

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command
<syntaxhighlight lang="bash">
$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf
</syntaxhighlight>

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>

<syntaxhighlight lang="bash">
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"
</syntaxhighlight>

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"
</syntaxhighlight>

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find
</syntaxhighlight>

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890"
</syntaxhighlight>

== Upload Resource ==

Uploads a resource of an existing document: thumbnail, tile, or preview.<br/>
The following example uploads the tile image (suffix: tile.png)

<pre>
curl -X "POST" ^
"http://localhost:8080/services/rest/document/uploadResource" ^
-H "accept: */*" ^
-H "Authorization: Basic YWRtaW46YWRtaW4=" ^
-H "Content-Type: multipart/form-data" ^
-F "docId=10075" ^
-F "fileVersion=1.0" ^
-F "suffix=tile.png" ^
-F "content=@folder32.png;type=image/png"
</pre>

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/9.1.1/index.html LogicalDOC REST API reference v9.1.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2025-05-30T09:51:12Z

Blucecio: /* Download */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result is:

<pre>
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</pre>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result in XML is:

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</syntaxhighlight>

This is a Java client for the same call:

<syntaxhighlight lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</syntaxhighlight>

== Folder ==
Let's create a new folder:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple
</syntaxhighlight>

Creates a path of folders starting from the folder with ID 4 (Default folder)
<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath
</syntaxhighlight>

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"
</syntaxhighlight>

Or also from a HTML form:

<syntaxhighlight lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</syntaxhighlight>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

<syntaxhighlight lang="bash">
$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"
</syntaxhighlight>

Upload: updates the content of an existing document generating a new version
<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update
</syntaxhighlight>

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

=== Download ===

And now download it:

<syntaxhighlight lang="bash">
$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456
</syntaxhighlight>

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command
<syntaxhighlight lang="bash">
$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf
</syntaxhighlight>

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>

<syntaxhighlight lang="bash">
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"
</syntaxhighlight>

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"
</syntaxhighlight>

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find
</syntaxhighlight>

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890"
</syntaxhighlight>

== Upload Resource ==

Uploads a resource of an existing document: thumbnail, tile, or preview.<br/>
The following example uploads the tile image (suffix: tile.png)

<pre>
curl -X "POST" ^
"http://localhost:8080/services/rest/document/uploadResource" ^
-H "accept: */*" ^
-H "Authorization: Basic YWRtaW46YWRtaW4=" ^
-H "Content-Type: multipart/form-data" ^
-F "docId=10075" ^
-F "fileVersion=1.0" ^
-F "suffix=tile.png" ^
-F "content=@folder32.png;type=image/png"
</pre>

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/9.1.1/index.html LogicalDOC REST API reference v9.1.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2025-05-30T09:50:41Z

Blucecio: /* Update metadata */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result is:

<pre>
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</pre>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result in XML is:

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</syntaxhighlight>

This is a Java client for the same call:

<syntaxhighlight lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</syntaxhighlight>

== Folder ==
Let's create a new folder:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple
</syntaxhighlight>

Creates a path of folders starting from the folder with ID 4 (Default folder)
<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath
</syntaxhighlight>

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"
</syntaxhighlight>

Or also from a HTML form:

<syntaxhighlight lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</syntaxhighlight>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

<syntaxhighlight lang="bash">
$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"
</syntaxhighlight>

Upload: updates the content of an existing document generating a new version
<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update
</syntaxhighlight>

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

=== Download ===

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>

<syntaxhighlight lang="bash">
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"
</syntaxhighlight>

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"
</syntaxhighlight>

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find
</syntaxhighlight>

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890"
</syntaxhighlight>

== Upload Resource ==

Uploads a resource of an existing document: thumbnail, tile, or preview.<br/>
The following example uploads the tile image (suffix: tile.png)

<pre>
curl -X "POST" ^
"http://localhost:8080/services/rest/document/uploadResource" ^
-H "accept: */*" ^
-H "Authorization: Basic YWRtaW46YWRtaW4=" ^
-H "Content-Type: multipart/form-data" ^
-F "docId=10075" ^
-F "fileVersion=1.0" ^
-F "suffix=tile.png" ^
-F "content=@folder32.png;type=image/png"
</pre>

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/9.1.1/index.html LogicalDOC REST API reference v9.1.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2025-05-30T09:50:18Z

Blucecio: /* Create via Upload */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result is:

<pre>
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</pre>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result in XML is:

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</syntaxhighlight>

This is a Java client for the same call:

<syntaxhighlight lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</syntaxhighlight>

== Folder ==
Let's create a new folder:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple
</syntaxhighlight>

Creates a path of folders starting from the folder with ID 4 (Default folder)
<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath
</syntaxhighlight>

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"
</syntaxhighlight>

Or also from a HTML form:

<syntaxhighlight lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</syntaxhighlight>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

<syntaxhighlight lang="bash">
$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"
</syntaxhighlight>

Upload: updates the content of an existing document generating a new version
<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

=== Download ===

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>

<syntaxhighlight lang="bash">
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"
</syntaxhighlight>

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"
</syntaxhighlight>

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find
</syntaxhighlight>

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890"
</syntaxhighlight>

== Upload Resource ==

Uploads a resource of an existing document: thumbnail, tile, or preview.<br/>
The following example uploads the tile image (suffix: tile.png)

<pre>
curl -X "POST" ^
"http://localhost:8080/services/rest/document/uploadResource" ^
-H "accept: */*" ^
-H "Authorization: Basic YWRtaW46YWRtaW4=" ^
-H "Content-Type: multipart/form-data" ^
-F "docId=10075" ^
-F "fileVersion=1.0" ^
-F "suffix=tile.png" ^
-F "content=@folder32.png;type=image/png"
</pre>

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/9.1.1/index.html LogicalDOC REST API reference v9.1.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2025-05-30T09:49:40Z

Blucecio: /* Versioning */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result is:

<pre>
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</pre>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result in XML is:

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</syntaxhighlight>

This is a Java client for the same call:

<syntaxhighlight lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</syntaxhighlight>

== Folder ==
Let's create a new folder:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple
</syntaxhighlight>

Creates a path of folders starting from the folder with ID 4 (Default folder)
<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath
</syntaxhighlight>

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"
</syntaxhighlight>

Or also from a HTML form:

<syntaxhighlight lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</syntaxhighlight>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

=== Download ===

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>

<syntaxhighlight lang="bash">
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"
</syntaxhighlight>

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"
</syntaxhighlight>

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find
</syntaxhighlight>

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890"
</syntaxhighlight>

== Upload Resource ==

Uploads a resource of an existing document: thumbnail, tile, or preview.<br/>
The following example uploads the tile image (suffix: tile.png)

<pre>
curl -X "POST" ^
"http://localhost:8080/services/rest/document/uploadResource" ^
-H "accept: */*" ^
-H "Authorization: Basic YWRtaW46YWRtaW4=" ^
-H "Content-Type: multipart/form-data" ^
-F "docId=10075" ^
-F "fileVersion=1.0" ^
-F "suffix=tile.png" ^
-F "content=@folder32.png;type=image/png"
</pre>

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/9.1.1/index.html LogicalDOC REST API reference v9.1.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2025-05-30T09:49:05Z

Blucecio: /* Search */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result is:

<pre>
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</pre>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result in XML is:

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</syntaxhighlight>

This is a Java client for the same call:

<syntaxhighlight lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</syntaxhighlight>

== Folder ==
Let's create a new folder:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple
</syntaxhighlight>

Creates a path of folders starting from the folder with ID 4 (Default folder)
<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath
</syntaxhighlight>

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"
</syntaxhighlight>

Or also from a HTML form:

<syntaxhighlight lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</syntaxhighlight>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

=== Download ===

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find
</syntaxhighlight>

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890"
</syntaxhighlight>

== Upload Resource ==

Uploads a resource of an existing document: thumbnail, tile, or preview.<br/>
The following example uploads the tile image (suffix: tile.png)

<pre>
curl -X "POST" ^
"http://localhost:8080/services/rest/document/uploadResource" ^
-H "accept: */*" ^
-H "Authorization: Basic YWRtaW46YWRtaW4=" ^
-H "Content-Type: multipart/form-data" ^
-F "docId=10075" ^
-F "fileVersion=1.0" ^
-F "suffix=tile.png" ^
-F "content=@folder32.png;type=image/png"
</pre>

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/9.1.1/index.html LogicalDOC REST API reference v9.1.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2025-05-30T09:48:35Z

Blucecio: /* Tags */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result is:

<pre>
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</pre>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result in XML is:

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</syntaxhighlight>

This is a Java client for the same call:

<syntaxhighlight lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</syntaxhighlight>

== Folder ==
Let's create a new folder:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple
</syntaxhighlight>

Creates a path of folders starting from the folder with ID 4 (Default folder)
<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath
</syntaxhighlight>

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"
</syntaxhighlight>

Or also from a HTML form:

<syntaxhighlight lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</syntaxhighlight>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

=== Download ===

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890"
</syntaxhighlight>

== Upload Resource ==

Uploads a resource of an existing document: thumbnail, tile, or preview.<br/>
The following example uploads the tile image (suffix: tile.png)

<pre>
curl -X "POST" ^
"http://localhost:8080/services/rest/document/uploadResource" ^
-H "accept: */*" ^
-H "Authorization: Basic YWRtaW46YWRtaW4=" ^
-H "Content-Type: multipart/form-data" ^
-F "docId=10075" ^
-F "fileVersion=1.0" ^
-F "suffix=tile.png" ^
-F "content=@folder32.png;type=image/png"
</pre>

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/9.1.1/index.html LogicalDOC REST API reference v9.1.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2025-05-30T09:47:56Z

Blucecio: /* Create a Document */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result is:

<pre>
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</pre>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result in XML is:

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</syntaxhighlight>

This is a Java client for the same call:

<syntaxhighlight lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</syntaxhighlight>

== Folder ==
Let's create a new folder:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple
</syntaxhighlight>

Creates a path of folders starting from the folder with ID 4 (Default folder)
<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath
</syntaxhighlight>

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload
</syntaxhighlight>

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

<syntaxhighlight lang="bash">
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"
</syntaxhighlight>

Or also from a HTML form:

<syntaxhighlight lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</syntaxhighlight>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

=== Download ===

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890"

== Upload Resource ==

Uploads a resource of an existing document: thumbnail, tile, or preview.<br/>
The following example uploads the tile image (suffix: tile.png)

<pre>
curl -X "POST" ^
"http://localhost:8080/services/rest/document/uploadResource" ^
-H "accept: */*" ^
-H "Authorization: Basic YWRtaW46YWRtaW4=" ^
-H "Content-Type: multipart/form-data" ^
-F "docId=10075" ^
-F "fileVersion=1.0" ^
-F "suffix=tile.png" ^
-F "content=@folder32.png;type=image/png"
</pre>

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/9.1.1/index.html LogicalDOC REST API reference v9.1.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2025-05-30T09:46:26Z

Blucecio: /* Sample usage */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result is:

<pre>
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</pre>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</syntaxhighlight>

The result in XML is:

<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</syntaxhighlight>

This is a Java client for the same call:

<syntaxhighlight lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</syntaxhighlight>

== Folder ==
Let's create a new folder:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple
</syntaxhighlight>

Creates a path of folders starting from the folder with ID 4 (Default folder)
<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath
</syntaxhighlight>

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"

Or also from a HTML form:

<source lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</source>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

=== Download ===

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890"

== Upload Resource ==

Uploads a resource of an existing document: thumbnail, tile, or preview.<br/>
The following example uploads the tile image (suffix: tile.png)

<pre>
curl -X "POST" ^
"http://localhost:8080/services/rest/document/uploadResource" ^
-H "accept: */*" ^
-H "Authorization: Basic YWRtaW46YWRtaW4=" ^
-H "Content-Type: multipart/form-data" ^
-F "docId=10075" ^
-F "fileVersion=1.0" ^
-F "suffix=tile.png" ^
-F "content=@folder32.png;type=image/png"
</pre>

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/9.1.1/index.html LogicalDOC REST API reference v9.1.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2025-05-30T09:45:10Z

Blucecio: /* Folder */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

<source lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</source>

The result is:

<pre>
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</pre>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

<source lang="bash">
$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</source>

The result in XML is:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</source>

This is a Java client for the same call:

<source lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</source>

== Folder ==
Let's create a new folder:

<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple
</syntaxhighlight>

Creates a path of folders starting from the folder with ID 4 (Default folder)
<syntaxhighlight lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath
</syntaxhighlight>

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"

Or also from a HTML form:

<source lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</source>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

=== Download ===

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890"

== Upload Resource ==

Uploads a resource of an existing document: thumbnail, tile, or preview.<br/>
The following example uploads the tile image (suffix: tile.png)

<pre>
curl -X "POST" ^
"http://localhost:8080/services/rest/document/uploadResource" ^
-H "accept: */*" ^
-H "Authorization: Basic YWRtaW46YWRtaW4=" ^
-H "Content-Type: multipart/form-data" ^
-F "docId=10075" ^
-F "fileVersion=1.0" ^
-F "suffix=tile.png" ^
-F "content=@folder32.png;type=image/png"
</pre>

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/9.1.1/index.html LogicalDOC REST API reference v9.1.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2025-05-30T09:44:00Z

Blucecio: /* Sample usage */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

<source lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</source>

The result is:

<pre>
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</pre>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

<source lang="bash">
$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</source>

The result in XML is:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</source>

This is a Java client for the same call:

<source lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</source>

== Folder ==
Let's create a new folder:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple

Creates a path of folders starting from the folder with ID 4 (Default folder)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"

Or also from a HTML form:

<source lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</source>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

=== Download ===

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890"

== Upload Resource ==

Uploads a resource of an existing document: thumbnail, tile, or preview.<br/>
The following example uploads the tile image (suffix: tile.png)

<pre>
curl -X "POST" ^
"http://localhost:8080/services/rest/document/uploadResource" ^
-H "accept: */*" ^
-H "Authorization: Basic YWRtaW46YWRtaW4=" ^
-H "Content-Type: multipart/form-data" ^
-F "docId=10075" ^
-F "fileVersion=1.0" ^
-F "suffix=tile.png" ^
-F "content=@folder32.png;type=image/png"
</pre>

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/9.1.1/index.html LogicalDOC REST API reference v9.1.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2025-05-30T09:43:14Z

Blucecio: /* Sample usage */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

<source lang="bash">
$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</source>

The result is:

<source lang="text">
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</source>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

<source lang="bash">
$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4
</source>

The result in XML is:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</source>

This is a Java client for the same call:

<source lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</source>

== Folder ==
Let's create a new folder:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple

Creates a path of folders starting from the folder with ID 4 (Default folder)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"

Or also from a HTML form:

<source lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</source>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

=== Download ===

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890"

== Upload Resource ==

Uploads a resource of an existing document: thumbnail, tile, or preview.<br/>
The following example uploads the tile image (suffix: tile.png)

<pre>
curl -X "POST" ^
"http://localhost:8080/services/rest/document/uploadResource" ^
-H "accept: */*" ^
-H "Authorization: Basic YWRtaW46YWRtaW4=" ^
-H "Content-Type: multipart/form-data" ^
-F "docId=10075" ^
-F "fileVersion=1.0" ^
-F "suffix=tile.png" ^
-F "content=@folder32.png;type=image/png"
</pre>

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/9.1.1/index.html LogicalDOC REST API reference v9.1.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2025-05-28T15:48:09Z

Blucecio: /* Upload Resource */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result is:

<source lang="text">
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</source>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result in XML is:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</source>

This is a Java client for the same call:

<source lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</source>

== Folder ==
Let's create a new folder:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple

Creates a path of folders starting from the folder with ID 4 (Default folder)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"

Or also from a HTML form:

<source lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</source>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

=== Download ===

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890"

== Upload Resource ==

Uploads a resource of an existing document: thumbnail, tile, or preview.<br/>
The following example uploads the tile image (suffix: tile.png)

<pre>
curl -X "POST" ^
"http://localhost:8080/services/rest/document/uploadResource" ^
-H "accept: */*" ^
-H "Authorization: Basic YWRtaW46YWRtaW4=" ^
-H "Content-Type: multipart/form-data" ^
-F "docId=10075" ^
-F "fileVersion=1.0" ^
-F "suffix=tile.png" ^
-F "content=@folder32.png;type=image/png"
</pre>

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/9.1.1/index.html LogicalDOC REST API reference v9.1.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2025-05-28T15:46:33Z

Blucecio: /* Upload Resource */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result is:

<source lang="text">
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</source>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result in XML is:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</source>

This is a Java client for the same call:

<source lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</source>

== Folder ==
Let's create a new folder:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple

Creates a path of folders starting from the folder with ID 4 (Default folder)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"

Or also from a HTML form:

<source lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</source>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

=== Download ===

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890"

== Upload Resource ==

Uploads a resource of an existing document: thumbnail, tile, or preview.<br/>
The following example uploads the tile image (suffix: tile.png)

<pre>
curl -X "POST" ^
"http://localhost:8080/services/rest/document/uploadResource" ^
-H "accept: */*" ^
-H "Authorization: Basic YWRtaW46YWRtaW4=" ^
-H "Content-Type: multipart/form-data" ^
-F "docId=10075" ^
-F "fileVersion=1" ^
-F "suffix=tile.png" ^
-F "content=@folder32.png;type=image/png"
</pre>

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/9.1.1/index.html LogicalDOC REST API reference v9.1.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2025-05-28T14:43:49Z

Blucecio: added refs

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result is:

<source lang="text">
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</source>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result in XML is:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</source>

This is a Java client for the same call:

<source lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</source>

== Folder ==
Let's create a new folder:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple

Creates a path of folders starting from the folder with ID 4 (Default folder)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"

Or also from a HTML form:

<source lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</source>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

=== Download ===

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890"

== Upload Resource ==

Uploads a resource of an existing document: thumbnail, tail, or preview.<br/>
The following example uploads the tail (suffix: tail.png)

<pre>
curl -X "POST" ^
"http://localhost:8080/services/rest/document/uploadResource" ^
-H "accept: */*" ^
-H "Authorization: Basic YWRtaW46YWRtaW4=" ^
-H "Content-Type: multipart/form-data" ^
-F "docId=10075" ^
-F "fileVersion=1" ^
-F "suffix=tile.png" ^
-F "content=@folder32.png;type=image/png"
</pre>

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/9.1.1/index.html LogicalDOC REST API reference v9.1.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2025-05-28T14:42:16Z

Blucecio: Added Upload Resource example

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result is:

<source lang="text">
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</source>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result in XML is:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</source>

This is a Java client for the same call:

<source lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</source>

== Folder ==
Let's create a new folder:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple

Creates a path of folders starting from the folder with ID 4 (Default folder)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"

Or also from a HTML form:

<source lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</source>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

=== Download ===

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890"

== Upload Resource ==

Uploads a resource of an existing document: thumbnail, tail, or preview.<br/>
The following example uploads the tail (suffix: tail.png)

<pre>
curl -X "POST" ^
"http://localhost:8080/services/rest/document/uploadResource" ^
-H "accept: */*" ^
-H "Authorization: Basic YWRtaW46YWRtaW4=" ^
-H "Content-Type: multipart/form-data" ^
-F "docId=10075" ^
-F "fileVersion=1" ^
-F "suffix=tile.png" ^
-F "content=@folder32.png;type=image/png"
</pre>

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

Bindings And Samples

2025-05-07T16:04:39Z

Blucecio: /* Python */

== JAVA Examples ==

On SourceForge we have released an example project that Tests the WS features of LD and simultaneously shows the WS invocations with JAVA<br>

{| cellspacing="1" cellpadding="1" border="1" style="width: 407px; height: 117px;"
|-
| align="center" | '''LogicalDOC version'''
| align="center" | '''Sample'''
|-
| 9.0
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-9.0/logicaldoc-webservicesamples-9.0.zip/download logicaldoc-webservicesamples-9.0.zip]
|-
| 8.3.4
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.3/logicaldoc-webservicesamples-8.3.4.zip/download logicaldoc-webservicesamples-8.3.4.zip]
|-
| 8.3
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-8.3/Java-webserviceTests-8.3.zip/download Java-webserviceTests-8.3.zip]
|-
| 8.0.0
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-8.0/Java-webserviceTests-8.0.0.zip/download Java-webserviceTests-8.0.0.zip]
|-
| 7.6.3
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-7.6/webserviceTests-Java.zip/download webserviceTests-Java.zip]
|-
| 7.5.2
| [https://sourceforge.net/projects/logicaldoc/files/samples/samples-7.5/Java-webserviceTests-7.5.2.zip/download Java-webserviceTests-7.5.2.zip]
|-
| 7.4.0
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.4/Java-webserviceTests-7.4.zip/download Java-webserviceTests-7.4.zip]
|-
| 7.1.0
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.1/Java-webserviceTests-7.1.0.zip/download Java-webserviceTests-7.1.0.zip]
|-
| 6.8.0
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.8/Java-webserviceTests-6.8.0.zip/download Java-WebServicesTests-6.8.0.zip]
|-
| 6.7.1
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.7/Java-webserviceTests-6.7.1.zip/download Java-WebServicesTests-6.7.1.zip]
|-
| 6.6.2
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.6/Java-WebServicesTests-6.6.2.zip/download Java-WebServicesTests-6.6.2.zip]
|-
| 6.5.1
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.5/Java-WebServicesTests-6.5.1.zip/download Java-WebServicesTests-6.5.1.zip]
|-
| 6.4
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.4/Java-WebServicesTests-6.4.zip/download Java-WebServicesTests-6.4.zip]
|-
| 6.2
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.2/Java-WebServicesTests-6.2.zip/download Java-WebServicesTests-6.2.zip]
|-
| 6.0
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.0/Java-webserviceTests-6.0.zip/download Java-WebServicesTests-6.0.zip]
|-
| 5.0/5.1
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-5.1/Java-webserviceTests-5.1.zip/download Java-WebServicesTests-5.1.zip]
|}

== .NET Integration ==

This is a sample Visual Studio 2008/2010 project created to illustrate some C# .NET 4.0/2.0 invocations of the LogicalDOC web-services<br>

{| cellspacing="1" cellpadding="1" border="1" style="width: 508px; height: 102px;"
|-
| align="center" | '''LD version'''
| align="center" | '''Sample package'''
| align="center" | '''Visual Studio'''
| align="center" | '''Notes'''
|-
| 8.7.1
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.7/dotNET2WSClient4-8.7.1.zip/download dotNET2WSClient4-8.7.1.zip]
| VS 2017
|
|-
| 8.3
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.3/dotNET2WSClient4-8.3.zip/download dotNET2WSClient4-8.3.zip]
| VS 2013
| Includes an example of creating AttributeSets and Templates
|-
| 8.2.1
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.2/dotNET2WSClient4-8.2.1.zip/download dotNET2WSClient4-8.2.1.zip]
| VS 2013
| Complete example of full-text search with custom attributes
|-
| 8.1.1
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.1/dotNET2WSClient4-8.1.1.zip/download dotNET2WSClient4-8.1.1.zip]
| VS 2013
| Full-text search with search in sub-folder
|-
| 7.7.3
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.7/dotNET2WSClient4-7.7.3.zip/download dotNET2WSClient4-7.7.3.zip]
| VS 2013
| (.NET 4.0) Upload document REST example
|-
| 7.5
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.5/dotNET4_WSClient-7.5.zip/download dotNET4_WSClient-7.5.zip]
| VS 2013
| (.NET 4.0) Upload document REST example
|-
| 7.1
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.1/dotNET-WSExamples-7.1.zip/download dotNET-WSExamples-7.1.zip]
| VS 2010
|-
| 6.8.4
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.8/dotNET2WSClient-6.8.4.zip/download dotNET2WSClient-6.8.4.zip]
| VS 2010
|-
| 6.7.1
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.7/dotNET2WSClient-6.7.1.zip/download dotNET2WSClient-6.7.1.zip]
| VS 2010
|-
| 6.6.2
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.6/dotNET-WSClient-6.6.2.zip/download dotNET-WSClient-6.6.2.zip]
| Visual Studio 2010 project
|-
| 6.5.2
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.5/dotNET-WSClient-6.5.2.zip/download dotNET-WSClient-6.5.2.zip]<br>
|-
| 6.4
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.4/dotNET-webservice-client-6.4.zip/download dotNET-webservice-client-6.4.zip]<br>
|-
| 6.0
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.0/dotNET2WSClient-6.0.zip/download dotNET2WSClient-6.0.zip]<br>
|-
| 5.2.1
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-5.2/dotNET2WSClient-5.2.1.zip/download dotNET2WSClient-5.2.1.zip]<br>
|-
| 5.0
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-5.0/dotNET2WSClient-5.0.zip/download dotNET2WSClient-5.0.zip]<br>
|}

== PHP Integration ==

The Web-Services of LogicalDOC are compatibles with PHP 8.2 <br>
The example package contains scripts for invoking the LogicalDOC API via SOAP and REST webservice.<br>
As always you can download it from SourceForge.<br>

{| cellspacing="1" cellpadding="1" border="1" style="width: 100%; height: 79px;"
|-
| align="center" | '''LogicalDOC version'''
| '''PHP version'''
| align="center" | '''Download Url'''
| '''Notes'''
|-
| 8.8.6<br>
|8.2
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-8.8/PHP-logicaldoc-webservices-886.zip/download PHP-logicaldoc-webservices-886]
| Changes: fixed document creation via SOAP with LD 8.3 and higher
|-
| 8.7.3<br>
|7.4
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.7/PHP-SOAP_webservice-873.zip/download PHP-SOAP_webservice-873.zip]
| Changes: Chunk upload for large files
|-
| 8.4.2<br>
|7.2
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.4/PHP-SOAP_webservice-842.zip/download PHP-SOAP_webservice-842.zip]
| Changes: REST methods invocations
|-
| 8.2.1<br>
|7.2
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.2/PHP-SOAP_webservice-8.2.1.zip/download PHP-SOAP_webservice-8.2.1.zip]
|-
| 8.1.1<br>
|7.0
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.1/PHP-SOAP_webservice-8.1.1.zip/download PHP-SOAP_webservice-8.1.1.zip]
| Changes: updated example for recursive download
|-
| 8.0<br>
|7.0
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.0/PHP-SOAP_webservice-8.0.zip/download PHP-SOAP_webservice-8.0.zip]
|-
| 7.7<br>
|5.4.43
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.7/PHP-SOAP_webservice-77.zip/download PHP-SOAP_webservice-77.zip]
| Changes: Removed field title in WSDocument
|-
| 7.5/7.5.1<br>
|5.4.43
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.5/PHP-SOAP_webservice-7.5.zip/download PHP-SOAP_webservice-7.5.zip]
| Changes: Important changes in WSDocument fields (attributes), new REST examples
|-
| 7.4<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.4/PHP-SOAP_webservice-7.4-R02.zip/download PHP-SOAP_webservice-7.4-R02.zip]
| Changes: Some changes in the WSDocument and WSFolder fields, new REST examples, new samples of Enterprise Search (parametric search)
|-
| 7.2<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.2/PHP-SOAP_webservice-7.2.zip/download PHP-SOAP_webservice-7.2.zip]
| Changes: Creating a folder from template with related metadata
|-
| 7.0.0<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.0/PHP-SOAP_webservice-7.0.zip/download PHP-SOAP_webservice-7.0.zip]
| Changes: updated Search fullText examples, new Enterprise parametric search, Document download alias, Document download REST (big files), mini application in PHP, shows the latest document created/updated
|-
| 6.8.4<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%206.8/PHP-SOAP_webservice-6.8.4.zip/download PHP-SOAP_webservice-6.8.4.zip]
| Changes: search by parameters (EnterpriseSearch), full-text search on template fields, getTemplate by name (DocumentMeta)
|-
| 6.8.3<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%206.8/PHP-SOAP_webservice-6.8.3.zip/download PHP-SOAP_webservice-6.8.3.zip]
| Changes: new mini application in PHP, performs the research and presents a list of results for download
|-
| 6.8.1<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.8/PHP-SOAP_webservice-6.8.1.zip/download PHP-SOAP_webservice-6.8.1.zip]
|
|-
| 6.7.1<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.7/PHP-SOAP_webservice-6.7.1.zip/download PHP-SOAP_webservice-6.7.1.zip]
| Changes in: Search_parametric.php and Folder_workspaces.php
|-
| 6.6.2<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.6/PHP-SOAP_webservice-6.6.2.zip/download PHP-SOAP_webservice-6.6.2.zip]
| New examples: Search_parametric.php and Document_createBinaryWithTemplate.php
|-
| 6.5.2<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.5/PHP-SOAP_webservice-6.5.2.zip/download PHP-SOAP_webservice-6.5.2.zip]
|
|-
| 6.5.1<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.5/PHP-SOAP_webservice-6.5.1.zip/download PHP-SOAP_webservice-6.5.1.zip]
|
|-
| 6.4<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.4/PHP-SOAP_webservice-6.4.zip/download PHP-SOAP_webservice-6.4.zip]<br>
| Of particular interest is the new example Folder_downloadRecursively.php that lets you perform full backup of the repository starting from a given folder
|-
| 6.0<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.0/PHP-SOAP_webservice-6.0.zip/download PHP-SOAP_webservice-6.0.zip]<br>
|-
| 5.0/5.1<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-5.1/PHP-SOAP_webservice-5.1.zip/download PHP-SOAP_webservice-5.1.zip]
|}

== Python ==
A set of examples in Python to use the new REST APIs available from LogicalDOC since version 7.5<br/>
3.11.4 is the version of Python that we used to create and test the latest scripts.<br/>
These can be run from the command line on Windows: python <SCRIPT_FILENAME><br/>
Be aware that you might have to change the address and port of your LogicalDOC or the login credentials.<br/>
<br>
{| cellspacing="1" cellpadding="1" border="1" style="width: 100%; height: 79px;"
|-
| align="center" | '''LD version'''
| align="center" | '''Download Url'''
| '''Notes'''
|-
| 9.1.1<br>
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-9.1/Python-logicaldoc-webservices-911.zip/download Python-logicaldoc-webservices-911.zip]
| Added call examples with API-KEY<br/>New example Copying document and resources from source LogicalDOC A to target LogicalDOC B
|-
| 8.9.1<br>
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-8.9/Python-logicaldoc-webservices-891.zip/download Python-logicaldoc-webservices-891.zip]
| Added Reading Request SOAP and REST examples<br/>Added listUsers and StoreUser SOAP examples
|-
| 8.7.4<br>
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-8.7/Python-samples-8.7.4.zip/download Python-samples-8.7.4.zip]
| Added Enterprise Search REST examples
|-
| 8.7.3<br>
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.7/Python-samples-873.zip/download Python-samples-873.zip]
| Interactive Documentation about the RESTful APIs is available at [http://docs.logicaldoc.com/en/web-services-api http://docs.logicaldoc.com/en/web-services-api]
|-
| 8.4.2<br>
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.4/Python-samples-842.zip/download Python-samples-842.zip]
| Interactive Documentation about the RESTful APIs is available at [http://docs.logicaldoc.com/en/web-services-api http://docs.logicaldoc.com/en/web-services-api]
|-
| 7.7<br>
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.7/Python-samples-77.zip/download Python-samples-77.zip]
| Interactive Documentation about the RESTful APIs is available at [http://docs.logicaldoc.com/en/web-services-api http://docs.logicaldoc.com/en/web-services-api]
|-
| 7.5/7.5.1<br>
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.5/Python-samples-751.zip/download Python-samples-751.zip]
| Interactive Documentation about the RESTful APIs is available at [http://wiki.logicaldoc.com/rest/ http://wiki.logicaldoc.com/rest/]
|}

Bindings And Samples

2025-05-07T16:03:54Z

Blucecio: /* Python */

== JAVA Examples ==

On SourceForge we have released an example project that Tests the WS features of LD and simultaneously shows the WS invocations with JAVA<br>

{| cellspacing="1" cellpadding="1" border="1" style="width: 407px; height: 117px;"
|-
| align="center" | '''LogicalDOC version'''
| align="center" | '''Sample'''
|-
| 9.0
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-9.0/logicaldoc-webservicesamples-9.0.zip/download logicaldoc-webservicesamples-9.0.zip]
|-
| 8.3.4
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.3/logicaldoc-webservicesamples-8.3.4.zip/download logicaldoc-webservicesamples-8.3.4.zip]
|-
| 8.3
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-8.3/Java-webserviceTests-8.3.zip/download Java-webserviceTests-8.3.zip]
|-
| 8.0.0
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-8.0/Java-webserviceTests-8.0.0.zip/download Java-webserviceTests-8.0.0.zip]
|-
| 7.6.3
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-7.6/webserviceTests-Java.zip/download webserviceTests-Java.zip]
|-
| 7.5.2
| [https://sourceforge.net/projects/logicaldoc/files/samples/samples-7.5/Java-webserviceTests-7.5.2.zip/download Java-webserviceTests-7.5.2.zip]
|-
| 7.4.0
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.4/Java-webserviceTests-7.4.zip/download Java-webserviceTests-7.4.zip]
|-
| 7.1.0
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.1/Java-webserviceTests-7.1.0.zip/download Java-webserviceTests-7.1.0.zip]
|-
| 6.8.0
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.8/Java-webserviceTests-6.8.0.zip/download Java-WebServicesTests-6.8.0.zip]
|-
| 6.7.1
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.7/Java-webserviceTests-6.7.1.zip/download Java-WebServicesTests-6.7.1.zip]
|-
| 6.6.2
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.6/Java-WebServicesTests-6.6.2.zip/download Java-WebServicesTests-6.6.2.zip]
|-
| 6.5.1
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.5/Java-WebServicesTests-6.5.1.zip/download Java-WebServicesTests-6.5.1.zip]
|-
| 6.4
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.4/Java-WebServicesTests-6.4.zip/download Java-WebServicesTests-6.4.zip]
|-
| 6.2
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.2/Java-WebServicesTests-6.2.zip/download Java-WebServicesTests-6.2.zip]
|-
| 6.0
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.0/Java-webserviceTests-6.0.zip/download Java-WebServicesTests-6.0.zip]
|-
| 5.0/5.1
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-5.1/Java-webserviceTests-5.1.zip/download Java-WebServicesTests-5.1.zip]
|}

== .NET Integration ==

This is a sample Visual Studio 2008/2010 project created to illustrate some C# .NET 4.0/2.0 invocations of the LogicalDOC web-services<br>

{| cellspacing="1" cellpadding="1" border="1" style="width: 508px; height: 102px;"
|-
| align="center" | '''LD version'''
| align="center" | '''Sample package'''
| align="center" | '''Visual Studio'''
| align="center" | '''Notes'''
|-
| 8.7.1
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.7/dotNET2WSClient4-8.7.1.zip/download dotNET2WSClient4-8.7.1.zip]
| VS 2017
|
|-
| 8.3
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.3/dotNET2WSClient4-8.3.zip/download dotNET2WSClient4-8.3.zip]
| VS 2013
| Includes an example of creating AttributeSets and Templates
|-
| 8.2.1
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.2/dotNET2WSClient4-8.2.1.zip/download dotNET2WSClient4-8.2.1.zip]
| VS 2013
| Complete example of full-text search with custom attributes
|-
| 8.1.1
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.1/dotNET2WSClient4-8.1.1.zip/download dotNET2WSClient4-8.1.1.zip]
| VS 2013
| Full-text search with search in sub-folder
|-
| 7.7.3
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.7/dotNET2WSClient4-7.7.3.zip/download dotNET2WSClient4-7.7.3.zip]
| VS 2013
| (.NET 4.0) Upload document REST example
|-
| 7.5
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.5/dotNET4_WSClient-7.5.zip/download dotNET4_WSClient-7.5.zip]
| VS 2013
| (.NET 4.0) Upload document REST example
|-
| 7.1
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.1/dotNET-WSExamples-7.1.zip/download dotNET-WSExamples-7.1.zip]
| VS 2010
|-
| 6.8.4
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.8/dotNET2WSClient-6.8.4.zip/download dotNET2WSClient-6.8.4.zip]
| VS 2010
|-
| 6.7.1
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.7/dotNET2WSClient-6.7.1.zip/download dotNET2WSClient-6.7.1.zip]
| VS 2010
|-
| 6.6.2
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.6/dotNET-WSClient-6.6.2.zip/download dotNET-WSClient-6.6.2.zip]
| Visual Studio 2010 project
|-
| 6.5.2
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.5/dotNET-WSClient-6.5.2.zip/download dotNET-WSClient-6.5.2.zip]<br>
|-
| 6.4
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.4/dotNET-webservice-client-6.4.zip/download dotNET-webservice-client-6.4.zip]<br>
|-
| 6.0
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.0/dotNET2WSClient-6.0.zip/download dotNET2WSClient-6.0.zip]<br>
|-
| 5.2.1
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-5.2/dotNET2WSClient-5.2.1.zip/download dotNET2WSClient-5.2.1.zip]<br>
|-
| 5.0
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-5.0/dotNET2WSClient-5.0.zip/download dotNET2WSClient-5.0.zip]<br>
|}

== PHP Integration ==

The Web-Services of LogicalDOC are compatibles with PHP 8.2 <br>
The example package contains scripts for invoking the LogicalDOC API via SOAP and REST webservice.<br>
As always you can download it from SourceForge.<br>

{| cellspacing="1" cellpadding="1" border="1" style="width: 100%; height: 79px;"
|-
| align="center" | '''LogicalDOC version'''
| '''PHP version'''
| align="center" | '''Download Url'''
| '''Notes'''
|-
| 8.8.6<br>
|8.2
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-8.8/PHP-logicaldoc-webservices-886.zip/download PHP-logicaldoc-webservices-886]
| Changes: fixed document creation via SOAP with LD 8.3 and higher
|-
| 8.7.3<br>
|7.4
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.7/PHP-SOAP_webservice-873.zip/download PHP-SOAP_webservice-873.zip]
| Changes: Chunk upload for large files
|-
| 8.4.2<br>
|7.2
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.4/PHP-SOAP_webservice-842.zip/download PHP-SOAP_webservice-842.zip]
| Changes: REST methods invocations
|-
| 8.2.1<br>
|7.2
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.2/PHP-SOAP_webservice-8.2.1.zip/download PHP-SOAP_webservice-8.2.1.zip]
|-
| 8.1.1<br>
|7.0
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.1/PHP-SOAP_webservice-8.1.1.zip/download PHP-SOAP_webservice-8.1.1.zip]
| Changes: updated example for recursive download
|-
| 8.0<br>
|7.0
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.0/PHP-SOAP_webservice-8.0.zip/download PHP-SOAP_webservice-8.0.zip]
|-
| 7.7<br>
|5.4.43
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.7/PHP-SOAP_webservice-77.zip/download PHP-SOAP_webservice-77.zip]
| Changes: Removed field title in WSDocument
|-
| 7.5/7.5.1<br>
|5.4.43
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.5/PHP-SOAP_webservice-7.5.zip/download PHP-SOAP_webservice-7.5.zip]
| Changes: Important changes in WSDocument fields (attributes), new REST examples
|-
| 7.4<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.4/PHP-SOAP_webservice-7.4-R02.zip/download PHP-SOAP_webservice-7.4-R02.zip]
| Changes: Some changes in the WSDocument and WSFolder fields, new REST examples, new samples of Enterprise Search (parametric search)
|-
| 7.2<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.2/PHP-SOAP_webservice-7.2.zip/download PHP-SOAP_webservice-7.2.zip]
| Changes: Creating a folder from template with related metadata
|-
| 7.0.0<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.0/PHP-SOAP_webservice-7.0.zip/download PHP-SOAP_webservice-7.0.zip]
| Changes: updated Search fullText examples, new Enterprise parametric search, Document download alias, Document download REST (big files), mini application in PHP, shows the latest document created/updated
|-
| 6.8.4<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%206.8/PHP-SOAP_webservice-6.8.4.zip/download PHP-SOAP_webservice-6.8.4.zip]
| Changes: search by parameters (EnterpriseSearch), full-text search on template fields, getTemplate by name (DocumentMeta)
|-
| 6.8.3<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%206.8/PHP-SOAP_webservice-6.8.3.zip/download PHP-SOAP_webservice-6.8.3.zip]
| Changes: new mini application in PHP, performs the research and presents a list of results for download
|-
| 6.8.1<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.8/PHP-SOAP_webservice-6.8.1.zip/download PHP-SOAP_webservice-6.8.1.zip]
|
|-
| 6.7.1<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.7/PHP-SOAP_webservice-6.7.1.zip/download PHP-SOAP_webservice-6.7.1.zip]
| Changes in: Search_parametric.php and Folder_workspaces.php
|-
| 6.6.2<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.6/PHP-SOAP_webservice-6.6.2.zip/download PHP-SOAP_webservice-6.6.2.zip]
| New examples: Search_parametric.php and Document_createBinaryWithTemplate.php
|-
| 6.5.2<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.5/PHP-SOAP_webservice-6.5.2.zip/download PHP-SOAP_webservice-6.5.2.zip]
|
|-
| 6.5.1<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.5/PHP-SOAP_webservice-6.5.1.zip/download PHP-SOAP_webservice-6.5.1.zip]
|
|-
| 6.4<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.4/PHP-SOAP_webservice-6.4.zip/download PHP-SOAP_webservice-6.4.zip]<br>
| Of particular interest is the new example Folder_downloadRecursively.php that lets you perform full backup of the repository starting from a given folder
|-
| 6.0<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.0/PHP-SOAP_webservice-6.0.zip/download PHP-SOAP_webservice-6.0.zip]<br>
|-
| 5.0/5.1<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-5.1/PHP-SOAP_webservice-5.1.zip/download PHP-SOAP_webservice-5.1.zip]
|}

== Python ==
A set of examples in Python to use the new REST APIs available from LogicalDOC since version 7.5<br/>
3.11.4 is the version of Python that we used to create and test the latest scripts.<br/>
These can be run from the command line on Windows: python <SCRIPT_FILENAME><br/>
Be aware that you might have to change the address and port of your LogicalDOC or the login credentials.<br/>
<br>
{| cellspacing="1" cellpadding="1" border="1" style="width: 100%; height: 79px;"
|-
| align="center" | '''LD version'''
| align="center" | '''Download Url'''
| '''Notes'''
|-
| 9.1.1<br>
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-9.1/Python-logicaldoc-webservices-911.zip/download Python-logicaldoc-webservices-911.zip]
| Added examples of invocation with API-KEY<br/>New example Copying document and resources from source LogicalDOC A to target LogicalDOC B
|-
| 8.9.1<br>
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-8.9/Python-logicaldoc-webservices-891.zip/download Python-logicaldoc-webservices-891.zip]
| Added Reading Request SOAP and REST examples<br/>Added listUsers and StoreUser SOAP examples
|-
| 8.7.4<br>
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-8.7/Python-samples-8.7.4.zip/download Python-samples-8.7.4.zip]
| Added Enterprise Search REST examples
|-
| 8.7.3<br>
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.7/Python-samples-873.zip/download Python-samples-873.zip]
| Interactive Documentation about the RESTful APIs is available at [http://docs.logicaldoc.com/en/web-services-api http://docs.logicaldoc.com/en/web-services-api]
|-
| 8.4.2<br>
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.4/Python-samples-842.zip/download Python-samples-842.zip]
| Interactive Documentation about the RESTful APIs is available at [http://docs.logicaldoc.com/en/web-services-api http://docs.logicaldoc.com/en/web-services-api]
|-
| 7.7<br>
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.7/Python-samples-77.zip/download Python-samples-77.zip]
| Interactive Documentation about the RESTful APIs is available at [http://docs.logicaldoc.com/en/web-services-api http://docs.logicaldoc.com/en/web-services-api]
|-
| 7.5/7.5.1<br>
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.5/Python-samples-751.zip/download Python-samples-751.zip]
| Interactive Documentation about the RESTful APIs is available at [http://wiki.logicaldoc.com/rest/ http://wiki.logicaldoc.com/rest/]
|}

Docker

2024-08-29T09:05:39Z

Blucecio: /* Running LogicalDOC Enterprise in a Docker container with connection to a MS SQL Server database */

== Running LogicalDOC Enterprise in a Docker container with connection to a Oracle database ==
Running Oracle Database Server 12c R2 in a Docker container<br>
This is an official image released by Oracle of Oracle Database Server 12.2.0.1 Enterprise Edition running on Oracle Linux 7 <br>
In Docker Hub: [https://hub.docker.com/_/oracle-database-enterprise-edition Oracle Database Enterprise Edition]
<pre>
docker login
docker pull store/oracle/database-enterprise:12.2.0.1-slim
docker run -it --name Oracle12-slim -p 1521:1521 store/oracle/database-enterprise:12.2.0.1-slim
</pre>

Note as of 19/02/2019 (19 February 2019) when you connect using the proposed credentials you receive error ORA-28009, so you need to set a database static parameter on the Oracle container using SQL*Plus<br>
// How to solve Oracle exception<br>
//ORA-28009: connection as SYS should be as SYSDBA or SYSOPER<br>
[https://outofmymemory.wordpress.com/2013/09/24/ora-28009-connection-as-sys-should-be-as-sysdba-or-sysoper/ ORA-28009: connection as SYS should be as SYSDBA or SYSOPER]
<pre>
docker exec -it Oracle12-slim bash -c "source /home/oracle/.bashrc; sqlplus /nolog"

conn / as sysdba
SHOW PARAMETER O7_DICTIONARY_ACCESSIBILITY NAME TYPE VALUE;
ALTER SYSTEM SET O7_DICTIONARY_ACCESSIBILITY=TRUE scope=spfile;
shutdown immediate;
startup
conn sys/Oradoc_db1
SHOW PARAMETER O7_DICTIONARY_ACCESSIBILITY NAME TYPE VALUE;
exit
</pre>

Running LogicalDOC Enterprise (latest release) in a Docker container with connection to Oracle 12c R2 container with jdbc connection URL on SERVICE NAME
<pre>
docker pull logicaldoc/logicaldoc
docker run --name=logicaldoc -p 8080:8080 --env LDOC_USERNO=YOUR_USERNO -e DB_ENGINE=oracle -e DB_USER=sys -e DB_PASSWORD=Oradoc_db1 -e DB_MANUALURL=true -e "DB_URL=jdbc:oracle:thin:@//Oracle12-slim:1521/ORCLCDB.localdomain" --link Oracle12-slim logicaldoc/logicaldoc
</pre>

== Oracle XE 11g (unofficial) ==
Running Oracle XE 11g (Express edition) in a Docker container<br>
<pre>
docker pull wnameless/oracle-xe-11g
docker run --name=oracle-ld -p 49161:1521 -e ORACLE_ALLOW_REMOTE=true wnameless/oracle-xe-11g
</pre>

Running LogicalDOC Enteprise (latest release) in a Docker container with connection to Oracle 11g container
(JDBC Connection using SID)<br>
See also [https://razorsql.com/articles/oracle_jdbc_connect.html How to Connect to Oracle via JDBC]<br>
In this example the SID is: xe (DB_NAME)
<pre>
docker pull logicaldoc/logicaldoc
docker run --name=logicaldoc -p 8080:8080 --env LDOC_USERNO=YOUR_USERNO -e DB_ENGINE=oracle -e DB_HOST=oracle-ld -e DB_PORT=1521 -e DB_USER=system -e DB_PASSWORD=oracle -e DB_NAME=xe --link oracle-ld logicaldoc/logicaldoc
</pre>

Running LogicalDOC Enteprise (latest release) in a Docker container connected to Oracle 11g with jdbc connection URL explicitly specified
<pre>
docker pull logicaldoc/logicaldoc
docker run --name=logicaldoc -p 8080:8080 --env LDOC_USERNO=YOUR_USERNO -e DB_ENGINE=oracle -e DB_USER=system -e DB_PASSWORD=oracle -e DB_MANUALURL=true -e "DB_URL=jdbc:oracle:thin:@//oracle-ld:1521/xe" --link oracle-ld logicaldoc/logicaldoc
</pre>

== Running LogicalDOC Enterprise in a Docker container with connection to a MS SQL Server database ==
Running MS SQL Server 2017 in a Docker container<br>
<pre>
docker pull microsoft/mssql-server-linux:2017-latest
docker run --name=tomssl_sql -e 'ACCEPT_EULA=Y' -e 'SA_PASSWORD=Str0ngPassword!' -p 1401:1433 microsoft/mssql-server-linux:2017-latest

docker exec -it tomssl_sql /opt/mssql-tools/bin/sqlcmd -S localhost -U sa

CREATE DATABASE logicaldoc;
GO

EXIT
</pre>

Running LogicalDOC Enteprise (latest release) in a Docker container with connection to SQL Server container
<pre>
docker pull logicaldoc/logicaldoc
docker run --name=ldocmssql -p 8080:8080 --env LDOC_USERNO=YOUR_USERNO -e DB_ENGINE=mssql -e DB_HOST=tomssl_sql -e DB_PORT=1433 -e DB_USER=sa -e 'DB_PASSWORD=Str0ngPassword!' -e DB_NAME=logicaldoc -e DB_INSTANCE=MSSQLSERVER --link tomssl_sql logicaldoc/logicaldoc
</pre>

Another option is to manually specify the full connection URL</br>
Example with LD 8.9.3 with JDK 21 (LTS)</br>
<pre>
docker pull logicaldoc/logicaldoc:8.9.3-jdk21
docker run --name=ldocmssql -p 8080:8080 --env LDOC_USERNO=YOUR_USERNO -e DB_ENGINE=mssql -e DB_USER=sa -e 'DB_PASSWORD=Str0ngPassword!' -e DB_MANUALURL=true -e 'DB_URL=jdbc:sqlserver://tomssl_sql:1433;databaseName=logicaldoc;instanceName=MSSQLSERVER;encrypt=false' --link tomssl_sql logicaldoc/logicaldoc:8.9.3-jdk21
</pre>

== License activation ==
{{Advice|In order to be able to enter into LogicalDOC you will have to register here to get an activation code: [https://www.logicaldoc.com/try https://www.logicaldoc.com/try]. You can then use the received code to activate your installation: [https://docs.logicaldoc.com/en/license-activation https://docs.logicaldoc.com/en/license-activation]}}

== Tesseract OCR ==
Staring from LogicalDOC Enterprise 8.2 Docker image the OCR is available but with some limitation.<br>
In particular this translates into the fact that the reference dictionaries are limited to the English language.<br>
It is possible to install new dictionaries in various languages to improve the quality of OCR character recognition<br>
<pre>
// Connect to the container instance of LogicalDOC
docker exec -it <logicaldoc-container-name> bash
apt-get install tesseract-ocr-deu (installs german dictionary)
apt-get install tesseract-ocr-fra (installs french dictionary)
apt-get install tesseract-ocr-ita (installs italian dictionary)
apt-get install tesseract-ocr-spa (installs spanish dictionary)
</pre>
See also:<br>
[https://askubuntu.com/questions/793634/how-do-i-install-a-new-language-pack-for-tesseract-on-16-04 How do I install a new language pack for Tesseract on 16.04]<br>
[https://www.howtoforge.com/tutorial/tesseract-ocr-installation-and-usage-on-ubuntu-16-04/ Tesseract OCR: Installation and Usage on Ubuntu 16.04]

== Upgrade LogicalDOC Docker container ==
To update LogicalDOC running on a Docker container it is necessary to perform a particular procedure.<br>

This is to avoid compromising the configuration of the application and the documents it contains.<br>

Here is the link [[Upgrade Docker container|Upgrade Docker container]]

== More Information ==
For more information about LogicalDOC Docker image: [https://hub.docker.com/r/logicaldoc/logicaldoc https://hub.docker.com/r/logicaldoc/logicaldoc]

[[Category: Docker]]
[[Category: Tesseract]]
[[Category: OCR]]

RESTful Guide with curl

2024-06-12T07:49:31Z

Blucecio: /* Tags */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result is:

<source lang="text">
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</source>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result in XML is:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</source>

This is a Java client for the same call:

<source lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</source>

== Folder ==
Let's create a new folder:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple

Creates a path of folders starting from the folder with ID 4 (Default folder)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"

Or also from a HTML form:

<source lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</source>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

=== Download ===

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890"

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2024-06-12T07:48:43Z

Blucecio: /* Tags */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result is:

<source lang="text">
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</source>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result in XML is:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</source>

This is a Java client for the same call:

<source lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</source>

== Folder ==
Let's create a new folder:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple

Creates a path of folders starting from the folder with ID 4 (Default folder)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"

Or also from a HTML form:

<source lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</source>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

=== Download ===

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456"

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2024-06-12T07:46:10Z

Blucecio: /* Tags */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result is:

<source lang="text">
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</source>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result in XML is:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</source>

This is a Java client for the same call:

<source lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</source>

== Folder ==
Let's create a new folder:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple

Creates a path of folders starting from the folder with ID 4 (Default folder)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"

Or also from a HTML form:

<source lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</source>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

=== Download ===

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" \
--data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456"

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2024-06-12T07:45:32Z

Blucecio: /* Tags */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result is:

<source lang="text">
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</source>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result in XML is:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</source>

This is a Java client for the same call:

<source lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</source>

== Folder ==
Let's create a new folder:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple

Creates a path of folders starting from the folder with ID 4 (Default folder)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"

Or also from a HTML form:

<source lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</source>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

=== Download ===

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" -H "Content-Type: application/x-www-form-urlencoded" \
-d "docId=325" --data-urlencode "tag=fileExtension:docx" --data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456"

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2024-06-12T07:44:12Z

Blucecio: /* Tags */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result is:

<source lang="text">
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</source>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result in XML is:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</source>

This is a Java client for the same call:

<source lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</source>

== Folder ==
Let's create a new folder:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple

Creates a path of folders starting from the folder with ID 4 (Default folder)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"

Or also from a HTML form:

<source lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</source>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

=== Download ===

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=325" --data-urlencode
"tag=fileExtension:docx" --data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456"

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2024-06-12T07:43:09Z

Blucecio: /* Search */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result is:

<source lang="text">
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</source>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result in XML is:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</source>

This is a Java client for the same call:

<source lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</source>

== Folder ==
Let's create a new folder:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple

Creates a path of folders starting from the folder with ID 4 (Default folder)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"

Or also from a HTML form:

<source lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</source>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

=== Download ===

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

== Tags ==
Set the document tags of document with ID = 325

$curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/tag/setDocumentTags" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=325" --data-urlencode "tag=fileExtension:docx" --data-urlencode "tag=wopiLockString:1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456"

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

Switch to Java17 on Linux

2024-05-07T09:35:06Z

Blucecio:

=== Reconfigure LogicalDOC to use Java 17 on Linux ===

Starting from version 8.9.1 LogicalDOC does not work with Java 11 anymore so you have to install Java17.
Please read first [https://docs.logicaldoc.com/en/installation how to install the right Java to use with LogicalDOC].

It is important to install Java JDK 17 and not Java 18 or Java 19, because Java 17 is an LTS (Long Term Support) version and therefore support and updates will be available for a long time, also LD 8.9.1 has been extensively tested on this version.<br><br>

Given '''<LDOC_HOME>''' the installation path of LogicalDOC (by default it is /LogicalDOC), please proceed as follows:

1. Install [https://docs.logicaldoc.com/en/installation Java 17 from Oracle or OpenJDK17]

Hint for Ubuntu:
<source>$ apt install -y openjdk-17-jdk</source>
Hint for CentOS and RedHat:
<source>
$ wget https://download.java.net/openjdk/jdk17/ri/openjdk-17+35_linux-x64_bin.tar.gz
$ tar xvf openjdk*
$ sudo mv jdk-17 /usr/java/
$ sudo ln -sfn /usr/java/jdk-17 /usr/java/latest
$ sudo ln -sfn /usr/java/jdk-17 /usr/java/default
$ sudo ln -sfn /usr/java/latest/bin/java /usr/bin/java
</source>

2. With VI, or any other text editor, open the file '''<LDOC_HOME>'''/bin/logicaldoc.sh.
Inside that file, locate the variable '''JAVA_HOME''' and make sure it points to the Java17 installation folder:<br>
Probable path in Ubuntu:
<source>export JAVA_HOME=/usr</source>
Probable path in CentOS and RedHat:
<source>export JAVA_HOME=/usr/java/latest</source>

3. Iterate the point 2 for this list of additional files:
* '''<LDOC_HOME>'''/bin/update.sh
* '''<LDOC_HOME>'''/bin/patch.sh
* '''<LDOC_HOME>'''/bin/restart.sh
* '''<LDOC_HOME>'''/bin/reset-passwd.sh

4. Restart LogicalDOC

Switch to Java17 on Linux

2024-05-07T09:33:48Z

Blucecio:

=== Reconfigure LogicalDOC to use Java 17 on Linux ===

Starting from version 8.9.1 LogicalDOC does not work with Java 11 anymore so you have to install Java17.
Please read first [https://docs.logicaldoc.com/en/installation how to install the right Java to use with LogicalDOC].

It is important to install Java 17 and not Java 18 or Java 19, because Java 17 is an LTS (Long Term Support) version and therefore support and updates will be available for a long time.<br><br>

Given '''<LDOC_HOME>''' the installation path of LogicalDOC (by default it is /LogicalDOC), please proceed as follows:

1. Install [https://docs.logicaldoc.com/en/installation Java 17 from Oracle or OpenJDK17]

Hint for Ubuntu:
<source>$ apt install -y openjdk-17-jdk</source>
Hint for CentOS and RedHat:
<source>
$ wget https://download.java.net/openjdk/jdk17/ri/openjdk-17+35_linux-x64_bin.tar.gz
$ tar xvf openjdk*
$ sudo mv jdk-17 /usr/java/
$ sudo ln -sfn /usr/java/jdk-17 /usr/java/latest
$ sudo ln -sfn /usr/java/jdk-17 /usr/java/default
$ sudo ln -sfn /usr/java/latest/bin/java /usr/bin/java
</source>

2. With VI, or any other text editor, open the file '''<LDOC_HOME>'''/bin/logicaldoc.sh.
Inside that file, locate the variable '''JAVA_HOME''' and make sure it points to the Java17 installation folder:<br>
Probable path in Ubuntu:
<source>export JAVA_HOME=/usr</source>
Probable path in CentOS and RedHat:
<source>export JAVA_HOME=/usr/java/latest</source>

3. Iterate the point 2 for this list of additional files:
* '''<LDOC_HOME>'''/bin/update.sh
* '''<LDOC_HOME>'''/bin/patch.sh
* '''<LDOC_HOME>'''/bin/restart.sh
* '''<LDOC_HOME>'''/bin/reset-passwd.sh

4. Restart LogicalDOC

Switch to Java17 on Windows

2024-05-07T09:30:35Z

Blucecio:

=== Reconfigure LogicalDOC to use Java 17 on Windows ===

Starting from version 8.9.1 LogicalDOC does not work with Java11 anymore so you have to install Java17.
Please read first [https://docs.logicaldoc.com/en/installation how to install the right Java to use with LogicalDOC].

It is important to install Java17 and not Java18 nor Java19, because Java17 is the latest LTS (Long Term Support) release available at the moment.<br><br>

Given '''<LDOC_HOME>''' the installation path of LogicalDOC (by default it is C:\LogicalDOC), please proceed as follows:

1. Install [https://docs.logicaldoc.com/en/installation Java17 from Oracle or OpenJDK17]

2. Open a shell as Administator and go to '''<LDOC_HOME>'''\tomcat\bin\

3. Execute the command '''LogicalDOCw.exe //MS/LogicalDOC'''

4. This creates a tray icon with the LogicalDOC’s logo

5. Right click on it and choose '''Configure...'''<br/>
[[Image:Ldoc_tray.png]]

6. Now open the <b>Java</b> tab<br/>
[[Image:Java-virtual-machine.png]]

7. In the '''Java Virtual Machine''' put the full path of your jvm.dll (something like C:\Program Files\Java\jdk-11.0.4\bin\server)

8. Click on '''Apply''' and then '''Ok'''

9. Restart the '''LogicalDOC''' service

10. Open a shell as Administator and go to '''<LDOC_HOME>'''\update-wd

11. Execute the command '''update-wdw.exe //MS/LogicalDOC-Update''

12. This creates another tray icon with the LogicalDOC’s logo

13. Right click on it and choose <b>Configure...</b><br/>
[[Image:update_tray.png]]

14. Now open the <b>Java</b> tab<br/>
[[Image:udpatewd-java17.png]]

15. In the '''Java Virtual Machine''' put the full path of your jvm.dll (something like C:\Program Files\Java\jdk-11.0.4\bin\server)

16. Click on '''Apply''' and then '''Ok'''

17. Define the a system variable '''JAVA_HOME''' pointing to the Java11 installation path (something like C:\Program Files\Java\jdk-11.0.4)

18. Restart the '''LogicalDOC Update''' service

Switch to Java17 on Linux

2024-05-03T09:17:19Z

Blucecio: /* Reconfigure LogicalDOC to use Java 17 on Linux */

=== Reconfigure LogicalDOC to use Java 17 on Linux ===

Starting from version 8.9.1 LogicalDOC does not work with Java 11 anymore so you have to install Java17.
Please read first [https://docs.logicaldoc.com/en/installation how to install the right Java to use with LogicalDOC].

It is important to install Java 17 and not Java 18 or Java 19, because Java 17 is an LTS (Long Term Support) version and because it is the minimum version required starting from LogicalDOC 8.9.1<br><br>
Alternatively you can also install another Java JDK (as long as LTS) such as Java JDK 21.<br><br>

Given '''<LDOC_HOME>''' the installation path of LogicalDOC (by default it is /LogicalDOC), please proceed as follows:

1. Install [https://docs.logicaldoc.com/en/installation Java 17 from Oracle or OpenJDK17]

Hint for Ubuntu:
<source>$ apt install -y openjdk-17-jdk</source>
Hint for CentOS and RedHat:
<source>
$ wget https://download.java.net/openjdk/jdk17/ri/openjdk-17+35_linux-x64_bin.tar.gz
$ tar xvf openjdk*
$ sudo mv jdk-17 /usr/java/
$ sudo ln -sfn /usr/java/jdk-17 /usr/java/latest
$ sudo ln -sfn /usr/java/jdk-17 /usr/java/default
$ sudo ln -sfn /usr/java/latest/bin/java /usr/bin/java
</source>

2. With VI, or any other text editor, open the file '''<LDOC_HOME>'''/bin/logicaldoc.sh.
Inside that file, locate the variable '''JAVA_HOME''' and make sure it points to the Java17 installation folder:<br>
Probable path in Ubuntu:
<source>export JAVA_HOME=/usr</source>
Probable path in CentOS and RedHat:
<source>export JAVA_HOME=/usr/java/latest</source>

3. Iterate the point 2 for this list of additional files:
* '''<LDOC_HOME>'''/bin/update.sh
* '''<LDOC_HOME>'''/bin/patch.sh
* '''<LDOC_HOME>'''/bin/restart.sh
* '''<LDOC_HOME>'''/bin/reset-passwd.sh

4. Restart LogicalDOC

Switch to Java17 on Linux

2024-05-03T09:09:01Z

Blucecio:

=== Reconfigure LogicalDOC to use Java 17 on Linux ===

Starting from version 8.9.1 LogicalDOC does not work with Java 11 anymore so you have to install Java17.
Please read first [https://docs.logicaldoc.com/en/installation how to install the right Java to use with LogicalDOC].

It is important to install Java17 and not Java18 nor Java19, because Java 17 is the latest LTS (Long Term Support) release available at the moment.<br><br>

Given '''<LDOC_HOME>''' the installation path of LogicalDOC (by default it is /LogicalDOC), please proceed as follows:

1. Install [https://docs.logicaldoc.com/en/installation Java 17 from Oracle or OpenJDK17]

Hint for Ubuntu:
<source>$ apt install -y openjdk-17-jdk</source>
Hint for CentOS and RedHat:
<source>
$ wget https://download.java.net/openjdk/jdk17/ri/openjdk-17+35_linux-x64_bin.tar.gz
$ tar xvf openjdk*
$ sudo mv jdk-17 /usr/java/
$ sudo ln -sfn /usr/java/jdk-17 /usr/java/latest
$ sudo ln -sfn /usr/java/jdk-17 /usr/java/default
$ sudo ln -sfn /usr/java/latest/bin/java /usr/bin/java
</source>

2. With VI, or any other text editor, open the file '''<LDOC_HOME>'''/bin/logicaldoc.sh.
Inside that file, locate the variable '''JAVA_HOME''' and make sure it points to the Java17 installation folder:<br>
Probable path in Ubuntu:
<source>export JAVA_HOME=/usr</source>
Probable path in CentOS and RedHat:
<source>export JAVA_HOME=/usr/java/latest</source>

3. Iterate the point 2 for this list of additional files:
* '''<LDOC_HOME>'''/bin/update.sh
* '''<LDOC_HOME>'''/bin/patch.sh
* '''<LDOC_HOME>'''/bin/restart.sh
* '''<LDOC_HOME>'''/bin/reset-passwd.sh

4. Restart LogicalDOC

Switch to Java17 on Linux

2024-05-03T09:08:34Z

Blucecio: /* Reconfigure LogicalDOC to use Java 17 on Linux */

=== Reconfigure LogicalDOC to use Java 17 on Linux ===

Starting from version 8.9.1 LogicalDOC does not work with Java11 anymore so you have to install Java17.
Please read first [https://docs.logicaldoc.com/en/installation how to install the right Java to use with LogicalDOC].

It is important to install Java17 and not Java18 nor Java19, because Java17 is the latest LTS (Long Term Support) release available at the moment.<br><br>

Given '''<LDOC_HOME>''' the installation path of LogicalDOC (by default it is /LogicalDOC), please proceed as follows:

1. Install [https://docs.logicaldoc.com/en/installation Java17 from Oracle or OpenJDK17]

Hint for Ubuntu:
<source>$ apt install -y openjdk-17-jdk</source>
Hint for CentOS and RedHat:
<source>
$ wget https://download.java.net/openjdk/jdk17/ri/openjdk-17+35_linux-x64_bin.tar.gz
$ tar xvf openjdk*
$ sudo mv jdk-17 /usr/java/
$ sudo ln -sfn /usr/java/jdk-17 /usr/java/latest
$ sudo ln -sfn /usr/java/jdk-17 /usr/java/default
$ sudo ln -sfn /usr/java/latest/bin/java /usr/bin/java
</source>

2. With VI, or any other text editor, open the file '''<LDOC_HOME>'''/bin/logicaldoc.sh.
Inside that file, locate the variable '''JAVA_HOME''' and make sure it points to the Java17 installation folder:<br>
Probable path in Ubuntu:
<source>export JAVA_HOME=/usr</source>
Probable path in CentOS and RedHat:
<source>export JAVA_HOME=/usr/java/latest</source>

3. Iterate the point 2 for this list of additional files:
* '''<LDOC_HOME>'''/bin/update.sh
* '''<LDOC_HOME>'''/bin/patch.sh
* '''<LDOC_HOME>'''/bin/restart.sh
* '''<LDOC_HOME>'''/bin/reset-passwd.sh

4. Restart LogicalDOC

RESTful Guide with curl

2024-03-27T16:17:40Z

Blucecio: /* Create via Upload */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result is:

<source lang="text">
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</source>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result in XML is:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</source>

This is a Java client for the same call:

<source lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</source>

== Folder ==
Let's create a new folder:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple

Creates a path of folders starting from the folder with ID 4 (Default folder)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"

Or also from a HTML form:

<source lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</source>

=== Create via Upload ===
Create a new document, or a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

=== Download ===

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2024-03-27T16:14:28Z

Blucecio:

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result is:

<source lang="text">
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</source>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result in XML is:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</source>

This is a Java client for the same call:

<source lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</source>

== Folder ==
Let's create a new folder:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple

Creates a path of folders starting from the folder with ID 4 (Default folder)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath

== Document ==

=== Create a Document ===
Now we are going to create a document. For this, we need to provide the document binary data:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"

Or also from a HTML form:

<source lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</source>

=== Create via Upload ===
Upload: Creates a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited in metadata control

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

=== Download ===

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2024-03-27T16:12:02Z

Blucecio: /* Document */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result is:

<source lang="text">
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</source>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result in XML is:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</source>

This is a Java client for the same call:

<source lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</source>

== Folder ==
Let's create a new folder:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple

Creates a path of folders starting from the folder with ID 4 (Default folder)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath

== Document ==

== Create a Document ==
Now we are going to create a document. For this, we need to provide the document binary data:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"

Or also from a HTML form:

<source lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</source>

=== Create via Upload ===
Upload: Creates a new version of an existing document (in one step) [Windows 11]<br/>
This is a simpler way of creating documents, however it is more limited in metadata control

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

=== Update metadata ===
Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

=== Delete ===
Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

=== Download ===

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

=== Convert a document to PDF ===

Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2024-03-27T16:06:25Z

Blucecio: /* Document */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result is:

<source lang="text">
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</source>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result in XML is:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</source>

This is a Java client for the same call:

<source lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</source>

== Folder ==
Let's create a new folder:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple

Creates a path of folders starting from the folder with ID 4 (Default folder)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath

== Document ==
Now we are going to create a document. For this, we need to provide the document binary data:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload

Or also from a HTML form:

<source lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</source>

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

<pre>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"
</pre>

Convert a document to PDF<br/>
Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
$ curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"

Upload: Creates a new version of an existing document (in one step) [Windows 11]<br/>

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2024-03-27T16:06:03Z

Blucecio: /* Document */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result is:

<source lang="text">
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</source>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result in XML is:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</source>

This is a Java client for the same call:

<source lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</source>

== Folder ==
Let's create a new folder:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple

Creates a path of folders starting from the folder with ID 4 (Default folder)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath

== Document ==
Now we are going to create a document. For this, we need to provide the document binary data:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload

Or also from a HTML form:

<source lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</source>

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

<pre>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"
</pre>

Convert a document to PDF<br/>
Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
$ curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"

Upload: Creates a new version of an existing document (in one step) [Windows 11]<br/>

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2024-03-27T16:05:11Z

Blucecio: /* Document */

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result is:

<source lang="text">
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</source>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result in XML is:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</source>

This is a Java client for the same call:

<source lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</source>

== Folder ==
Let's create a new folder:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple

Creates a path of folders starting from the folder with ID 4 (Default folder)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath

== Document ==
Now we are going to create a document. For this, we need to provide the document binary data:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload

Or also from a HTML form:

<source lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</source>

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

<pre>
curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"
</pre>

Convert a document to PDF<br/>
Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"

Upload: Creates a new version of an existing document (in one step) [Windows 11]<br/>

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

RESTful Guide with curl

2024-03-27T16:04:43Z

Blucecio: Added document conversion to PDF

{{TOCright}} __TOC__

{{Note|If you're interested in use LogicalDOC API we suggest to '''take a look at ours [[Bindings_And_Samples|Bindings and Samples]] and take advantage of already usable examples which connect to webservices API.}}

LogicalDOC has a [http://docs.logicaldoc.com/en/web-services-api complete API exposed via REST]. This means you can call any of these API methods from any programming language, like Java, PHP or Python among others. This feature makes it possible to create a custom client, or integrate with third-party applications like a CRM or a CMS.

{{Advice|Examples in this page refer to LogicalDOC 7.7; the [http://docs.logicaldoc.com/en/web-services-api REST API] is currently in development, so expect changes and additions.}}

If you point your browser to http://localhost:8080/services, you can see the SOAP API at first place but at the bottom you will see a '''Available RESTful services''' section. These URLs are protected by BASIC authentication so you need to provide an user and password to access them.

== Sample usage ==
To try these API methods you can use an HTTP Client library or any REST client which ease this process. Or simply you can use the '''curl''' command-line application. For example, you can list the children folders:

$ curl -u admin:admin -H "Accept: application/json" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result is:

<source lang="text">
[
{
"id": 3440640,
"name": "alfa",
"parentId": 4,
"description": "",
"lastModified": "2016-06-15 15:49:40 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-15 15:49:40 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
},
{
"id": 3440643,
"name": "beta",
"parentId": 4,
"description": "",
"lastModified": "2016-06-16 10:16:25 +0200",
"type": 0,
"templateId": null,
"templateLocked": 0,
"creation": "2016-06-16 09:49:27 +0200",
"creator": "Admin Admin",
"position": 1,
"hidden": 0,
"foldRef": null,
"attributes": [

]
}
]
</source>

In this case you can see the result in JSON format.
Some endpoints can also provide the results in XML format but you have to check them, if that is supported we can make a call sending the appropriate '''Accept''' header:

$ curl -u admin:admin -H "Accept: application/xml" \
http://localhost:8080/services/rest/folder/listChildren?folderId=4

The result in XML is:

<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<folders>
<folder>
<creation>2016-06-15 15:49:40 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440640</id>
<lastModified>2016-06-15 15:49:40 +0200</lastModified>
<name>alfa</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
<folder>
<creation>2016-06-16 09:49:27 +0200</creation>
<creator>Admin Admin</creator>
<description></description>
<hidden>0</hidden>
<id>3440643</id>
<lastModified>2016-06-16 10:16:25 +0200</lastModified>
<name>beta</name>
<parentId>4</parentId>
<position>1</position>
<templateLocked>0</templateLocked>
<type>0</type>
</folder>
</folders>
</source>

This is a Java client for the same call:

<source lang="java">
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.Authenticator;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.PasswordAuthentication;
import java.net.URL;

public class JavaRestClient {
public static void main(String[] args) throws Exception {
try {
long folderID = 4L;
URL url = new URL("http://localhost:8080/services/rest/folder/listChildren?folderId=" + folderID);
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("GET");
conn.setRequestProperty("Accept", "application/json");

Authenticator.setDefault(new Authenticator() {
protected PasswordAuthentication getPasswordAuthentication() {
return new PasswordAuthentication("admin", "admin".toCharArray());
}
});

if (conn.getResponseCode() == 200) {
BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));
System.out.println("Output from Server .... \n");
String output;

while ((output = br.readLine()) != null) {
System.out.println(output);
}
} else {
System.err.println("Failed : HTTP error code : " + conn.getResponseCode());
}

conn.disconnect();
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}
}
</source>

== Folder ==
Let's create a new folder:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: text/plain" -d "/Default/Curl/newfolder" \
http://localhost:8080/services/rest/folder/createSimple

Creates a path of folders starting from the folder with ID 4 (Default folder)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -H "Content-Type: application/x-www-form-urlencoded" -d parentId=4 -d path=How/to/POST/JSON/data/with/Curl \
http://localhost:8080/services/rest/folder/createPath

== Document ==
Now we are going to create a document. For this, we need to provide the document binary data:

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=CHANGELOG.txt -F filedata=@CHANGELOG.txt \
http://localhost:8080/services/rest/document/upload

In this case the document will be added to the respository using the default language (english). Of course it is possible to specify the additional parameter 'language' to tell the system that the document we are storing is in german (ISO 639-2 code)

$ curl -u admin:admin -H "Accept: application/json" \
-X POST -F folderId=4 -F filename=pub_arbeitsplatz_straße.pdf -F language=de -F filedata=@pub_arbeitsplatz_straße.pdf \
http://localhost:8080/services/rest/document/upload

Or also from a HTML form:

<source lang="html4strict">
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/services/rest/document/upload">
Select folder: <input type="text" name="folderId" value="4"/><br/>
Select filename: <input type="text" name="filename" /><br/>
Select file: <input type="file" name="filedata" size="45"/><br/>
<input type="submit" value="Upload" />
</form>
</body>
</html>
</source>

And now download it:

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456

If the document is a binary file you can redirect the output to a file adding '> filename' to the end of the command

$ curl -u admin:admin \
http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf

Delete a specific version of a given document (since v7.6.4)

$ curl -u admin:admin \
-G -d docId=1803 -d version=1.3 -X DELETE http://localhost:8080/services/rest/document/deleteVersion

Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue

$ curl -v -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X PUT \
-d "{ \"id\": 47, \"folderId\": 4, \"fileName\":\"Egzai_u002.doc\", \"templateId\":92241920, \"attributes\":[{\"name\":\"ack\",\"stringValue\":\"ack\",\"type\":0},{\"name\":\"Tar\",\"dateValue\":\"2017-03-18 19:10:00 +0100\",\"type\":3}] }" \
http://localhost:8080/services/rest/document/update

Creates a document with the create method on Windows 10<br/>
Windows 10, curl 7.55.1 (Windows) libcurl/7.55.1 WinSSL

<pre>
curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/create" -H "accept: application/json" -H "Content-Type: multipart/form-data" -F "document={ \"language\":\"en\",\"fileName\":\"ScreenHunter949.png\",\"folderId\":4 };type=application/json" -F "content=@C:\Users\shatz\Desktop\ScreenHunter949.png;type=application/octet-stream"
</pre>

Convert a document to PDF
Note: This will only perform the conversion, if completed successfully it returns HTTP code 204 and empty content
<pre>
curl -v -X PUT "http://localhost:8080/services/rest/document/createPdf?docId=125" -H "accept: application/json" -H "Authorization: Basic YWRtaW46YWRtaW4="
</pre>

Download the converted .PDF file (latest version of the document)
<pre>
curl -v -X GET "http://localhost:8080/services/rest/document/getResource?docId=125&suffix=conversion.pdf" -H "accept: application/octet-stream" -H "Authorization: Basic YWRtaW46YWRtaW4=" --output 125-conversion.pdf
</pre>

=== Versioning ===
Checkout an existing document<br/>
$ curl -k -u admin:admin -X POST https://[url]/services/rest/document/checkout \
-H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "docId=2686"

Checkin a new version of document (the document must be in checked-out state) [Windows 11]<br/>
$ curl -v -u admin:admin -X POST "http://localhost:8080/services/rest/document/checkin" \
-H "accept: */*" -H "Content-Type: multipart/form-data" -F "docId=721" -F "comment=" -F "release=false" -F "filename=Checkmarx.txt" -F "filedata=@Checkmarx.txt;type=text/plain"

Upload: Creates a new version of an existing document (in one step) [Windows 11]<br/>

$ curl -u admin:admin -X POST "http://localhost:8080/services/rest/document/upload" \
-H "Accept: application/json" -H "Content-Type: multipart/form-data" -F "docId=721" -F "folderId=" -F "release=false" \
-F "filename=logicaldoc_community - Checkmarx AST.pdf" -F "language=en" -F "filedata=@logicaldoc_community - Checkmarx AST.pdf;type=application/pdf"

Upload: updates the content of an existing document generating a new version
$ curl -v -u admin:admin -H "Accept: application/json" -X POST -F docId=118 -F filename=google.png -F filedata=@C:\tmp\google.png http://localhost:8080/services/rest/document/upload

== Search ==
Standard Full-text search on content, title and tags using english as language of the query (expressionLanguage) and on english documents (language):

$ curl -u admin:admin -H "Content-Type: application/json" -H "Accept: application/json" -X POST \
-d "{\"maxHits\":50,\"expression\":\"document management system\",\"expressionLanguage\":\"en\",\"language\":\"en\", \"dateFrom\": \"2023-01-01\"}"
http://localhost:8080/services/rest/search/find

Date fields you can use:
<pre>
"dateFrom": "string",
"dateTo": "string",
"creationFrom": "string",
"creationTo": "string",
</pre>

dates must be expressed in ISO format: yyyy-mm-dd or yyyy-MM-dd HH:mm:ss (24 hours)

More info at:

* [http://www.yilmazhuseyin.com/blog/dev/curl-tutorial-examples-usage/ curl tutorial with examples of usage]
* [http://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.6.4 LogicalDOC REST API reference v7.6.4]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=7.7.6 LogicalDOC REST API reference v7.7.6]
* [https://docs.logicaldoc.com/resources/wsdoc/rest/index.html?version=8.1.0 LogicalDOC REST API reference v8.1]
* [https://app.swaggerhub.com/apis/swatzniak/logicaldoc_rest_api/8.8.1 LogicalDOC REST API | 8.8.1 | SwaggerHub]
* [[Bindings_And_Samples|Webservices - Binding and Examples]]
* [https://docs.logicaldoc.com/en/web-services-api LogicalDOC Web Services API]

[[Category: RESTful Guide]]

Bindings And Samples

2024-03-22T08:42:41Z

Blucecio: /* Python */

== JAVA Examples ==

On SourceForge we have released an example project that Tests the WS features of LD and simultaneously shows the WS invocations with JAVA<br>

{| cellspacing="1" cellpadding="1" border="1" style="width: 407px; height: 117px;"
|-
| align="center" | '''LogicalDOC version'''
| align="center" | '''Sample'''
|-
| 8.3.4
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.3/logicaldoc-webservicesamples-8.3.4.zip/download logicaldoc-webservicesamples-8.3.4.zip]
|-
| 8.3
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-8.3/Java-webserviceTests-8.3.zip/download Java-webserviceTests-8.3.zip]
|-
| 8.0.0
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-8.0/Java-webserviceTests-8.0.0.zip/download Java-webserviceTests-8.0.0.zip]
|-
| 7.6.3
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-7.6/webserviceTests-Java.zip/download webserviceTests-Java.zip]
|-
| 7.5.2
| [https://sourceforge.net/projects/logicaldoc/files/samples/samples-7.5/Java-webserviceTests-7.5.2.zip/download Java-webserviceTests-7.5.2.zip]
|-
| 7.4.0
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.4/Java-webserviceTests-7.4.zip/download Java-webserviceTests-7.4.zip]
|-
| 7.1.0
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.1/Java-webserviceTests-7.1.0.zip/download Java-webserviceTests-7.1.0.zip]
|-
| 6.8.0
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.8/Java-webserviceTests-6.8.0.zip/download Java-WebServicesTests-6.8.0.zip]
|-
| 6.7.1
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.7/Java-webserviceTests-6.7.1.zip/download Java-WebServicesTests-6.7.1.zip]
|-
| 6.6.2
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.6/Java-WebServicesTests-6.6.2.zip/download Java-WebServicesTests-6.6.2.zip]
|-
| 6.5.1
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.5/Java-WebServicesTests-6.5.1.zip/download Java-WebServicesTests-6.5.1.zip]
|-
| 6.4
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.4/Java-WebServicesTests-6.4.zip/download Java-WebServicesTests-6.4.zip]
|-
| 6.2
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.2/Java-WebServicesTests-6.2.zip/download Java-WebServicesTests-6.2.zip]
|-
| 6.0
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.0/Java-webserviceTests-6.0.zip/download Java-WebServicesTests-6.0.zip]
|-
| 5.0/5.1
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-5.1/Java-webserviceTests-5.1.zip/download Java-WebServicesTests-5.1.zip]
|}

== .NET Integration ==

This is a sample Visual Studio 2008/2010 project created to illustrate some C# .NET 4.0/2.0 invocations of the LogicalDOC web-services<br>

{| cellspacing="1" cellpadding="1" border="1" style="width: 508px; height: 102px;"
|-
| align="center" | '''LD version'''
| align="center" | '''Sample package'''
| align="center" | '''Visual Studio'''
| align="center" | '''Notes'''
|-
| 8.7.1
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.7/dotNET2WSClient4-8.7.1.zip/download dotNET2WSClient4-8.7.1.zip]
| VS 2017
|
|-
| 8.3
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.3/dotNET2WSClient4-8.3.zip/download dotNET2WSClient4-8.3.zip]
| VS 2013
| Includes an example of creating AttributeSets and Templates
|-
| 8.2.1
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.2/dotNET2WSClient4-8.2.1.zip/download dotNET2WSClient4-8.2.1.zip]
| VS 2013
| Complete example of full-text search with custom attributes
|-
| 8.1.1
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.1/dotNET2WSClient4-8.1.1.zip/download dotNET2WSClient4-8.1.1.zip]
| VS 2013
| Full-text search with search in sub-folder
|-
| 7.7.3
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.7/dotNET2WSClient4-7.7.3.zip/download dotNET2WSClient4-7.7.3.zip]
| VS 2013
| (.NET 4.0) Upload document REST example
|-
| 7.5
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.5/dotNET4_WSClient-7.5.zip/download dotNET4_WSClient-7.5.zip]
| VS 2013
| (.NET 4.0) Upload document REST example
|-
| 7.1
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.1/dotNET-WSExamples-7.1.zip/download dotNET-WSExamples-7.1.zip]
| VS 2010
|-
| 6.8.4
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.8/dotNET2WSClient-6.8.4.zip/download dotNET2WSClient-6.8.4.zip]
| VS 2010
|-
| 6.7.1
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.7/dotNET2WSClient-6.7.1.zip/download dotNET2WSClient-6.7.1.zip]
| VS 2010
|-
| 6.6.2
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.6/dotNET-WSClient-6.6.2.zip/download dotNET-WSClient-6.6.2.zip]
| Visual Studio 2010 project
|-
| 6.5.2
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.5/dotNET-WSClient-6.5.2.zip/download dotNET-WSClient-6.5.2.zip]<br>
|-
| 6.4
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.4/dotNET-webservice-client-6.4.zip/download dotNET-webservice-client-6.4.zip]<br>
|-
| 6.0
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.0/dotNET2WSClient-6.0.zip/download dotNET2WSClient-6.0.zip]<br>
|-
| 5.2.1
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-5.2/dotNET2WSClient-5.2.1.zip/download dotNET2WSClient-5.2.1.zip]<br>
|-
| 5.0
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-5.0/dotNET2WSClient-5.0.zip/download dotNET2WSClient-5.0.zip]<br>
|}

== PHP Integration ==

The Web-Services of LogicalDOC are compatibles with PHP 8.2 <br>
The example package contains scripts for invoking the LogicalDOC API via SOAP and REST webservice.<br>
As always you can download it from SourceForge.<br>

{| cellspacing="1" cellpadding="1" border="1" style="width: 100%; height: 79px;"
|-
| align="center" | '''LogicalDOC version'''
| '''PHP version'''
| align="center" | '''Download Url'''
| '''Notes'''
|-
| 8.8.6<br>
|8.2
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-8.8/PHP-logicaldoc-webservices-886.zip/download PHP-logicaldoc-webservices-886]
| Changes: fixed document creation via SOAP with LD 8.3 and higher
|-
| 8.7.3<br>
|7.4
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.7/PHP-SOAP_webservice-873.zip/download PHP-SOAP_webservice-873.zip]
| Changes: Chunk upload for large files
|-
| 8.4.2<br>
|7.2
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.4/PHP-SOAP_webservice-842.zip/download PHP-SOAP_webservice-842.zip]
| Changes: REST methods invocations
|-
| 8.2.1<br>
|7.2
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.2/PHP-SOAP_webservice-8.2.1.zip/download PHP-SOAP_webservice-8.2.1.zip]
|-
| 8.1.1<br>
|7.0
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.1/PHP-SOAP_webservice-8.1.1.zip/download PHP-SOAP_webservice-8.1.1.zip]
| Changes: updated example for recursive download
|-
| 8.0<br>
|7.0
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.0/PHP-SOAP_webservice-8.0.zip/download PHP-SOAP_webservice-8.0.zip]
|-
| 7.7<br>
|5.4.43
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.7/PHP-SOAP_webservice-77.zip/download PHP-SOAP_webservice-77.zip]
| Changes: Removed field title in WSDocument
|-
| 7.5/7.5.1<br>
|5.4.43
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.5/PHP-SOAP_webservice-7.5.zip/download PHP-SOAP_webservice-7.5.zip]
| Changes: Important changes in WSDocument fields (attributes), new REST examples
|-
| 7.4<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.4/PHP-SOAP_webservice-7.4-R02.zip/download PHP-SOAP_webservice-7.4-R02.zip]
| Changes: Some changes in the WSDocument and WSFolder fields, new REST examples, new samples of Enterprise Search (parametric search)
|-
| 7.2<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.2/PHP-SOAP_webservice-7.2.zip/download PHP-SOAP_webservice-7.2.zip]
| Changes: Creating a folder from template with related metadata
|-
| 7.0.0<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.0/PHP-SOAP_webservice-7.0.zip/download PHP-SOAP_webservice-7.0.zip]
| Changes: updated Search fullText examples, new Enterprise parametric search, Document download alias, Document download REST (big files), mini application in PHP, shows the latest document created/updated
|-
| 6.8.4<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%206.8/PHP-SOAP_webservice-6.8.4.zip/download PHP-SOAP_webservice-6.8.4.zip]
| Changes: search by parameters (EnterpriseSearch), full-text search on template fields, getTemplate by name (DocumentMeta)
|-
| 6.8.3<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%206.8/PHP-SOAP_webservice-6.8.3.zip/download PHP-SOAP_webservice-6.8.3.zip]
| Changes: new mini application in PHP, performs the research and presents a list of results for download
|-
| 6.8.1<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.8/PHP-SOAP_webservice-6.8.1.zip/download PHP-SOAP_webservice-6.8.1.zip]
|
|-
| 6.7.1<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.7/PHP-SOAP_webservice-6.7.1.zip/download PHP-SOAP_webservice-6.7.1.zip]
| Changes in: Search_parametric.php and Folder_workspaces.php
|-
| 6.6.2<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.6/PHP-SOAP_webservice-6.6.2.zip/download PHP-SOAP_webservice-6.6.2.zip]
| New examples: Search_parametric.php and Document_createBinaryWithTemplate.php
|-
| 6.5.2<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.5/PHP-SOAP_webservice-6.5.2.zip/download PHP-SOAP_webservice-6.5.2.zip]
|
|-
| 6.5.1<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.5/PHP-SOAP_webservice-6.5.1.zip/download PHP-SOAP_webservice-6.5.1.zip]
|
|-
| 6.4<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.4/PHP-SOAP_webservice-6.4.zip/download PHP-SOAP_webservice-6.4.zip]<br>
| Of particular interest is the new example Folder_downloadRecursively.php that lets you perform full backup of the repository starting from a given folder
|-
| 6.0<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.0/PHP-SOAP_webservice-6.0.zip/download PHP-SOAP_webservice-6.0.zip]<br>
|-
| 5.0/5.1<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-5.1/PHP-SOAP_webservice-5.1.zip/download PHP-SOAP_webservice-5.1.zip]
|}

== Python ==
A set of examples in Python to use the new REST APIs available from LogicalDOC since version 7.5<br/>
3.11.4 is the version of Python that we used to create and test the latest scripts.<br/>
These can be run from the command line on Windows: python <SCRIPT_FILENAME><br/>
Be aware that you might have to change the address and port of your LogicalDOC or the login credentials.<br/>
<br>
{| cellspacing="1" cellpadding="1" border="1" style="width: 100%; height: 79px;"
|-
| align="center" | '''LD version'''
| align="center" | '''Download Url'''
| '''Notes'''
|-
| 8.9.1<br>
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-8.9/Python-logicaldoc-webservices-891.zip/download Python-logicaldoc-webservices-891.zip]
| Added Reading Request SOAP and REST examples<br/>Added listUsers and StoreUser SOAP examples
|-
| 8.7.4<br>
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-8.7/Python-samples-8.7.4.zip/download Python-samples-8.7.4.zip]
| Added Enterprise Search REST examples
|-
| 8.7.3<br>
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.7/Python-samples-873.zip/download Python-samples-873.zip]
| Interactive Documentation about the RESTful APIs is available at [http://docs.logicaldoc.com/en/web-services-api http://docs.logicaldoc.com/en/web-services-api]
|-
| 8.4.2<br>
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.4/Python-samples-842.zip/download Python-samples-842.zip]
| Interactive Documentation about the RESTful APIs is available at [http://docs.logicaldoc.com/en/web-services-api http://docs.logicaldoc.com/en/web-services-api]
|-
| 7.7<br>
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.7/Python-samples-77.zip/download Python-samples-77.zip]
| Interactive Documentation about the RESTful APIs is available at [http://docs.logicaldoc.com/en/web-services-api http://docs.logicaldoc.com/en/web-services-api]
|-
| 7.5/7.5.1<br>
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.5/Python-samples-751.zip/download Python-samples-751.zip]
| Interactive Documentation about the RESTful APIs is available at [http://wiki.logicaldoc.com/rest/ http://wiki.logicaldoc.com/rest/]
|}

Bindings And Samples

2024-03-22T08:40:41Z

Blucecio: /* Python */

== JAVA Examples ==

On SourceForge we have released an example project that Tests the WS features of LD and simultaneously shows the WS invocations with JAVA<br>

{| cellspacing="1" cellpadding="1" border="1" style="width: 407px; height: 117px;"
|-
| align="center" | '''LogicalDOC version'''
| align="center" | '''Sample'''
|-
| 8.3.4
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.3/logicaldoc-webservicesamples-8.3.4.zip/download logicaldoc-webservicesamples-8.3.4.zip]
|-
| 8.3
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-8.3/Java-webserviceTests-8.3.zip/download Java-webserviceTests-8.3.zip]
|-
| 8.0.0
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-8.0/Java-webserviceTests-8.0.0.zip/download Java-webserviceTests-8.0.0.zip]
|-
| 7.6.3
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-7.6/webserviceTests-Java.zip/download webserviceTests-Java.zip]
|-
| 7.5.2
| [https://sourceforge.net/projects/logicaldoc/files/samples/samples-7.5/Java-webserviceTests-7.5.2.zip/download Java-webserviceTests-7.5.2.zip]
|-
| 7.4.0
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.4/Java-webserviceTests-7.4.zip/download Java-webserviceTests-7.4.zip]
|-
| 7.1.0
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.1/Java-webserviceTests-7.1.0.zip/download Java-webserviceTests-7.1.0.zip]
|-
| 6.8.0
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.8/Java-webserviceTests-6.8.0.zip/download Java-WebServicesTests-6.8.0.zip]
|-
| 6.7.1
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.7/Java-webserviceTests-6.7.1.zip/download Java-WebServicesTests-6.7.1.zip]
|-
| 6.6.2
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.6/Java-WebServicesTests-6.6.2.zip/download Java-WebServicesTests-6.6.2.zip]
|-
| 6.5.1
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.5/Java-WebServicesTests-6.5.1.zip/download Java-WebServicesTests-6.5.1.zip]
|-
| 6.4
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.4/Java-WebServicesTests-6.4.zip/download Java-WebServicesTests-6.4.zip]
|-
| 6.2
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.2/Java-WebServicesTests-6.2.zip/download Java-WebServicesTests-6.2.zip]
|-
| 6.0
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.0/Java-webserviceTests-6.0.zip/download Java-WebServicesTests-6.0.zip]
|-
| 5.0/5.1
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-5.1/Java-webserviceTests-5.1.zip/download Java-WebServicesTests-5.1.zip]
|}

== .NET Integration ==

This is a sample Visual Studio 2008/2010 project created to illustrate some C# .NET 4.0/2.0 invocations of the LogicalDOC web-services<br>

{| cellspacing="1" cellpadding="1" border="1" style="width: 508px; height: 102px;"
|-
| align="center" | '''LD version'''
| align="center" | '''Sample package'''
| align="center" | '''Visual Studio'''
| align="center" | '''Notes'''
|-
| 8.7.1
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.7/dotNET2WSClient4-8.7.1.zip/download dotNET2WSClient4-8.7.1.zip]
| VS 2017
|
|-
| 8.3
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.3/dotNET2WSClient4-8.3.zip/download dotNET2WSClient4-8.3.zip]
| VS 2013
| Includes an example of creating AttributeSets and Templates
|-
| 8.2.1
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.2/dotNET2WSClient4-8.2.1.zip/download dotNET2WSClient4-8.2.1.zip]
| VS 2013
| Complete example of full-text search with custom attributes
|-
| 8.1.1
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.1/dotNET2WSClient4-8.1.1.zip/download dotNET2WSClient4-8.1.1.zip]
| VS 2013
| Full-text search with search in sub-folder
|-
| 7.7.3
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.7/dotNET2WSClient4-7.7.3.zip/download dotNET2WSClient4-7.7.3.zip]
| VS 2013
| (.NET 4.0) Upload document REST example
|-
| 7.5
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.5/dotNET4_WSClient-7.5.zip/download dotNET4_WSClient-7.5.zip]
| VS 2013
| (.NET 4.0) Upload document REST example
|-
| 7.1
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.1/dotNET-WSExamples-7.1.zip/download dotNET-WSExamples-7.1.zip]
| VS 2010
|-
| 6.8.4
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.8/dotNET2WSClient-6.8.4.zip/download dotNET2WSClient-6.8.4.zip]
| VS 2010
|-
| 6.7.1
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.7/dotNET2WSClient-6.7.1.zip/download dotNET2WSClient-6.7.1.zip]
| VS 2010
|-
| 6.6.2
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.6/dotNET-WSClient-6.6.2.zip/download dotNET-WSClient-6.6.2.zip]
| Visual Studio 2010 project
|-
| 6.5.2
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.5/dotNET-WSClient-6.5.2.zip/download dotNET-WSClient-6.5.2.zip]<br>
|-
| 6.4
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.4/dotNET-webservice-client-6.4.zip/download dotNET-webservice-client-6.4.zip]<br>
|-
| 6.0
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.0/dotNET2WSClient-6.0.zip/download dotNET2WSClient-6.0.zip]<br>
|-
| 5.2.1
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-5.2/dotNET2WSClient-5.2.1.zip/download dotNET2WSClient-5.2.1.zip]<br>
|-
| 5.0
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-5.0/dotNET2WSClient-5.0.zip/download dotNET2WSClient-5.0.zip]<br>
|}

== PHP Integration ==

The Web-Services of LogicalDOC are compatibles with PHP 8.2 <br>
The example package contains scripts for invoking the LogicalDOC API via SOAP and REST webservice.<br>
As always you can download it from SourceForge.<br>

{| cellspacing="1" cellpadding="1" border="1" style="width: 100%; height: 79px;"
|-
| align="center" | '''LogicalDOC version'''
| '''PHP version'''
| align="center" | '''Download Url'''
| '''Notes'''
|-
| 8.8.6<br>
|8.2
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-8.8/PHP-logicaldoc-webservices-886.zip/download PHP-logicaldoc-webservices-886]
| Changes: fixed document creation via SOAP with LD 8.3 and higher
|-
| 8.7.3<br>
|7.4
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.7/PHP-SOAP_webservice-873.zip/download PHP-SOAP_webservice-873.zip]
| Changes: Chunk upload for large files
|-
| 8.4.2<br>
|7.2
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.4/PHP-SOAP_webservice-842.zip/download PHP-SOAP_webservice-842.zip]
| Changes: REST methods invocations
|-
| 8.2.1<br>
|7.2
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.2/PHP-SOAP_webservice-8.2.1.zip/download PHP-SOAP_webservice-8.2.1.zip]
|-
| 8.1.1<br>
|7.0
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.1/PHP-SOAP_webservice-8.1.1.zip/download PHP-SOAP_webservice-8.1.1.zip]
| Changes: updated example for recursive download
|-
| 8.0<br>
|7.0
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.0/PHP-SOAP_webservice-8.0.zip/download PHP-SOAP_webservice-8.0.zip]
|-
| 7.7<br>
|5.4.43
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.7/PHP-SOAP_webservice-77.zip/download PHP-SOAP_webservice-77.zip]
| Changes: Removed field title in WSDocument
|-
| 7.5/7.5.1<br>
|5.4.43
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.5/PHP-SOAP_webservice-7.5.zip/download PHP-SOAP_webservice-7.5.zip]
| Changes: Important changes in WSDocument fields (attributes), new REST examples
|-
| 7.4<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.4/PHP-SOAP_webservice-7.4-R02.zip/download PHP-SOAP_webservice-7.4-R02.zip]
| Changes: Some changes in the WSDocument and WSFolder fields, new REST examples, new samples of Enterprise Search (parametric search)
|-
| 7.2<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.2/PHP-SOAP_webservice-7.2.zip/download PHP-SOAP_webservice-7.2.zip]
| Changes: Creating a folder from template with related metadata
|-
| 7.0.0<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.0/PHP-SOAP_webservice-7.0.zip/download PHP-SOAP_webservice-7.0.zip]
| Changes: updated Search fullText examples, new Enterprise parametric search, Document download alias, Document download REST (big files), mini application in PHP, shows the latest document created/updated
|-
| 6.8.4<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%206.8/PHP-SOAP_webservice-6.8.4.zip/download PHP-SOAP_webservice-6.8.4.zip]
| Changes: search by parameters (EnterpriseSearch), full-text search on template fields, getTemplate by name (DocumentMeta)
|-
| 6.8.3<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%206.8/PHP-SOAP_webservice-6.8.3.zip/download PHP-SOAP_webservice-6.8.3.zip]
| Changes: new mini application in PHP, performs the research and presents a list of results for download
|-
| 6.8.1<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.8/PHP-SOAP_webservice-6.8.1.zip/download PHP-SOAP_webservice-6.8.1.zip]
|
|-
| 6.7.1<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.7/PHP-SOAP_webservice-6.7.1.zip/download PHP-SOAP_webservice-6.7.1.zip]
| Changes in: Search_parametric.php and Folder_workspaces.php
|-
| 6.6.2<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.6/PHP-SOAP_webservice-6.6.2.zip/download PHP-SOAP_webservice-6.6.2.zip]
| New examples: Search_parametric.php and Document_createBinaryWithTemplate.php
|-
| 6.5.2<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.5/PHP-SOAP_webservice-6.5.2.zip/download PHP-SOAP_webservice-6.5.2.zip]
|
|-
| 6.5.1<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.5/PHP-SOAP_webservice-6.5.1.zip/download PHP-SOAP_webservice-6.5.1.zip]
|
|-
| 6.4<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.4/PHP-SOAP_webservice-6.4.zip/download PHP-SOAP_webservice-6.4.zip]<br>
| Of particular interest is the new example Folder_downloadRecursively.php that lets you perform full backup of the repository starting from a given folder
|-
| 6.0<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-6.0/PHP-SOAP_webservice-6.0.zip/download PHP-SOAP_webservice-6.0.zip]<br>
|-
| 5.0/5.1<br>
|5.4.43
| [http://sourceforge.net/projects/logicaldoc/files/samples/samples-5.1/PHP-SOAP_webservice-5.1.zip/download PHP-SOAP_webservice-5.1.zip]
|}

== Python ==
A set of examples in Python to use the new REST APIs available from LogicalDOC since version 7.5<br/>
3.11.4 is the version of Python that we used to create and test the latest scripts.<br/>
These can be run from the command line on Windows: python <SCRIPT_FILENAME><br/>
Be aware that you might have to change the address and port of your LogicalDOC or the login credentials.<br/>
<br>
{| cellspacing="1" cellpadding="1" border="1" style="width: 100%; height: 79px;"
|-
| align="center" | '''LD version'''
| align="center" | '''Download Url'''
| '''Notes'''
|-
| 8.9.1<br>
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-8.9/Python-logicaldoc-webservices-891.zip/download Python-logicaldoc-webservices-891.zip]
| Added Reading Request SOAP and REST examples
| Added listUsers and StoreUser SOAP examples
|-
| 8.7.4<br>
| [https://sourceforge.net/projects/logicaldoc/files/samples/examples-8.7/Python-samples-8.7.4.zip/download Python-samples-8.7.4.zip]
| Added Enterprise Search REST examples
|-
| 8.7.3<br>
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.7/Python-samples-873.zip/download Python-samples-873.zip]
| Interactive Documentation about the RESTful APIs is available at [http://docs.logicaldoc.com/en/web-services-api http://docs.logicaldoc.com/en/web-services-api]
|-
| 8.4.2<br>
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%208.4/Python-samples-842.zip/download Python-samples-842.zip]
| Interactive Documentation about the RESTful APIs is available at [http://docs.logicaldoc.com/en/web-services-api http://docs.logicaldoc.com/en/web-services-api]
|-
| 7.7<br>
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.7/Python-samples-77.zip/download Python-samples-77.zip]
| Interactive Documentation about the RESTful APIs is available at [http://docs.logicaldoc.com/en/web-services-api http://docs.logicaldoc.com/en/web-services-api]
|-
| 7.5/7.5.1<br>
| [https://sourceforge.net/projects/logicaldoc/files/distribution/LogicalDOC%20CE%207.5/Python-samples-751.zip/download Python-samples-751.zip]
| Interactive Documentation about the RESTful APIs is available at [http://wiki.logicaldoc.com/rest/ http://wiki.logicaldoc.com/rest/]
|}

SSL Configuration using Certificate

2024-02-27T15:14:29Z

Blucecio: /* Install PFX certificates */

{{TOCright}} __TOC__

LogicalDOC embeds the Tomcat application server and it can be configured to support the encrypted protocol HTTPS. This is useful when you want to expose the program on the Internet.

{{Advice|<b><u>Please be aware that this procedure is not coverded by the standard support contract</u>.</b> <br/>In case you want this matter to be handled professionally, please write to sales@logicaldoc.com for a quote.}}

Basically you only have to follows the steps described in the Apache how-to at [https://tomcat.apache.org/tomcat-9.0-doc/ssl-howto.html SSL Configuration HOW-TO]
What follows is a re-visioned extract from that how-to

== Preparing the certificates ==
Note: skip this step if you already have your own SSL certificate

To install and configure SSL support on Tomcat, you need the following things:
* The file of your server certificate (the format must be PEM-encoded)
* The file containing the certificate chain associated with the server certificate (the format must be PEM-encoded)
* The file that contains the server private key (the format must be PEM-encoded)

You get those 3 files as a result of the certificate issuing procedure.

Most of the times you server's certificate and the chain file are in .crt, .cer or .der format.
In this case please convert them openssl:<br />
<code>openssl x509 -in cert.crt -out cert.pem</code><br />
<code>openssl x509 -in cert.cer -out cert.pem</code><br />
<code>openssl x509 -in cert.der -out cert.pem</code><br /><br />

In the same way, probably your secret key is in .txt format, so please convert it into .pem using openssl:<br />
<code>openssl rsa -in privkey.txt -out privkey.pem</code><br /><br />

We suggest to put your .pem files in <LDOC_HOME>/conf and in any case outside the tomcat folder.

==Edit the Tomcat configuration file==
The final step is to configure your secure socket in the <LDOC_HOME>/tomcat/conf/server.xml file, where <LDOC_HOME> represents the base directory for the LogicalDOC installation. An example <Connector> element for an SSL connector looks something like this:

<source lang="xml">
<Connector protocol="org.apache.coyote.http11.Http11NioProtocol"
port="8443" maxThreads="200"
URIEncoding="UTF-8" server="Undisclosed/8.41"
scheme="https" secure="true" SSLEnabled="true">
<SSLHostConfig>
<Certificate certificateFile="${catalina.home}/../conf/<b>cert.pem</b>"
certificateKeyFile="${catalina.home}/../conf/<b>privkey.pem</b>"
certificateChainFile="${catalina.home}/../conf/<b>chain.pem</b>" />
</SSLHostConfig>
</Connector>
</source>

<small>replace <LDOC_HOME> with the installation path of LogicalDOC</small>

{{Advice|LogicalDOC application will be updated from time to time so it is not safe to maintain the keystore inside the tomcat/ folder, please put your .pem files inside the conf/ folder of the LogicalDOC installation path.}}

The port attribute (default value is 8443) is the TCP/IP port number on which Tomcat will listen for secure connections. You can change this to any port number you wish.

If you change the port number here, you should also change the value specified for the redirectPort attribute on the non-SSL connector. This allows Tomcat to automatically redirect users who attempt to access a page with a security constraint specifying that SSL is required.

After completing these configuration changes, you must restart LogicalDOC as you normally do, you should be able to access via SSL. For example, try:

https://localhost:8443

and you should see the usual login page.

== Install PFX certificates ==

As regards certificates with the .pfx or .p12 extension, there is no need to convert them, because they are certificate archives already supported by Tomcat.

Modify the value of the Connector attribute in the server.xml file to the following:

<source lang="xml">
<Connector protocol="org.apache.coyote.http11.Http11NioProtocol"
port="8443" maxThreads="200"
URIEncoding="UTF-8" server="Undisclosed"
maxHttpHeaderSize="16384"
scheme="https" secure="true" SSLEnabled="true"
clientAuth="false"
sslProtocol="TLSv1.1+TLSv1.2+TLSv1.3"
keystoreFile="${catalina.home}/../conf/mycert.pfx" # Path of the certificate file
keystoreType="PKCS12"
keystorePass="certpasswd" # Replace the value with the password of your certificate
/>
</source>
Save the file and restart LogicalDOC service/daemon.

Now you can access LogicalDOC pointing your browser to https://YourServerDomain:8443 (ofc replace 'YourServerDomain' with the actual domain of your server).

This procedure works for both certificate files with the .pfx extension and those with the .p12 extension