Accessing Caché Source Code Files Using REST
Introduction to the Caché Source Code File REST API
[Home] [Back] [Next]
InterSystems: The power behind what matters   

This REST API provides access to Caché source code files. We developed this API to allow Atelier, our Eclipse-based IDE, to access Caché class definitions, routines, and CSP files on a Caché server. You can use the API to perform the actions needed to access Caché classes, routines, and CSP files. These actions include:

These actions provide the mechanisms to access Caché source code files. In order to create a Caché development environment, you should understand this API and have a comprehensive understanding of how the Caché source code files are used within Caché.
This is a special-purpose API. If you are creating a development environment or working on a similar application, such as a class browser, you may find this API useful. But, it is not a general-purpose REST API to access Caché objects.
If you want information about downloading Atelier and about using Atelier to develop Caché applications, see, the Atelier home page, which provides links to downloading instructions and to the Atelier documentation.
This document describes versions 1 and 2 of the Caché Source Code File REST API. Version 1 was first provided by Caché 2016.2 and version 2 by Caché 2017.2. Future releases of Caché may support higher versions of this REST API that provide additional calls, but you will always be able to call the earlier versions. The APIs for version 1 include /v1/ in the URL and the APIs for version 2 include /v2/. You can find out the version of this API that is provided by Caché by calling the GetServer method.
The following describes the major capabilities of the API and the methods that provide them:

Send us comments on this page
Copyright © 1997-2019 InterSystems Corporation, Cambridge, MA