Documentation Center

Get job tail

Get the latest log information about a specific background job, including its most recent status.

For security reasons, you need to perform a Login action before making any other public calls to the WorldServer API. The sessionId in the response is your session token. Use this token in all the other calls that you make.

Also, make sure that you have the appropriate user type permissions to perform this API call. To view or update your permissions, in WorldServer, go to Management > User Setup > User Types, and then select your user type.

API call

<protocol>://<ws-host>:<ws-port>/ws-api/v2/jobs/<jobId>/tail?token=<sessionId>&date=<date>

Details

  • GET method
  • Content-Type in the header: application/json
  • Mandatory parameters: the session token (as a query string parameter or as a key-value pair in the header), the ID of the job (as a URI parameter), and the date (as a query string parameter)

Request example

<protocol>://<ws-host>:<ws-port>/ws-api/v2/jobs/1134/tail?date=2020-05-24T06:48:18.473Z

Response

A screen shot that shows a typical response to this call.

Error messages

MessageStatus code
No session token provided or invalid token401 Unauthorized
Resource BACKGROUND_JOB (ID) not found404 Not Found
For input string: \<invalidId>\ (If the ID you entered is not a valid number.)500 Internal Server Error
Required LocalDateTime parameter 'date' is not present500 Internal Server Error