Object Request REST API

Published: 2025-06-26

Last Updated: 2026-08-26

Create an object request (check-out) in MDCMS.

POST /object-request

The request body is JSON. For *IFS or *REMOTE objects, you can also attach a file in a multipart/mixed request. See File attachments.

Preconditions

• The owner of the authentication token is authorized in MDSEC to run command MDADDREQ.

Authorization

A missing or invalid token returns HTTP 401 Unauthorized.

Request body

Schema

Reason

Copy

Assign RFP

Continue requests

Assign next-level requests

Data origin

Data members

MDRapid

Reapply options

Used by rjrn, rcst, rtrg, and rlfm.

Example

Create an object request and assign it to an RFP. Replace {endpoint} with the URL endpoint defined for the MDCMS HTTP server.

{
  "appl": "TEST",
  "lvl": "10",
  "objt": "*PGM",
  "attr": "SQLRPGLE",
  "objn": "MYNEWPGM",
  "user": "MMORGAN",
  "rsn": "*migrate",
  "folb": "MMORGAN13",
  "fsfl": "QRPGLESRC",
  "proj": "DEMOCH",
  "task": "2",
  "stsk": "3",
  "arfp": "*YES",
  "rfp": "1709",
  "vref": "ep1234"
}

curl -X POST "https://{endpoint}/object-request" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"appl":"TEST","lvl":"10","objt":"*PGM","attr":"SQLRPGLE","objn":"MYNEWPGM","user":"MMORGAN","rsn":"*migrate","folb":"MMORGAN13","fsfl":"QRPGLESRC","proj":"DEMOCH","task":"2","stsk":"3","arfp":"*YES","rfp":"1709","vref":"ep1234"}'

POST /object-request HTTP/1.1
Host: {endpoint}
Authorization: Bearer {token}
Content-Type: application/json

{
  "appl": "TEST",
  "lvl": "10",
  "objt": "*PGM",
  "attr": "SQLRPGLE",
  "objn": "MYNEWPGM",
  "user": "MMORGAN",
  "rsn": "*migrate",
  "folb": "MMORGAN13",
  "fsfl": "QRPGLESRC",
  "proj": "DEMOCH",
  "task": "2",
  "stsk": "3",
  "arfp": "*YES",
  "rfp": "1709",
  "vref": "ep1234"
}

File attachments

If the object is of type *IFS or *REMOTE and the POST includes an attached file of the same name as objn, the file is copied to the path in folb for eventual deployment on an RFP.

If the source file is of type *IFS and the POST includes an attached file of the same name as srcn, the file is copied to the path in fslb.

Use Content-Type: multipart/mixed with a JSON payload part and a file part.

Example: request without attachment

curl -v -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}" \
  -d '{"appl":"GITAPT","lvl":"100","objt":"*IFS","attr":"JAVA-APP","rsn":"*MIGRATE","folb":"/gitapt/java-app/staging","objn":"java-app-1.0-SNAPSHOT.jar"}' \
  "https://{endpoint}/object-request"

Example: loop through files to request and upload

## set current directory to target
cd target

## place list of jar files into array variable
jarFiles=($(ls *.jar))

## loop through array and create MDChange object request for each jar file
for jarFile in "${jarFiles[@]}"
do
  curl -v -H "Content-Type: multipart/mixed" \
    -H "Authorization: Bearer $1" \
    -F 'payload={"appl":"GITAPT","lvl":"100","objt":"*IFS","attr":"JAVA-APP","rsn":"*MIGRATE","folb":"/gitapt/java-app/staging","objn":"'"$jarFile"'","proj":"JAVA-APP","arfp":"*AUTO","rfpd":"java-app deployment for build number '"$3"'"};type=application/json' \
    -F "file=@$jarFile" \
    "$2/object-request"
done

Where:

• $1 is the authorization token
• $2 is the URL of the MDCMS REST API server
• $3 is the pipeline build number invoking the shell

Example pipeline YAML step:

- step:
    name: post to MDChange
    script:
    - sh ./request-object.sh $MD_TOKEN $MD_URL $BITBUCKET_BUILD_NUMBER

Response body

The response provides a rtn object.

Schema

Result object

Severity

Example

{
  "rtn": {
    "sev": "10",
    "msg": "Request created for MYNEWPGM into RFP 1709"
  }
}

Related resources