Software management services

For errors that occur during the processing of a request, the API returns an appropriate HTTP status code to the calling client. An error is indicated by a 4nn code or a 5nn code. Some errors might also include a returned JSON object that contains the following attributes:

{
  "error":
  {
    "reason":"reason-code",
    "messages":["message-text"]
  }
}

where:

error

JSON object that contains a reason code and a list of one or more message strings to describe the errors detected while processing the request.

reason-code

Reason code returned for the request. The value is an integer.

message-text

Array that contains the text of each message that was issued.

The following HTTP status codes are valid:

HTTP 200 OK

Success.

HTTP 400 Bad request

The request contained incorrect parameters.

HTTP 401 Unauthorized

The submitter of the request did not authenticate to z/OSMF.

HTTP 403 Forbidden

The server rejected the request.

HTTP 404 Not found

The target of the request was not found.

HTTP 409 Conflict

The request could not be completed because there is a conflict with the current state of the resource.

HTTP 500 Internal server error

The server encountered an error that prevented it from completing the request.

HTTP 503 Service unavailable

The server is currently unavailable to process the request.