REST API Guide

REST API Guide

Response Body

Response Body

The REST API sends a response header and response body in JSON format with information about the success or failure of the REST API call.
The response header can contain the following information:
  • server
  • content-type
  • content-language
  • content-length
  • date
  • connection
  • transfer-encoding
  • severity
  • errorCode
  • description
  • logFile
The response body can contain information about the output and additional output ports. If the output type was file, the response body contains a path to the output. If the output type was buffer, the response body contains the buffer contents. The response body can also contain a success or failure code and message.