Skip to content

Open RFPs REST API

Published: 2024-05-15

Return all active RFPs in MDCMS for a specific application and level.

GET /open-rfps

JSON payloads

All MDCMS REST API response bodies use JSON.

Authorization

Header Type Required Description
Authorization string Yes Bearer token for the MDSEC user. See Authenticate requests to the MDCMS REST API server.

A missing or invalid token returns HTTP 401 Unauthorized.

Query parameters

Parameter Type Required Description
appl string Yes Application code that contains the RFPs to list.
lvl integer Yes Application level that contains the RFPs to list.
user string No Limit the list to RFPs owned by this user.

Example

Replace {endpoint} with the URL endpoint defined for the MDCMS HTTP server.

curl -H "Authorization: Bearer {token}" \
  "https://{endpoint}/open-rfps?appl=TEST&lvl=10&user=MMORGAN"

GET /open-rfps?appl=TEST&lvl=10&user=MMORGAN HTTP/1.1
Host: {endpoint}
Authorization: Bearer {token}

Response body

Schema

Property Type Description
rfps array List of RFP objects.

RFP object

Property Type Description
appl string Application code.
lvl integer Application level.
rfp integer RFP number.
user string User that owns the RFP.
desc string RFP description.

Example

{
  "rfps": [
    {
      "appl": "TEST",
      "lvl": "10",
      "rfp": "1340",
      "user": "MMORGAN",
      "desc": "Git contents of a Tag"
    },
    {
      "appl": "TEST",
      "lvl": "10",
      "rfp": "1605",
      "user": "MMORGAN",
      "desc": "test mdlmövo"
    },
    {
      "appl": "TEST",
      "lvl": "10",
      "rfp": "1731",
      "user": "MMORGAN",
      "desc": "8.2 demo"
    }
  ]
}
Resource Description
RFP Submission REST API Submit RFPs for verification and compile
RFP Approval REST API Approve RFPs for installation
Object Request REST API Create an object request and optionally assign it to an RFP