Skip to content

MDChange REST API

MDCMS REST API Documentation - Midrange Dynamics.

Version 8.6

Published May 9, 2024

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)

  1. Defined URL Endpoint in MDCMS from Interfaces setup. e.g. devbox.mycompany.com/mdcmstest

  2. Resource-name from API Catalogue below. e.g. /applications

For example: https://devbox.mycompany.com/mdcmstest/applications

Select from the following sections:

MDChange REST API Catalogue A catalogue of MDChange REST APIs and their attributes.
Configure the MDChange REST API 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.

Info

You can download a PDF version of this guide here.

REST API Catalogue
Applications REST API
Attributes REST API
Levels REST API
Level Wildcard REST API
MDSEC User REST API
Object Request REST API
Open Projects REST API
Open RFPs REST API
Open Subtasks REST API
Open Tasks REST API
Pipeline Request Trigger REST API
Project REST API
RFP Acceptance REST API
RFP Approval REST API
RFP Installation REST API
RFP Rollback REST API
RFP Send REST API
RFP Submission REST API
Task REST API