Object Request REST API

Published: 2025-06-26

Last Updated: 2026-09-15

Create or update an object request (check-out) in MDCMS. Optionally associate the request with a Git repository, path, file, and branch. Optionally attach a file to the request.

Authorization

A missing or invalid token returns HTTP 401 Unauthorized.

POST

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

POST /object-request

The request body is JSON. When requesting for *MIGRATE you can also attach a file in a multipart/mixed request. The file will be used as the object for *IFS or *REMOTE object types, or used as the source for object types created from source (IFS or member). See File attachments.

Preconditions

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

Request body

Schema

Reason

Copy

Git

Pass repo and branch to associate the object request with a Git repository defined in MDCMS. See Git Repositories REST API.

When repo and branch are set, MDCMS stores the request as repository type *GIT.

If attr is omitted, MDCMS determines the attribute from Git repository attribute mapping using repo, gpath, and gfile. If mapping does not resolve an attribute, the request fails with MDCMS Attribute missing.

If objt is omitted, MDCMS determines the object type from Git repository attribute mapping, installation history, and MDXREF. If the type still cannot be resolved, the request fails with Object Type missing.

If proj is *BRANCH, MDCMS sets proj, task, and stsk from the project that is linked to branch. repo and branch are required.

Project

Assign RFP

RFP description

Used only when arfp is *AUTO or *NEW.

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",
  "objn": "MYNEWPGM",
  "objt": "*PGM",
  "attr": "SQLRPGLE",
  "srca": "SQLRPGLE",
  "srcd": "Demo program",
  "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","objn":"MYNEWPGM","objt":"*PGM","attr":"SQLRPGLE","srca":"SQLRPGLE","srcd":"Demo program","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",
  "objn": "MYNEWPGM",
  "objt": "*PGM",
  "attr": "SQLRPGLE",
  "srca": "SQLRPGLE",
  "srcd": "Demo program",
  "user": "MMORGAN",
  "rsn": "*migrate",
  "folb": "MMORGAN13",
  "fsfl": "QRPGLESRC",
  "proj": "DEMOCH",
  "task": "2",
  "stsk": "3",
  "arfp": "*YES",
  "rfp": "1709",
  "vref": "ep1234"
}

Example: Git-linked request

Create an object request for a file in a Git repository. MDCMS resolves the attribute and object type from Git repository attribute mapping and the project from the branch.

{
  "appl": "TEST",
  "lvl": "10",
  "objn": "MYNEWPGM",
  "rsn": "*MIGRATE",
  "repo": "MDCMS",
  "gpath": "source/MCRPGLE",
  "gfile": "MYNEWPGM.sqlrpgle",
  "branch": "V8.6-83",
  "proj": "*BRANCH",
  "arfp": "*AUTO",
  "rfpd": "*TASK"
}

curl -X POST "https://{endpoint}/object-request" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"appl":"TEST","lvl":"10","objn":"MYNEWPGM","rsn":"*MIGRATE","repo":"MDCMS","gpath":"source/MCRPGLE","gfile":"MYNEWPGM.sqlrpgle","branch":"V8.6-83","proj":"*BRANCH","arfp":"*AUTO","rfpd":"*TASK"}'

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

{
  "appl": "TEST",
  "lvl": "10",
  "objn": "MYNEWPGM",
  "rsn": "*MIGRATE",
  "repo": "MDCMS",
  "gpath": "source/MCRPGLE",
  "gfile": "MYNEWPGM.sqlrpgle",
  "branch": "V8.6-83",
  "proj": "*BRANCH",
  "arfp": "*AUTO",
  "rfpd": "*TASK"
}

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 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.

If the source is a native source member and the POST includes an attached file of the same name as srcn, the file is imported as the source member.

If the POST includes an attached file of the same name as gfile, the file is copied for the Git-linked request.

The part file name must be non-blank and must match objn, srcn, or gfile. Attachments are considered only when rsn is *MIGRATE and copy is *NO.

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. When the request is created (sev is 10 or 20), it also provides a request object with the values MDCMS used, including values derived from Git mapping, *BRANCH, or *TASK.

Schema

Result object

Request object

Severity

Example

{
  "rtn": {
    "sev": "10",
    "msg": "Request created"
  },
  "request": {
    "objectId": 45281,
    "objt": "*PGM",
    "attr": "SQLRPGLE",
    "rfp": 1709,
    "rfpd": "Demo change",
    "proj": "DEMOCH",
    "task": 2,
    "stsk": 3,
    "folb": "MMORGAN13",
    "fslb": "MMORGAN13",
    "fsfl": "QRPGLESRC"
  }
}

Example: object already requested

{
  "rtn": {
    "sev": "30",
    "msg": "Target Object already locked by another request",
    "existingObjectId": 45270
  }
}

PATCH

Update an existing object request. Only fields that you send are changed. Omitted alphanumeric fields default to *SAME and are left unchanged. csqo of 0 is treated as unchanged.

The request can be identified only by objectId. The request must exist and be in status 00 (open) or 01 (assigned to an RFP).

PATCH /object-request

The request body is JSON. 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.
• The owner of the authentication token is authorized for the request's application and level: code 37 to update a request they own, or code 31 to update a request owned by another user.
• The object request exists and its status is 00 or 01.

If objectId is missing or is not greater than 0, the API returns HTTP 400 Bad Request.

Request body

Schema

Omitted alphanumeric properties are treated as *SAME. You can also send *SAME explicitly.

Assign RFP on PATCH

Example

Change the programmer and lock an existing object request, then assign it to an RFP. Replace {endpoint} with the URL endpoint defined for the MDCMS HTTP server.

{
  "objectId": 45281,
  "user": "MMORGAN",
  "lock": "*YES",
  "arfp": "*YES",
  "rfp": 1709
}

curl -X PATCH "https://{endpoint}/object-request" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"objectId":45281,"user":"MMORGAN","lock":"*YES","arfp":"*YES","rfp":1709}'

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

{
  "objectId": 45281,
  "user": "MMORGAN",
  "lock": "*YES",
  "arfp": "*YES",
  "rfp": 1709
}

Example: update source and Git file

{
  "objectId": 45281,
  "srcn": "MDWSREQS",
  "srca": "SQLRPGLE",
  "srcd": "Object request REST API",
  "gpath": "source/MCRPGLE",
  "gfile": "MDWSREQS.sqlrpgle"
}

File attachments

PATCH accepts a multipart/mixed body with a JSON payload part and a file part, the same way as POST.

The attached file is imported into the existing request's from-library. The part file name must match srcn or gfile. If both srcn and gfile are omitted (treated as *SAME), any non-JSON attached file is used.

Response body

The response provides a rtn object. When the request is updated (sev is 10 or 20), it also provides a request object with the values stored after the update.

Schema

Result object

Updated request object

Error messages

Example

{
  "rtn": {
    "sev": "10",
    "msg": "Request updated"
  },
  "request": {
    "objectId": 45281,
    "objt": "*PGM",
    "attr": "SQLRPGLE",
    "srcn": "MDWSREQS",
    "srca": "SQLRPGLE",
    "srcd": "Object request REST API",
    "user": "MMORGAN",
    "csqo": 10,
    "arfp": "*YES",
    "rfp": 1709,
    "lock": "*YES",
    "gpath": "source/MCRPGLE",
    "gfile": "MDWSREQS.sqlrpgle"
  }
}

Related resources