Difference between revisions of "Direct link"

From OpenKM Documentation
Jump to: navigation, search
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
You can download a document from OpenKM using a command line utility like '''wget'''. Since OpenKM 6.2.1 Community and OpenKM 6.2.5 Professional there is a service with BASIC authentication for this task.
+
You can download a document from OpenKM using a command line utility like '''wget'''. Since OpenKM 6.2.1 Community and OpenKM 6.2.5 Professional there is a service with BASIC authentication for this task. You can reference a document by UUID using the '''uuid''' parameter or by path, using the '''path''' parameter. In the same URL you need to specify the user and password. A good practice is configure the user profile disallowing anything.
Direct link need a '''user''' which have login grants. A good practice is configure the profile of this user to disallow anything.
 
  
 
Available parameters:
 
Available parameters:
* uuid ( the document UUID )
+
* uuid: the document UUID
* path ( the document path )
+
* path: the document path
 +
* inline: boolean. If the document is downloaded as attachment or shown inline.
  
 
Example
 
Example
Line 14: Line 14:
 
   $ wget http://okmAdmin:admin@localhost:8080/OpenKM/Download?uuid=xxx-yyy-zzz
 
   $ wget http://okmAdmin:admin@localhost:8080/OpenKM/Download?uuid=xxx-yyy-zzz
  
You can reference a document by UUID using the '''uuid''' parameter or by path, using the '''path''' parameter. In the same URL you need to specify the user and password.
+
{{Note|If you use parameter path, ia good practice encode url to prevent problems with special characters}}
  
 
[[Category: Utilities]]
 
[[Category: Utilities]]
 
{{Note|If you use path parameter, ia good practice encode url to prevent problems with special characters}}
 

Latest revision as of 12:53, 7 April 2014

You can download a document from OpenKM using a command line utility like wget. Since OpenKM 6.2.1 Community and OpenKM 6.2.5 Professional there is a service with BASIC authentication for this task. You can reference a document by UUID using the uuid parameter or by path, using the path parameter. In the same URL you need to specify the user and password. A good practice is configure the user profile disallowing anything.

Available parameters:

  • uuid: the document UUID
  • path: the document path
  • inline: boolean. If the document is downloaded as attachment or shown inline.

Example

http://user:password@openkm_host/OpenKM/Download?uuid=4ca63b87-e340-443e-aeef-6c7e2fb57aea
http://user:password@openkm_host/OpenKM/Download?path=/okm:root/test/test.doc

This ease some integration tasks:

 $ wget http://okmAdmin:admin@localhost:8080/OpenKM/Download?uuid=xxx-yyy-zzz

Nota clasica.png If you use parameter path, ia good practice encode url to prevent problems with special characters