MDChange REST API
MDCMS REST API Documentation - Midrange Dynamics.
Version 8.6
Published June 26, 2025
Overview
In the API Catalogue below, there is a list of all REST API Resources currently published in an active version of MDCMS.
For each resource, each valid method (GET, POST, PUT, DELETE) for the resource is described along with a list of parameters, example request, and example response.
All payloads for MDCMS APIs must be in JSON format.
URI Formats
The URIs for resources always have the following structure:
https://[Defined URL Endpoint in MDCMS](1)/ [resource-name](2)
-
Defined URL Endpoint in MDCMS from Interfaces setup. e.g.
devbox.mycompany.com/mdcmstest
-
Resource-name from API Catalogue below. e.g.
/applications
For example: https://devbox.mycompany.com/mdcmstest/applications
Select from the following sections:
| Configure the MDChange HTTP Server | Configure the HTTP server for REST APIs |
| Authenticate Requests to the MDChange REST API Server | How to create and use an authentication token used by the MDChange REST APIs |
| Setup SSL on IBM i | Before an HTTP Server Instance can be HTTPS enabled, TLS/SSL must first be configured for the whole IBM i server. |
| Setup Reverse Proxy HTTP Server | Before an HTTP Server Instance can be HTTPS enabled, TLS/SSL must first be configured for the whole IBM i server. |
| MDCMS/MDOPEN Connectivity Troubleshooting | Guide providing tips to troubleshoot connectivity with the APIs |
| SSL TLS Error Codes on IBM i | List of SSL/TLS error codes |
Info
You can download a PDF version of this guide here.