Skip to content

RFP Rollback REST API

Published: 2024-05-15

Resource Name

/rfp/rollback

POST

Perform the rollback of an installation of an entire RFP.

An RFP will only be rolled back if:

  • the passed application and rfp number are for an installed RFP
  • QTMHHTTP has been granted the right to invoke command MDRBRFP in MDSEC

Request

Path parameters

none

Body parameters

appl  required

string

The application code of the RFP

rfp   required  

integer

The number of the previously installed RFP to be rolled back

user

string

The user to apply to the RFP as the installer of the rollback RFP.

*INSTALLER - The user that originally installed the RFP *USER - the current user of the job (typically QTMHHTTP)

or enter a valid user profile that is defined in MDSEC

Example:

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

Response

Body parameters

The response provides a structure with the following parameters:

transactionId  

integer

The transaction ID for the API call. All processed RFPs for the transaction ID are written to table MDCMS/MDDRRFP and can be queried with the ID value in column MDTRN.

transactions

array

A list of transaction message objects. Each object contains:

  • sev - severity 10=ok, 20=warning and 30=error
  • msg - the message text
  • appl - the application of the rfp, if message for a specific rfp
  • rfp - the rfp number, if message for a specific rfp

Example:

{
   "transactionId": "156",
   "transactions": [   {
      "appl": "TEST",
      "rfp": "1767",
      "sev": "10",
      "msg": "Rollback of TEST/1767 completed using RFP TEST/1768"
   }]
}