Get Process Status

End Point: [TMEngine URL]/status
Default: http://localhost:8000/TMServer/status
Send a POST request to the method end point with this parameter in a JSON body:
Field Required Content
process Yes ID of the background process to check
Example:
{
  "process": "1568223016762"
}
The server responds with a JSON object.
On successful status check, field 'status' is set to 'OK' and field 'result' contains current status.
Example:
Field 'result' may have these values:
  • Pending: processing is still going on.
    {
      "result": "Pending",
      "status": "OK"
    }
  • Completed: processing has finished. If the process produces any data, it is placed in the 'data' field.
    {
      "result": "Completed",
      "data": {
        "imported": "57678"
      },
      "status": "OK"
    }
  • Failed: processing failed. Failure reason is provided in 'reason' field.
    {
      "result": "Failed",
      "reason": "/Volumes/Data/something.tmx (No such file or directory)",
      "status": "failed"
    }
If process status cannot be checked, the server omits the 'result' field and provides a failure reason.
{
  "reason": "Missing 'process' parameter",
  "status": "failed"
}