Skip to content

RFP Acceptance REST API

Published: 2024-05-15

Resource Name

/rfp/acceptance

POST

Update the MDWorkflow Test Status for Project(s) in installed MDCMS RFPs.

Optionally confirm the final Test Status for the RFPs too, if the status has provisionally been set for all projects in the RFP.

An RFP will only be updated if:

  • it's application, level, rfp number, and impacted projects or tasks match the filter criteria passed in the API request
  • it is already completely installed and has an "ongoing" test status
  • QTMHHTTP has been granted the right to invoke command MDWFARFP in MDSEC

Request

Path parameters

none

Body parameters

grp  Required

string

The User Group ID of the user to update the Workflow test status for RFPs. The group must be an involved acceptance group for the project(s) impacted by the RFPs to accept/reject.

user  

string

The specific user in the Group to attribute the acceptance status to

*USER - the user id of the job will be used (typically QTMHHTTP)

act 

string

The action to carry out for each qualified project in each qualified RFP, based on the passed parameter values.

*ACCEPT - Set the test status to accepted *REJECT - Set the test status to rejected *INPROG - Set the test status to In Progress *UNDO - Reset the provisional test status

cmnt 

string

A comment to apply to the status update for informational purposes

conf 

string

Whether or not to set the RFP test status to confirmed, if all impacted projects for the RFP have been provisionally accepted or if at least one of the impacted projects for the RFP has been provisionally rejected.

*NO - Only set the provisional status. Final confirmation will occur later. *YES - Set the RFP test status to confirmed and carry out any post-confirmation steps.

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 test status update

tlvl  

integer

The maximum application level for the test status update

frfp  

integer

The minimum RFP number for the test status update

trfp  

integer

The maximum RFP number for the test status update

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. If a value isn't passed for this parameter, then the RFPs won't be filtered by a project and the test status for all projects in the RFP will be updated. If included, the RFP must impact the Project and the test status will only be applied to that project.

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:

{ "grp": "TESTER1", "user": "USER1", "act": "*ACCEPT", "conf": "*YES", "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/MDDWFAR 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
  • proj - the project for which the test status was updated, if message for a specific project impacted by the rfp

Example:

{
   "transactionId": "149",
   "transactions":    [
            {
         "appl": "TEST",
         "lvl": "30",
         "rfp": "1765",
         "proj": "DEMOUK1",
         "sev": "10",
         "msg": "Test Status for Project in RFP updated"
      },
            {
         "appl": "TEST",
         "lvl": "30",
         "rfp": "1765",
         "sev": "10",
         "msg": "RFP Confirmed as Accepted"
      },
            {
         "appl": "TEST",
         "lvl": "30",
         "rfp": "1766",
         "proj": "DEMOUK1",
         "sev": "10",
         "msg": "Test Status for Project in RFP updated"
      },
            {
         "appl": "TEST",
         "lvl": "30",
         "rfp": "1766",
         "sev": "10",
         "msg": "RFP Confirmed as Accepted"
      }
   ]
}