Information for Users
- Java Client User Manual (SOAP)
- Java Client User Manual (REST)
- Java Client Javadoc
- Issue Tracking
- Release Notes
Information for Installers
Project Documentation
The ICAT4 API is a layer on top of a relational DBMS. The database is wrapped as a web service so that the tables are not exposed directly.
Most of the information about using the RESTful interface may be found in Javadoc. However to understand it you must first grasp the idea of ICAT by reading about the SOAP based interface . The RESTful interface is currently experimental especially the create, search and get calls.
It is worth emphasing some of the differences. The SOAP interface wraps the IcatException in an IcatException_Exception whereas the RESTful interface throws IcatExceptions directly. The RESTful interface provides a Session object which is more convenient than passing sessionId to every call.
Installation and accessing from Maven is explained in Java Client Installation.