REST API Reference

Back Next

Getting the status of a file listener

Use a GET request to request the status of a file listener job.

To view the status of a file listener, use the following URI:

GET <server URL>/mftsaas/api/v1/filelisteners/job/<Job ID>/status

Include the following field in the request:

Field	Type	Description
Job ID	String	ID number associated with the file listener job.

To view the status of a file listener job, you might use the following request:

GET <server URL>/mftsaas/api/v1/filelisteners/job/<Job ID>/status
Content-Type: application/json
Accept: application/json
icSessionId: <SessionId>

If the request to view the status of a file listener job is successful, you might receive a response similar to the following example:

{
    "status": "STOPPED",
    "jobId": 1038
}

If the request to view the status of a file listener job is unsuccessful, you might receive a response similar to the following example:

{
    "responseCode": "NOT_FOUND",
    "message": "File listener not found for TaskId:  1079"
}