PI96919: MISLEADING HTTP RESPONSE FOR REST API

APAR status

• Closed as program error.

Error description

• The API for setting a property on an application. The API call
  in 6.2.7.1 gives a misleading
  HTTP response code in the scenario described below.
  
  
  In UCD 6.2.1.2, the client sends a PUT request with a query
  string:
  https://www.ibm.com/support/knowledgecenter/SS4GSP_6.2.1/com.ibm
  .udeploy.api.doc/topics/rest_cli_application_propvalue_put.html
  
  In UCD 6.2.7.1, the client sends a PUT request with a JSON
  payload:
  https://www.ibm.com/support/knowledgecenter/SS4GSP_6.2.7/com.ibm
  .udeploy.api.doc/topics/rest_cli_application_propvalue_put.html
  
  If the client sends a request with a query string to UCD
  6.2.7.1, the response is HTTP 401 Unauthorized, with the message
  "Use the Json
  template to set this property."
  
  The client is authenticated and authorized to make the request,
  so one would expect to see a 400 Bad Request response instead of
  a 401
  Unauthorized response.
  
  Another misleading endpoint is while getting team:
  When the given team is not found, UCD sends an HTTP 500 Internal
  Server Error response instead of an HTTP 404 Not found response
  or more appropriate response:
  
  $ curl -iku username:password
  'https://localhost:8443/cli/team/info?team=MyTeamX'
  HTTP/1.1 500
  

Local fix

Problem summary

• ****************************************************************
  * USERS AFFECTED:                                              *
  * All end users on all supported browsers.                     *
  ****************************************************************
  * PROBLEM DESCRIPTION:                                         *
  * The API for setting a property on an application. The API    *
  * call                                                         *
  * in 6.2.7.1 gives a misleading                                *
  * HTTP response code in the scenario described below.          *
  *                                                              *
  *                                                              *
  * In UCD 6.2.1.2, the client sends a PUT request with a query  *
  * string:                                                      *
  * https://www.ibm.com/support/knowledgecenter/SS4GSP_6.2.1/com *
  * .ibm                                                         *
  * .udeploy.api.doc/topics/rest_cli_application_propvalue_put.h *
  * tml                                                          *
  *                                                              *
  * In UCD 6.2.7.1, the client sends a PUT request with a JSON   *
  * payload:                                                     *
  * https://www.ibm.com/support/knowledgecenter/SS4GSP_6.2.7/com *
  * .ibm                                                         *
  * .udeploy.api.doc/topics/rest_cli_application_propvalue_put.h *
  * tml                                                          *
  *                                                              *
  * If the client sends a request with a query string to UCD     *
  * 6.2.7.1, the response is HTTP 401 Unauthorized, with the     *
  * message                                                      *
  * "Use the Json                                                *
  * template to set this property."                              *
  *                                                              *
  * The client is authenticated and authorized to make the       *
  * request,                                                     *
  * so one would expect to see a 400 Bad Request response        *
  * instead of                                                   *
  * a 401                                                        *
  * Unauthorized response.                                       *
  *                                                              *
  * Another misleading endpoint is while getting team:           *
  * When the given team is not found, UCD sends an HTTP 500      *
  * Internal                                                     *
  * Server Error response instead of an HTTP 404 Not found       *
  * response                                                     *
  * or more appropriate response:                                *
  *                                                              *
  * $ curl -iku username:password                                *
  * 'https://localhost:8443/cli/team/info?team=MyTeamX'          *
  * HTTP/1.1 500                                                 *
  ****************************************************************
  * RECOMMENDATION:                                              *
  * Fixed in version 7.1.0.1                                     *
  ****************************************************************
  

Problem conclusion

• Fix is provided in IBM UrbanCode Deploy 7.1.0.1
  

Temporary fix

Comments

APAR Information

• APAR is sysrouted FROM one or more of the following:

• APAR is sysrouted TO one or more of the following:

Fix information

• Fixed component name

  UC DEPLOY

• Fixed component ID

  5725M5400

Applicable component levels