Listing and Documenting REST APIs

Discovering REST Services

To use the /api/mgmnt service to discover the REST services that are available on an instance, use the following REST call:

• For the HTTP action, select or specify GET.

• For the URL, specify a URL of the following form:

  http://localhost:52773/api/mgmnt/v2/

  Or, if you want to examine only one namespace:

  http://localhost:52773/api/mgmnt/v2/:namespace

  Where localhost is the name of the server, 52773 is the web server port that InterSystems IRIS is using, and namespace is the namespace you want to examine.

(Note that these calls ignore manually-coded REST services. To discover manually-coded REST applications, use the calls GET /api/mgmnt/ and GET /api/mgmnt/:v1/:namespace/restapps.)

If the call is successful, InterSystems IRIS returns an array that lists the REST services, in JSON format. For example:

[
  {
    "name": "%Api.Mgmnt.v2",
    "webApplications": "/api/mgmnt",
    "dispatchClass": "%Api.Mgmnt.v2.disp",
    "namespace": "%SYS",
    "swaggerSpec": "/api/mgmnt/v2/%25SYS/%Api.Mgmnt.v2"
  },
  {
    "name": "myapp",
    "webApplications": "/api/myapp",
    "dispatchClass": "myapp.disp",
    "namespace": "USER",
    "swaggerSpec": "/api/mgmnt/v2/USER/myapp"
  }
]

Discovering REST-Enabled Web Applications

To use the /api/mgmnt service to discover the REST-enabled web applications that are available on an instance, use the following REST call:

• For the HTTP action, select or specify GET.

• For the URL, specify a URL of the following form:

  http://localhost:52773/api/mgmnt

  Or, if you want to examine only one namespace:

  http://localhost:52773/api/mgmnt/v1/:namespace/restapps

  Where localhost is the name of the server, 52773 is the web server port that InterSystems IRIS is using, and namespace is the namespace you want to examine.

See the reference sections for GET /api/mgmnt/ and GET /api/mgmnt/:v1/:namespace/restapps.

Discovering REST Service Classes

To use the %REST.APIOpens in a new tab class to discover the REST services that are available on an instance, use the following methods of that class:

GetAllRESTApps()

GetAllRESTApps(Output appList As %ListOfObjects) as %Status

Returns, as output, a list of the REST services on this server. The output argument applist is an instance of %ListOfObjectsOpens in a new tab, and each item in the list is an instance of %REST.ApplicationOpens in a new tab that contains information about the REST service. This includes any REST services that do not have an associated web application. This method ignores any manually-coded REST services.

GetRESTApps()

GetRESTApps(namespace as %String,
            Output appList As %ListOfObjects) as %Status

Returns, as output, a list of the REST services in the namespace indicated by namepace. See GetAllWebRESTApps(). See GetAllRESTApps().

Discovering REST-Enabled Web Applications

To use the %REST.APIOpens in a new tab class to discover the REST-enabled web applications that are available on an instance, use the following methods of that class:

GetAllWebRESTApps()

GetAllWebRESTApps(Output appList As %ListOfObjects) as %Status

Returns, as output, a list of the REST-enabled web applications on this server. The output argument applist is an instance of %ListOfObjectsOpens in a new tab, and each item in the list is an instance of %REST.ApplicationOpens in a new tab that contains information about web application.

GetWebRESTApps()

GetWebRESTApps(namespace as %String,
               Output appList As %ListOfObjects) as %Status

Returns, as output, a list of the REST-enabled web applications in the namespace indicated by namepace. See GetAllWebRESTApps().