Object Creation REST API

Published: 2026-10-08

Last Updated: 2026-10-08

Create development objects for one object request, or for the objects in an RFP, and retrieve the status of that creation.

Creation is submitted to batch. The POST response returns a log id with status pending. Use GET with that log id to poll until the creation is complete.

Authorization

A missing or invalid token returns HTTP 401 Unauthorized.

POST

Submit creation of the development objects for one object request, or for an RFP. The request returns as soon as the job is submitted.

POST /object-creation

When objectId is greater than zero, that object request is created. Otherwise the objects in the application and RFP are created.

Request body

Schema

Either objectId must be greater than zero, or appl must be non-blank and rfp must be greater than zero. If neither is true, the API returns HTTP 400 with the message Either objectId must be > 0, or appl must be non-blank and rfp must be > 0.

fromFirstMissing and stopWhenError are case-insensitive. Omit a flag, or leave it blank, to use the default *NO. Any other value returns HTTP 400 with the message {property} must be *YES or *NO.

A missing request body returns HTTP 400 with the message Request Body missing. A body that is not valid JSON returns HTTP 400.

fromFirstMissing

stopWhenError

Example

Create the objects in an RFP, starting at the first missing object and stopping if an object fails. Replace {endpoint} with the URL endpoint defined for the MDCMS HTTP server.

{
  "appl": "TEST",
  "rfp": 1769,
  "fromFirstMissing": "*YES",
  "stopWhenError": "*YES"
}

curl -X POST "https://{endpoint}/object-creation" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"appl":"TEST","rfp":1769,"fromFirstMissing":"*YES","stopWhenError":"*YES"}'

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

{
  "appl": "TEST",
  "rfp": 1769,
  "fromFirstMissing": "*YES",
  "stopWhenError": "*YES"
}

Response body

A successful submit returns HTTP 200. The body contains the log id and status pending. It does not contain the objects. Poll GET with logId for the result.

If MDCMS cannot create the log or submit the job, the API returns HTTP 500.

Schema

Example

{
  "logId": 45821,
  "status": "pending"
}

GET

Return the status of a creation request.

GET /object-creation

Query parameters

If logId is omitted, the API returns HTTP 400 with the message Mandatory query parameter: "logId". If it is not greater than zero, the API returns HTTP 400 with the message logId must be > 0.

If no creation log exists for logId, the API returns HTTP 404 with the message Object creation log {logId} not found.

Example

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

curl -H "Authorization: Bearer {token}" \
  "https://{endpoint}/object-creation?logId=45821"

GET /object-creation?logId=45821 HTTP/1.1
Host: {endpoint}
Authorization: Bearer {token}

Response body

Schema

Status

HTTP 220 responses still include the JSON body. HTTP 400, 404, and 500 return the standard MDCMS error response.

Created object

Objects are returned in compile sequence.

Example — pending

{
  "logId": 45821,
  "status": "pending"
}

Example — complete

{
  "logId": 45821,
  "status": "complete",
  "objects": [
    {
      "objectId": 45290,
      "objectName": "MDDCMSD",
      "attr": "PF",
      "createStatus": "Ignored",
      "spoolFound": false,
      "ignoreReason": "Object exists and first non-exist not reached yet"
    },
    {
      "objectId": 45281,
      "objectName": "MDWSREQS",
      "attr": "SQLRPGLE",
      "createStatus": "Created",
      "spoolFound": true,
      "ignoreReason": ""
    },    
    {
      "objectId": 45302,
      "objectName": "MDCCRFP",
      "attr": "CBLLE",
      "createStatus": "Error",
      "spoolFound": true,
      "ignoreReason": ""
    }
  ]
}

Related resources