RESTful Guide with curl
Contents |
 |
If you're interested in use LogicalDOC API we suggest to take a look at ours Bindings and Samples and take advantage of already usable examples which connect to webservices API. |
LogicalDOC has a 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.
 |
Examples in this page refer to LogicalDOC 7.5.1; the REST API is currently in development, so expect changes and additions. |
If you point your browser to http://localhost:8080/logicaldoc/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/logicaldoc/services/rest/folder/listChildren?folderId=4
The result is:
[
{
"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": [
]
}
]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/logicaldoc/services/rest/folder/listChildren?folderId=4
The result in XML is:
<?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>This is a Java client for the same call:
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/logicaldoc/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();
}
}
}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/logicaldoc/services/rest/folder/createSimple
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/logicaldoc/services/rest/document/upload
Or also from a HTML form:
<html>
<body>
<form method="POST" enctype="multipart/form-data"
action="http://localhost:8080/logicaldoc/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>And now download it:
$ curl -u admin:admin \ http://localhost:8080/logicaldoc/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/logicaldoc/services/rest/document/getContent?docId=456456456 > myFile.pdf
Search
Search simply by content:
$ curl -u admin:admin -H "Accept: application/json" -X GET \ http://localhost:8080/logicaldoc/services/rest/search/findByContent?content=santo+grial
Search by keyword:
$ curl -u admin:admin -H "Accept: application/json" -X GET \ http://localhost:8080/logicaldoc/services/rest/search/findByKeywords?keyword=santo\&keyword=grial
Or use a more customized search parameters:
$ curl -u admin:admin -H "Accept: application/json" -X GET \ http://localhost:8080/logicaldoc/services/rest/search/find?content=grial\&mimeType=application/pdf
Even can query by Property Groups:
$ curl -u admin:admin -H "Accept: application/json" -X GET \ http://localhost:8080/logicaldoc/services/rest/search/find?content=grial\&property='okp:name=alfa'
More info at:
