Home Applications iris-rest-api-template


Supported by InterSystems Corporation
2 reviews
IPM installs
Pull requests
The simplest template with REST CRUD for InterSystems IRIS

What's new in this version

Dockerfile simplified
Swagger link is added
Extensions recommendations added


Quality Gate Status
GitHub last commit

This is a template of a REST API application built with ObjectScript in InterSystems IRIS.
It also has OPEN API spec,
can be developed with Docker and VSCode,
can ve deployed as ZPM module.


Make sure you have git and Docker desktop installed.

Installation with ZPM

zpm:USER>install rest-api-template

Installation for development

Create your repository from template.

Clone/git pull the repo into any local directory e.g. like it is shown below (here I show all the examples related to this repository, but I assume you have your own derived from the template):

$ git clone git@github.com:intersystems-community/iris-rest-api-template.git

Open the terminal in this directory and run:

$ docker-compose up -d --build

or open the folder in VSCode and do the following:

How to Work With it

This template creates /crud REST web-application on IRIS which implements 4 types of communication: GET, POST, PUT and DELETE aka CRUD operations.
These interface works with a sample persistent class dc.Sample.Person.

Open http://localhost:52773/swagger-ui/index.html to test the REST API

Testing GET requests

To test GET you need to have some data. You can create it with POST request (see below), or you can create some fake testing data. to do that open IRIS terminal or web terminal on /localhost:52773/terminal/ and call:

USER>do ##class(dc.Sample.Person).AddTestData(10)

This will create 10 random records in dc.Sample.Person class.

You can get swagger Open API 2.0 documentation on:


This REST API exposes two GET requests: all the data and one record.
To get all the data in JSON call:


To request the data for a particular record provide the id in GET request like ‘localhost:52773/crud/persons/id’ . E.g.:


This will return JSON data for the person with ID=1, something like that:

{"Name":"Elon Mask","Title":"CEO","Company":"Tesla","Phone":"123-123-1233","DOB":"1982-01-19"}

Testing POST request

Create a POST request e.g. in Postman with raw data in JSON. e.g.

{"Name":"Elon Mask","Title":"CEO","Company":"Tesla","Phone":"123-123-1233","DOB":"1982-01-19"}

Adjust the authorisation if needed - it is basic for container with default login and password for IRIR Community edition container

and send the POST request to localhost:52773/crud/persons/

This will create a record in dc.Sample.Person class of IRIS.

Testing PUT request

PUT request could be used to update the records. This needs to send the similar JSON as in POST request above supplying the id of the updated record in URL.
E.g. we want to change the record with id=5. Prepare in Postman the JSON in raw like following:

{"Name":"Jeff Besos","Title":"CEO","Company":"Amazon","Phone":"123-123-1233","DOB":"1982-01-19"}

and send the put request to:


Testing DELETE request

For delete request this REST API expects only the id of the record to delete. E.g. if the id=5 the following DELETE call will delete the record:


How to start coding

This repository is ready to code in VSCode with ObjectScript plugin.
Install VSCode and ObjectScript plugin and open the folder in VSCode.
Open /src/cls/PackageSample/ObjectScript.cls class and try to make changes - it will be compiled in running IRIS docker container.

Feel free to delete PackageSample folder and place your ObjectScript classes in a form

The script in Installer.cls will import everything you place under /src/cls into IRIS.

What’s insde the repo


The simplest dockerfile to start IRIS and load ObjectScript from /src/cls folder
Use the related docker-compose.yml to easily setup additional parametes like port number and where you map keys and host folders.


Settings file to let you immedietly code in VSCode with VSCode ObjectScript plugin)


Config file if you want to debug with VSCode ObjectScript

Made with
zpm install rest-api-template download archive
1.1.022 May, 2023
ObjectScript quality test
Works with
InterSystems IRISInterSystems IRIS for Health
First published
02 Oct, 2019
Last checked by moderator
27 Jun, 2023Works