Object Creation Spool File REST API

Published: 2026-10-08

Last Updated: 2026-10-08

Download the spool file recorded for an object request after development object creation.

Use the objectId from the Object Creation REST API when that object's spoolFound value is true.

GET /object-creation/spoolfile

Response format

A successful response is the spool file as plain text. It is not JSON. The response headers are Content-Type: text/plain and Content-Disposition: attachment.

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
`objectId`	integer	Yes	Object request number. Must be greater than zero.

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

Example

Download the spool file for an object request. Replace {endpoint} with the URL endpoint defined for the MDCMS HTTP server.

cURLHTTP

curl -H "Authorization: Bearer {token}" \
  -o spoolfile.txt \
  "https://{endpoint}/object-creation/spoolfile?objectId=45281"

GET /object-creation/spoolfile?objectId=45281 HTTP/1.1
Host: {endpoint}
Authorization: Bearer {token}

Response

A successful request returns HTTP 200. The body is the spool file text.

Header	Value
`Content-Type`	`text/plain`
`Content-Disposition`	`attachment; filename="{path}"`, where `{path}` is the IFS path of the exported spool file.

The spool file is the one stored on the object request: spool file name, job name, job user, job number, and spool file number.

Errors

HTTP	Message	When
`400`	`Mandatory query parameter: "objectId"`	`objectId` was omitted.
`400`	`objectId must be > 0`	`objectId` is zero or not a number.
`400`	`Unable to export spool file`	The spool file could not be exported.
`400`	`Response Processing Error : {detail}`	The exported file could not be returned.
`404`	`Object request {objectId} not found`	No object request exists for `objectId`.
`404`	`Spool file not found for object request {objectId}`	The object request has no spool file name, or its spool file number is zero.
`500`	`Error reading object request`	The object request could not be read.

HTTP 400, 404, and 500 return the standard MDCMS error response.

Resource	Description
Object Creation REST API	Create development objects and return creation status, including `spoolFound`
Object Requests REST API	List or delete object requests