RFP Send REST API
Published: 2024-05-15
Resource Name
/rfp/send
POST
Perform the send of MDCMS RFPs to target locations.
An RFP will only be sent if:
- it's application, level, rfp number, target location and impacted projects or tasks match the filter criteria passed in the API request
- the RFP must be open in the RFP Send list
- QTMHHTTP has been granted the right to invoke command MDSNDRFP 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 of the RFP to be sent
tlvl
integer
The maximum application level of the RFP to be sent
frfp
integer
The minimum RFP number
trfp
integer
The maximum RFP number
loc
string
the location to send the RFP to. Either a specific location or:
*ALLDFT - All target locations defined for the RFP's level that have the Default to Send property set to Y=Yes or M=Yes for Manual Send. *ALL - All target locations defined for the RFP's level
locgrp
string
The Location Group to send the RFP to. MDCMS will only send to locations that meet the value for parameter loc and locgrp. Either a specific location group or:
*ALL - The locations to send to aren't limited to a specific group
ftlvl
integer
The minimum target application level
ttlvl
integer
The maximum target application level
merge
string
Specifies if, in the case of multiple RFPs for the same local level, they should be merged into a single RFP before sending. The merge will occur for each level and result in the lowest RFP number for the level being the container for all of the impacted objects.
*NO - each RFP will be sent separately *YES - All RFPs for the same application level will be merged into the lowest RFP so that a single RFP is sent to the target locations for that level.
resend
string
Specifies if an RFP should be sent to a target level, if it has already been sent to that level. If the installation completed for the target level, then the RFP won't be resent.
*NO - a target level will be omitted, if the RFP has already been sent to it *YES - the RFP will be resent to a target level, even if it had been sent before, as long as the installation hasn't completed on the target level.
insdt
string
The date to install the RFP on the target system. Specify the date in format YYYYMMDD. If parameter isn't passed, the current date will be considered the install date.
instm
string
The time of day to install the RFP on the target system. Specify the time in format HHMMSS. If parameter isn't passed, the current time will be considered the install time.
tzone
string
The time zone of the time to install the RFP on the target system.
*TARGET - the installation date/time is based on the time zone of the target system. *LOCAL - the installation date/time is based on the time zone of the local sending system.
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.
batch
string
Specifies if the target levels are part of a batch send, so that a single process will send to several different targets at the same time rather than each one individually. This provides a way to avoid conflicts when trying to send to multiple targets for the same RFP using multiple calls to this resource.
*ONLY - The send should be invoked immediately without batching multiple calls to this command together *FIRST - Any selected targets in this call to MDSNDRFP are to be placed in an initialized batch list per RFP. This should be the value used for the first MDSNDRFP call for a batch. *ADD - Any selected targets in this call to MDSNDRFP will be appended to an existing list per RFP. If the list for a specific RFP doesn't exist yet, it will be started. *LAST - Any selected targets in this call to MDSNDRFP will be appended to an existing list per RFP. If the list for a specific RFP doesn't exist yet, it will be started. The send for the entire batch list per RFP will then be immediately processed. This must be the value used for the last MDSNDRFP call for a batch.
Example:
{ "appl": "TEST", "flvl": "30", "tlvl": "30", "frfp": "1730", "trfp": "1770", "merge": "*yes", "resend": "*yes", "proj": "DEMOUK1" }
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/MDDRSND 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
- rloc - the target location ID
- tlvl - the target level number
Example:
{ "transactionId": "169", "transactions": [ { "appl": "TEST", "lvl": "30", "rfp": "1765", "rloc": "MDDEMO", "tlvl": "30", "sev": "10", "msg": "RFP selected for Send to Target Level" }, { "appl": "TEST", "lvl": "30", "rfp": "1765", "rloc": "SFO", "tlvl": "30", "sev": "10", "msg": "RFP selected for Send to Target Level" } ] }