Error responses

Edit online

When a method call fails, the response code that the workflow REST protocol returns indicates the type of error that occurred. For example, the response code 404 Not Found indicates that the method did not find a resource such as the specified solution or case type. The response code 400 Bad Request indicates that a required parameter was not provided or that an incorrect value was specified for a parameter.

The JSON response that is returned by the method contains additional information about the error condition. The following example shows the format that the response uses to provide that information:

#Response
HTTP/1.1 500 Internal Server Error
Content-Type: application/json;charset-UTF-8
{
  "UserMessage":
  {
    "UniqueId":"FNRPA0024E",
    "Text":"FNRPA0024E IBM Case Builder cannot connect to the Process 
    Engine.",
    "Severity":"ERROR"
  }
  "UnderlyingDetails":
  {
    "Causes":
    [
      "Failed to connect to vworbbroker on hq-liquent:32776[100].  Check server
      connection.\nfilenet.pe.peorb.client.ORBServiceHelper$VWORBBrokerNotStarted: 
      Failed to retrieve an IOR for vworbbroker. URL=http:\/\/hq-liquent:32776\
      /IOR\/FileNet.PE.vworbbroker.  Check PE server to make sure that vworbbroker
      process is started.",
      "Failed to retrieve an IOR for vworbbroker. URL=http:\/\/hq-liquent:32776\
      /IOR\/FileNet.PE.vworbbroker.  Check PE server to make sure that vworbbroker
      process is started."
    ]
  },
}

Use the value of the UniqueId element to search for message information in the workflow documentation.