RFP Installation REST API
Published: 2024-05-15
Resource Name
/rfp/install
POST
Perform the installation (application update) phase of MDCMS RFPs.
An RFP will only be installed if:
- it's application, level, rfp number, and impacted projects or tasks match the filter criteria passed in the API request
- the submit, approve and MDRapid phases for the RFP are complete so that installation is pending.
- QTMHHTTP has been granted the right to invoke command MDINSRFP in MDSEC
Request
Path parameters
none
Body parameters
appl
string
Filter the RFP candidate list to those for the provided MDCMS application
flvl
integer
The minimum application level that the RFP is targeting
tlvl
integer
The maximum application level that the RFP is targeting
frfp
integer
The minimum RFP number for installation
trfp
integer
The maximum RFP number for installation
pend
string
*YES - RFPs in status 03 or IP will be considered *NO - Only RFPs in status 03 will be considered *ONLY - Only RFPs in status IP will be considered
schdt
string
If pending RFPs are considered, only process those with a maximum scheduled install date of a given value. Specify the date in format YYYYMMDD. If parameter isn't passed, the current date will be considered the maximum.
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.
user
string
The user to apply to the RFP as the installer of the RFP.
*APPROVER - The user that is registered as having approved the RFP for installation is also registered as the installer *USER - the current user of the job (typically QTMHHTTP)
or enter a valid user profile that is defined in MDSEC
Example:
{ "appl": "TEST", "flvl": "30", "tlvl": "30", "proj": "DEMOUK1", "task": "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/MDDIRFP 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: