RESTful Guide with curl - Revision history

Blucecio: /* Sample usage */

2025-10-30T07:59:45Z

Sample usage

← Older revision		Revision as of 07:59, 30 October 2025
Line 20:		Line 20:

	<pre>		<pre>
	[		{
	{		"folder":[
	"id": ~~3440640~~,		{
	"~~name~~": "~~alfa~~",		"attributes":[],
	"~~parentId": 4,~~		"creation":"2025-10-30 08:54:42 +0100",
	~~"description~~": "",		"creator":"Dejah Thoris",
	"~~lastModified~~": "~~2016-06-15 15:49:40 +0200~~",		"description":"",
	"~~type~~": 0,		"hidden":0,
	"~~templateId~~": ~~null~~,		"id":2794107,
	"~~templateLocked": 0,~~		"lastModified":"2025-10-30 08:54:42 +0100",
	~~"creation~~": "~~2016~~-06-~~15 15~~:49:40 +~~0200~~",		"name":"alpha",
	"~~creator~~": "~~Admin Admin~~",		"parentId":4,
	"position": 1,		"position":1,
	"~~hidden~~": 0,		"securityRef":1069,
	"~~foldRef~~": null,		"templateId":null,
	"~~attributes~~": [		"templateLocked":0,
			"type":0
	]		},
	},		{
	{		"attributes":[],
	"id": ~~3440643~~,		"creation":"2025-10-30 08:54:49 +0100",
	"~~name~~": "~~beta~~",		"creator":"Dejah Thoris",
	"~~parentId": 4,~~		"description":"",
	~~"description~~": "",		"hidden":0,
	"~~lastModified~~": "~~2016-06-16 10:16:25 +0200~~",		"id":2794108,
	"~~type~~": 0,		"lastModified":"2025-10-30 08:54:49 +0100",
	"~~templateId~~": ~~null~~,		"name":"beta",
	"~~templateLocked": 0,~~		"parentId":4,
	~~"creation~~": "~~2016~~-06-~~16 09~~:49~~:27~~ +~~0200~~",		"position":1,
	"~~creator~~": "~~Admin Admin~~",		"securityRef":1069,
	"position": 1,		"templateId":null,
	"~~hidden~~": 0,		"templateLocked":0,
	"~~foldRef~~": null,		"type":0
	"~~attributes~~": [		}
			]
	]		}
	}
	]
	</pre>		</pre>

Blucecio: /* Enterprise Searches */

2025-08-22T13:14:54Z

Enterprise Searches

← Older revision		Revision as of 13:14, 22 August 2025
Line 337:		Line 337:
	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
	$ curl -X POST "http://localhost:8080/services/rest/enterpriseSearch/queryDocuments" \		$ 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" \		-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"		-d "select=COUNT(*)&where=DOC.ld_folderid%3D4&maxResults=2000000"
	</syntaxhighlight>		</syntaxhighlight>

Blucecio: /* Enterprise Searches */

2025-08-22T13:14:05Z

Enterprise Searches

← Older revision		Revision as of 13:14, 22 August 2025
Line 337:		Line 337:
	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
	$ curl -X POST "http://localhost:8080/services/rest/enterpriseSearch/queryDocuments" \		$ 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" \		-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"		-d "select=COUNT(*)&where=DOC.ld_folderid%3D4&maxResults=2000000"
	</syntaxhighlight>		</syntaxhighlight>

Blucecio: Added enterpriseSearch example

2025-08-22T13:13:26Z

Added enterpriseSearch example

← Older revision		Revision as of 13:13, 22 August 2025
Line 5:		Line 5:
	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.		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.}}		{{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.		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.
Line 327:		Line 327:
	-F "content=@folder32.png;type=image/png"		-F "content=@folder32.png;type=image/png"
	</syntaxhighlight>		</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:		More info at:

Blucecio: /* Upload Resource */

2025-05-30T09:58:56Z

Upload Resource

← Older revision		Revision as of 09:58, 30 May 2025
Line 316:		Line 316:
	The following example uploads the tile image (suffix: tile.png)		The following example uploads the tile image (suffix: tile.png)

	<~~pre~~>		<syntaxhighlight lang="bash">
	curl -X "POST" ^		curl -X "POST" ^
	"http://localhost:8080/services/rest/document/uploadResource" ^		"http://localhost:8080/services/rest/document/uploadResource" ^
Line 326:		Line 326:
	-F "suffix=tile.png" ^		-F "suffix=tile.png" ^
	-F "content=@folder32.png;type=image/png"		-F "content=@folder32.png;type=image/png"
	</~~pre~~>		</syntaxhighlight>

	More info at:		More info at:

Blucecio: /* Convert a document to PDF */

2025-05-30T09:53:55Z

Convert a document to PDF

← Older revision		Revision as of 09:53, 30 May 2025
Line 259:		Line 259:

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

	Download the converted .PDF file (latest version of the document)		Download the converted .PDF file (latest version of the document)
	<~~pre~~>		<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		$ 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~~>		</syntaxhighlight>

	=== Versioning ===		=== Versioning ===

Blucecio: /* Delete */

2025-05-30T09:53:04Z

Delete

← Older revision		Revision as of 09:53, 30 May 2025
Line 236:		Line 236:
	Delete a specific version of a given document (since v7.6.4)		Delete a specific version of a given document (since v7.6.4)

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

	=== Download ===		=== Download ===

Blucecio: /* Download */

2025-05-30T09:51:12Z

Download

← Older revision		Revision as of 09:51, 30 May 2025
Line 243:		Line 243:
	And now download it:		And now download it:

			<syntaxhighlight lang="bash">
	$ curl -u admin:admin \		$ curl -u admin:admin \
	http://localhost:8080/services/rest/document/getContent?docId=456456456		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		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 \		$ curl -u admin:admin \
	http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf		http://localhost:8080/services/rest/document/getContent?docId=456456456 > myFile.pdf
			</syntaxhighlight>

	=== Convert a document to PDF ===		=== Convert a document to PDF ===

Blucecio: /* Update metadata */

2025-05-30T09:50:41Z

Update metadata

← Older revision		Revision as of 09:50, 30 May 2025
Line 227:		Line 227:
	Update the document metadata. Specifically, we can see how to update an extended attribute field of type date (type = 3) using the property dateValue		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 \		$ 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}] }" \		-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		http://localhost:8080/services/rest/document/update
			</syntaxhighlight>

	=== Delete ===		=== Delete ===

Blucecio: /* Create via Upload */

2025-05-30T09:50:18Z

Create via Upload

← Older revision		Revision as of 09:50, 30 May 2025
Line 213:		Line 213:
	This is a simpler way of creating documents, however it is more limited as it does not allow complete control of the metadata		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" \		$ 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" \		-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"		-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		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		$ 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 metadata ===