Skip to content

RFP Approval REST API

Published: 2024-05-15

Resource Name

/rfp/approve

POST

Approve an MDCMS RFP for Installation

An RFP will only be approved if:

  • it's application, level, rfp number, and impacted projects or tasks match the filter criteria passed in the API request
  • it is currently in status 02 - Waiting for Approval
  • QTMHHTTP has been granted the right to invoke command MDAPRRFP in MDSEC

Request

Path parameters

none

Body parameters

appl

string

Filter the RFP candidate list to those for the provided MDCMS application

rfp  

integer

Update a specific RFP of the given number

rfpt

string

The type of specific RFP number passed in parameter RFP

*CURRENT - the current number for an RFP *FROM - the RFP number refers to the RFP installed into the prior level *ORIG - each RFP to be updated originated from the specified RFP number, which was installed into the initial level for a chain of migrations across systems.

flvl  

integer

The minimum application level for the approval

tlvl  

integer

The maximum application level for the approval

frfp  

integer

The minimum RFP number for the approval

trfp  

integer

The maximum RFP number for the approval

proj  

string

Specifies the Project that must be assigned to one or more of the objects in an RFP for that RFP to be considered. task  

integer

Specifies the Project Task that must be assigned to one or more of the objects in an RFP for that RFP to be considered.

stsk  

integer

Specifies the Project Subtask that must be assigned to one or more of the objects in an RFP for that RFP to be considered.

pipeline

string

The 10-character ID of a Pipeline server defined in MDOpen. This will be used for downstream update messages to the server using the MDUPDPIPE command.

traceKey

string

A unique key to identify the pipeline build that MDCMS should communicate with. This will be used for downstream update messages to the server using the MDUPDPIPE command.

Example:

{ "proj": "demouk1", "task": "1", "stsk": "1" }

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/MDDARFP 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
  • lvl - the application level of the rfp, if message for a specific rfp
  • rfp - the rfp number, if message for a specific rfp

Example:

{
   "transactionId": "162",
   "transactions": [   {
      "appl": "TEST",
      "lvl": "30",
      "rfp": "1769",
      "sev": "10",
      "msg": "RFP TEST/1769 successfully approved"
   }]
}