On success, calls return a response code of 200 and the expected object.

Error Types

For errors, the API provides information about what went wrong. All errors are returned as JSON objects. An example error response follows:

{
  "status": 404,
  "class": "com.tamr.common.except.ResourceNotFoundException",
  "message": "No Operation found with ID [1000000]",
  "stackTrace": [
    "com.tamr.common.except.ResourceNotFoundException::withFormattedMessage::14",
    "com.tamr.unify.pub.api.services.OperationService::fetchOperation::37",
    "com.tamr.unify.pub.api.v1.resources.OperationResource::getOperation::68",
    "sun.reflect.NativeMethodAccessorImpl::invoke0::-2"
  ],
  "causedBy": null,
  "service": "Public API"
}

The following table describes the data and metadata for an error.

Key	Value Description
status	The HTTP status code of the error returned. See HTTP Status Codes.
class	The class that threw the error.
message	A short description of the error.
stackTrace	The series of calls made by the endpoint.
causedBy	A short message indicating why the error occured.
service	The microservice that caused the error.

HTTP Status Codes

Status Code	Text
400	Bad Request
401	Unauthorized
404	Not Found
409	Conflict
422	Unprocessable Entity
500	Internal Server Error