RFP Dependencies REST API
Published: 2026-10-01
Last Updated: 2026-10-01
Add object dependencies to an MDCMS RFP that is open for object requests. A recompile request will be added to the RFP for each missing impacted object that depends on one of the following objects already in the RFP:
- a file, including tables, indexes, views, display and printer files
- a source copybook
- an ILE module
The request body identifies the application and RFP. MDCMS adds the current dependencies for that RFP. Results are returned as a severity and a message.
Preconditions
Dependencies are added only when all of the following are true:
- The application and RFP number in the request body identify an RFP defined for that application.
- The RFP status is 01 – Requests Assigned.
JSON payloads
All MDCMS REST API request and response bodies use JSON. Send Content-Type: application/json.
Authorization
| Header | Type | Required | Description |
|---|---|---|---|
Authorization | string | Yes | Bearer token for the MDSEC user that adds the dependencies. See Authenticate requests to the MDCMS REST API server. |
Content-Type | string | Yes | application/json |
A missing or invalid token returns HTTP 401 Unauthorized.
Request body
Schema
| Property | Type | Required | Description |
|---|---|---|---|
appl | string | Yes | Application code of the RFP. |
rfp | integer | Yes | RFP number. Must be greater than zero. |
clearExisting | boolean | No | When true, delete existing dependency requests for this RFP before adding the current dependencies. Those requests are in status 01 – Requests Assigned with reason Recompile. Defaults to false. Values Y, YES, and 1 are also treated as true. |
If appl is blank or rfp is not greater than zero, the API returns HTTP 400 with the message appl and rfp are required.
Example
Add dependencies for an RFP and replace any dependency requests already on it. Replace {endpoint} with the URL endpoint defined for the MDCMS HTTP server.
Response body
Schema
| Property | Type | Description |
|---|---|---|
sev | string | Result severity. See Severity. |
msg | string | Message text. |
Severity
| Value | Meaning |
|---|---|
10 | Success. msg reports how many dependencies were added, for example 1 dependency added to RFP or 3 dependencies added to RFP. |
30 | Error. The RFP is not defined for the application, or it is not in status 01 – Requests Assigned. |
Example
Related resources
| Resource | Description |
|---|---|
| Object Request REST API | Add or update an object request |
| Object Requests REST API | List or delete object requests |
| Open RFPs REST API | List active RFPs for an application and level |
| RFP Submission REST API | Submit RFPs for verification and compile |