Difference between revisions of "XML client - OpenKM 5.1"
From OpenKM Documentation
m (moved XML client to XML client - OpenKM 5.1) |
|||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{TOCright}} __TOC__ | {{TOCright}} __TOC__ | ||
| − | You can test the OpenKM webservices API using a tool like [http://www.soapui.org/ soapIU] which can be used to make SOAP request directly using XML. | + | You can test the OpenKM webservices API using a tool like [http://www.soapui.org/ soapIU] which can be used to make SOAP request directly using XML. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== Authentication == | == Authentication == | ||
| Line 172: | Line 165: | ||
</env:Envelope> | </env:Envelope> | ||
</source> | </source> | ||
| + | |||
| + | [[Category: Webservices Guide]] | ||
Latest revision as of 18:34, 1 December 2012
You can test the OpenKM webservices API using a tool like soapIU which can be used to make SOAP request directly using XML.
Authentication
Login
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:end="http://endpoint.ws.openkm.com/">
<soapenv:Header/>
<soapenv:Body>
<end:login>
<arg0>okmAdmin</arg0>
<arg1>admin</arg1>
</end:login>
</soapenv:Body>
</soapenv:Envelope>
Response
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<end:loginResponse xmlns:end="http://endpoint.ws.openkm.com/">
<return>8355455658368037295104824697168</return>
</end:loginResponse>
</env:Body>
</env:Envelope>
Logout
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:end="http://endpoint.ws.openkm.com/">
<soapenv:Header/>
<soapenv:Body>
<end:logout>
<arg0>8355455658368037295104824697168</arg0>
</end:logout>
</soapenv:Body>
</soapenv:Envelope>
Response
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<end:logoutResponse xmlns:end="http://endpoint.ws.openkm.com/"/>
</env:Body>
</env:Envelope>
Documents
List documents
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:end="http://endpoint.ws.openkm.com/">
<soapenv:Header/>
<soapenv:Body>
<end:getChilds>
<arg0>8355455658368037295104875335971</arg0>
<arg1>/okm:root</arg1>
</end:getChilds>
</soapenv:Body>
</soapenv:Envelope>
Response
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<end:getChildsResponse xmlns:end="http://endpoint.ws.openkm.com/">
<return>
<value>
<actualVersion>
<actual>true</actual>
<author>okmAdmin</author>
<comment>this is a comment</comment>
<created>2010-03-07T19:17:58.631+01:00</created>
<name>1.2</name>
<size>80517</size>
</actualVersion>
<author>okmAdmin</author>
<checkedOut>false</checkedOut>
<compactable>false</compactable>
<convertibleToPdf>false</convertibleToPdf>
<convertibleToSwf>true</convertibleToSwf>
<created>2010-03-07T19:17:22.718+01:00</created>
<language/>
<lastModified>2010-03-07T19:17:58.618+01:00</lastModified>
<locked>false</locked>
<mimeType>application/pdf</mimeType>
<notes>
<date>2010-03-07T19:17:44.137+01:00</date>
<text>New version 1.1 by okmAdmin:</text>
<user>system</user>
</notes>
<notes>
<date>2010-03-07T19:17:58.694+01:00</date>
<text>New version 1.2 by okmAdmin: vvvv</text>
<user>system</user>
</notes>
<path>/okm:root/email_forwarding.pdf</path>
<permissions>3</permissions>
<subscribed>false</subscribed>
<training>false</training>
<uuid>057da347-45df-49e7-b497-b84a2107950c</uuid>
</value>
<value>
<actualVersion>
<actual>true</actual>
<author>okmAdmin</author>
<comment/>
<created>2010-03-07T19:19:27.506+01:00</created>
<name>1.0</name>
<size>1456</size>
</actualVersion>
<author>okmAdmin</author>
<checkedOut>false</checkedOut>
<compactable>false</compactable>
<convertibleToPdf>true</convertibleToPdf>
<convertibleToSwf>true</convertibleToSwf>
<created>2010-03-07T19:19:27.465+01:00</created>
<language/>
<lastModified>2010-03-07T19:19:27.469+01:00</lastModified>
<locked>false</locked>
<mimeType>text/plain</mimeType>
<path>/okm:root/Test OpenKM.txt</path>
<permissions>3</permissions>
<subscribed>false</subscribed>
<training>false</training>
<uuid>b47ecc0f-82ef-4e4e-9949-30ae62cc5c98</uuid>
</value>
<value>
<actualVersion>
<actual>true</actual>
<author>okmAdmin</author>
<comment/>
<created>2010-03-07T19:19:58.739+01:00</created>
<name>1.0</name>
<size>77028</size>
</actualVersion>
<author>okmAdmin</author>
<checkedOut>false</checkedOut>
<compactable>false</compactable>
<convertibleToPdf>false</convertibleToPdf>
<convertibleToSwf>false</convertibleToSwf>
<created>2010-03-07T19:19:58.683+01:00</created>
<language/>
<lastModified>2010-03-07T19:19:58.689+01:00</lastModified>
<locked>false</locked>
<mimeType>image/jpeg</mimeType>
<path>/okm:root/some image.jpg</path>
<permissions>3</permissions>
<subscribed>false</subscribed>
<training>false</training>
<uuid>d9af4c08-48e8-45a7-b416-a54ea1626162</uuid>
</value>
</return>
</end:getChildsResponse>
</env:Body>
</env:Envelope>
