REST API Errors Responses Should Provide Reason for Error

Idea ID 1795482

REST API Errors Responses Should Provide Reason for Error

Hello,

Brief Description: Enable Micro Focus Operations Orchestration to provide proper error messages back to the REST API Caller. This will help the user understand what the issue is when calling the REST API and how to proceed forward.

Today if the online documentation isn't accurate or the payload is malformed, the REST API caller has to dig through the Central Servers server.log to better understand what the issue is. In a world where the REST API is a gateway for a user to call Orchestration, this takes time away from the administrators of the OO platform to provide the errors logged in server.log

Benefits/Value

  • More user friendly error messages for REST APIs. 
  • Empowers developers to resolve there REST API issues without having to engage Administrators of the OO platform
  • If the payload is malformed, the REST API can provided the proper structure

Design details:

  • Errors that are displayed in Central Server server.log should be provided back to the caller of the REST API

A few examples when executing workflows via OO REST API:

  • There is no true list input validation
  • The caller can provide whatever value they'd like too
  • There is no data validation for non list items
  • The workflow is executed and a Run ID is returned to the caller
  • The workflow then enters a paused state waiting for proper user input in Central
  • This leaves the caller unaware of the state of the workflow
  • Executing a workflow with missing 'required' inputs only returns a 400 with a generic HTML response
  • Only the server.log file has information about which fields are missing
  • This leaves the caller unaware of why the execution failed
  • Executing a workflow with invalid UUID only returns a 400 with a generic HTML response
  • Only the server.log file has information about which fields are missing
  • This leaves the caller unaware of why the execution failed
1 Comment
Micro Focus Contributor
Micro Focus Contributor
Status changed to: Waiting for Votes

Let's get community support for the idea

The opinions expressed above are the personal opinions of the authors, not of Micro Focus. By using this site, you accept the Terms of Use and Rules of Participation. Certain versions of content ("Material") accessible here may contain branding from Hewlett-Packard Company (now HP Inc.) and Hewlett Packard Enterprise Company. As of September 1, 2017, the Material is now offered by Micro Focus, a separately owned and operated company. Any reference to the HP and Hewlett Packard Enterprise/HPE marks is historical in nature, and the HP and Hewlett Packard Enterprise/HPE marks are the property of their respective owners.