Getting Information about the Server

Typically, the first REST call you’ll make is to the GetServer method, which returns information about the InterSystems API version number and the namespaces available on the server.

GET https://devsys:52773/api/atelier/

This call returns the following JSON message:

{
  "status": {
    "errors": [],
    "summary": ""
  },
  "console": [],
  "result": {
    "content": {
      "version": "IRIS for Windows (x86-64) 2018.1.1 (Build 515U) Mon Feb 5 2018 08:24:13 EST",
      "id": "98E1697E-13F9-4D6A-8B73-827873D1D61C",
      "api": 2,
      "features": [
...
      ],
      "namespaces": [
        "%SYS",
        "USER"
      ]
    }
    }
}

All the methods that return JSON messages use the same general format:

status errors—typically the InterSystems IRIS Source Code File REST API returns errors as HTTP status codes. This field is used under some unusual conditions and this element contains the InterSystems IRIS %Status value, which may contain the text for multiple errors.
status summary—contains a summary of the status errors.
console—contains the text that InterSystems IRIS would display on the console for this operation.
result—contains the results of the method.

The GetServer method returns information about the server in the “result” element. The result element contains one value “content”, which contains:

version—contains the version string of the instance of InterSystems IRIS running on the server.
id—contains the instance GUID of InterSystems IRIS.
api—specifies the version number of the InterSystems IRIS Source Code File REST API implemented in this version of InterSystems IRIS.
features—indicates the features that are enabled on this instance.
namespaces—lists the namespaces defined on the InterSystems IRIS server.

The GetNamespace method returns information about the specified namespace, including the databases that are mapped to the namespace and a hash for each database. The hash is useful for improving efficiency of communication with the server. But you can get the information about the source code files in the namespace with just the namespace information returned by GetServer.

Getting the Source Code in a Namespace

API Basics