Skip to content

RFP Rollback REST API

Published: 2025-06-26

Last Updated: 2026-08-26

Roll back the installation of an entire RFP.

POST /rfp/rollback

Results are returned as a transaction ID plus a list of per-RFP messages.

Preconditions

An RFP is rolled back only when all of the following are true:

  • The application and RFP number in the request body identify an installed RFP.
  • The owner of the authentication token is authorized in MDSEC to run command MDRBRFP.

JSON payloads

All MDCMS REST API request and response bodies use JSON. Send Content-Type: application/json.

Authorization

Header Type Required Description
Authorization string Yes Bearer token for the MDSEC user that performs the rollback. See Authenticate requests to the MDCMS REST API server.
Content-Type string Yes application/json

A missing or invalid token returns HTTP 401 Unauthorized.

Request body

Schema

Property Type Required Description
appl string Yes Application code of the RFP.
rfp integer Yes Number of the previously installed RFP to roll back.
user string No User to register as the installer of the rollback RFP. See Installer.

Installer

Value Description
*INSTALLER The user that originally installed the RFP.
*USER The owner of the authentication token.
(user) A valid user profile defined in MDSEC.

Example

Roll back an installed RFP. Replace {endpoint} with the URL endpoint defined for the MDCMS HTTP server.

{
  "appl": "TEST",
  "rfp": "1767",
  "user": "mmorgan"
}

curl -X POST "https://{endpoint}/rfp/rollback" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"appl":"TEST","rfp":"1767","user":"mmorgan"}'

POST /rfp/rollback HTTP/1.1
Host: {endpoint}
Authorization: Bearer {token}
Content-Type: application/json

{
  "appl": "TEST",
  "rfp": "1767",
  "user": "mmorgan"
}

Response body

Schema

Property Type Description
transactionId integer Transaction ID for this API call. Processed RFPs for this ID are written to table MDCMS/MDDRRFP and can be queried in column MDTRN.
transactions array List of transaction message objects, one per result message.

Transaction object

Each element of transactions has the following properties. appl and rfp are present when the message applies to a specific RFP.

Property Type Description
sev integer Result severity. See Severity.
msg string Message text.
appl string Application of the RFP.
rfp integer RFP number.

Severity

Value Meaning
10 Success
20 Warning
30 Error

Example

{
  "transactionId": "156",
  "transactions": [
    {
      "appl": "TEST",
      "rfp": "1767",
      "sev": "10",
      "msg": "Rollback of TEST/1767 completed using RFP TEST/1768"
    }
  ]
}
Resource Description
RFP Installation REST API Install approved RFPs
Open RFPs REST API List active RFPs for an application and level