Skip to end of metadata
Go to start of metadata
This page is for


The web services of the KIM Application Programming Interface (API) represent an interoperability layer for accessing the server functionality. They allow web access and language-independence. KIM users have successfully implemented clients in C#, Perl, Ruby and, of course, Java. All other languages with stable and mature SOAP implementation also work well.

The web service API consists of five services:

  • Semantic Repository API web service – for querying and modifying the underlying semantic repository.
  • Document Repository API web service – for querying, retrieving and modifying the stored documents. Support for CORE queries is provided as well.
  • Semantic Annotation API web service – for annotating documents
  • Entity API web service – contains methods that serve as an abstraction layer over the semantic repository and allow direct manipulations with entities.
  • Query API web service – contains methods that serve as an abstraction layer over the semantic and document repositories and allow combined queries.

The web services are packaged and ready for deployment on a servlet container like Apache Tomcat 6.x .

The web services are designed to be compliant to the SOAP 1.2 standard. They also conform to the WS-IBasic Profile 1.0 specification. This is the only specification supported by the Microsoft.NET framework 1.1 and is a must for satisfactory interoperability with such clients. The web services are developed with Apache Axis 1.4, which is certified by the W3C web service implementation.

By default, the web services expect that the KIM Server is running on localhost:1099. See the configuration instructions for details.

Web Services and APIs

These are Services, and their related APIs, that are available as a shared service on the KIM architecture.

Data Structures

Response objects' components

How to run the examples
The web services APIs descriptions are accompanied by examples written in Java and the Apache Axis 1.4 web service client library. If you follow them, add Axis and its dependencies to the class-path in order to run the examples. Maven users should use the dependencies available at the public repository . For more information on developing web service clients, see the Axis documentation.
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.