REST API Reference

Back Next

Getting the job status

Use this resource to get the stored status and run metrics of a job in a Customer Managed runtime environment.

GET Request

To get the job status, use the following API call:

GET https://<agent-host>:9443/rm/mftsaas/api/v1/offline/job/<jobNumber>/status
RM-USER-TOKEN: <rm-token>

The jobNumber is the job number that the run resource returns.

To get the job status with curl, use the following command:

curl -k https://<agent-host>:9443/rm/mftsaas/api/v1/offline/job/<jobNumber>/status \
   -H "RM-USER-TOKEN: <rm-token>"

Call this resource until the status is SUCCESS, FAILED, or ABORTED. A poll every 10 to 30 seconds is enough for most jobs.

Get response

Returns the job object if the request is successful. Returns an error if errors occur.

A successful request returns the following response:

{
   "jobId": 1728712345678,
   "rteId": "rte-01",
   "frsId": "3fhK2xYqLpWeZ9AbCdEfGh",
   "taskName": "Daily_Inbound_Transfer",
   "status": "SUCCESS",
   "startTime": "2026-10-12 09:15:02.114",
   "endTime": "2026-10-12 09:15:47.902",
   "agentId": "0a1B2c3D4e5F6g7H8i9J0k",
   "failMessage": null,
   "successFileCount": 25,
   "downloadVolume": 10485760,
   "uploadVolume": 10485760
}

The following table describes the attributes:

Field	Type	Description
jobId	Number	Job number.
rteId	String	Runtime environment ID.
frsId	String	Task ID (FRS ID) of the task that ran.
taskName	String	Name of the task.
status	String	The status of the job. Options are: SUBMITTED. The agent accepted the job and the job waits to start. RUNNING. The job started. FAILED. The job failed.. Aborted. A user stopped the job.
startTime	String	Time that the job started, in the local time of the agent.
endTime	String	Time that the job ended, in the local time of the agent. The value is null while the job runs.
agentId	String	ID of the agent that ran the job.
failMessage	String	Reason for the failure when the status is FAILED.
successFileCount	Number	Number of files transferred successfully.
downloadVolume	Number	Amount of data the job read from the source, in bytes.
uploadVolume	Number	Amount of data the job wrote to the target, in bytes.

Call this resource until the status is SUCCESS, FAILED, or ABORTED. A poll every 10 to 30 seconds is enough for most jobs.

The following table describes the errors:

HTTP status	Response	Description
404	{"error":"Job not found","jobId":"<n>"}	No job with this number exists for this organization.
500	{"error":"Internal server error"}	Internal error.

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Getting the job status

Getting the job status

GET Request

Get response