REST API Reference

Back Next

Activity logs

Use the

activityLog

resource to retrieve details for a completed job using the task ID, run ID, or both.

REST API version 1 resource

Use the

file ingestion and replication

task REST API version 1 resource to retrieve details for a completed job using the task ID, run ID, or both.

GET Request

To request the details for a completed job using the task ID, use the following URI:

mftsaas/api/v1/mitasks/activityLog?taskId=<taskId>

To request the details for active or a completed job using the run ID, use the following URI:

mftsaas/api/v1/mitasks/activityLog?runId=<runId>

To specify the number of rows to skip, use the following URI:

mftsaas/api/v1/mitasks/activityLog?taskId={{taskID}}&<offset>

To specify a row limit, use the following URI:

mftsaas/api/v1/mitasks/activityLog?taskId={{taskID}}&<rowLimit>

You can use a combination of these options. For example, you can use the following URI:

mftsaas/api/v1/mitasks/activityLog?runId=<runId>&taskId=<taskId>&rowLimit=<rowLimit>&offset=<offset>

You can use the following attributes in the activityLog GET URI:

Field	Description
taskId	File ingestion and replication task ID.
runId	File ingestion and replication run ID.
offset	The number of rows to skip. For example, you might want to skip the first three rows.
rowLimit	The maximum number of rows to return. The maximum number you can specify is 100. Default is 25.

You must specify either the taskId or the runId attribute in the GET URI.

GET Response

The activityLog object returns the following attributes:

Field	Description
id	File ingestion and replication job ID.
totaljobCount	Total number of jobs.
taskId	File ingestion and replication task ID.
runId	File ingestion and replication run ID.
startedBy	Name of the user who created the file ingestion and replication task.
startTime	Start time for the job. Uses Coordinated Universal Time (UTC).
endTime	End time for the job. Uses Coordinated Universal Time (UTC).
status	Whether the job completed successfully.
messageText	Error message associated with the job.
successFiles	The number of files that are successfully transferred from source to target.
failedFiles	The number of files that were not transferred from source to target.

GET Example

The following example shows a response to get details for a

file ingestion and replication

job using task ID:

{
	"totalJobCount": 7,
	"jobActivityLog": [
		{
			"id": 1000000200272,
			"taskId": 89882,
			"runId": 137205,
			"startedBy": "b2b_pod1",
			"startTime": "2021-09-13T09:55:13Z",
			"endTime": "2021-09-13T09:55:15Z",
			"status": "FAILED"
		},
		{
			"id": 1000000200270,
			"taskId": 89882,
			"runId": 137204,
			"startedBy": "b2b_pod1",
			"startTime": "2021-09-13T09:52:44Z",
			"endTime": "2021-09-13T09:53:02Z",
			"status": "SUCCESS"
		},
		{
			"id": 1000000200268,
			"taskId": 89882,
			"runId": 137202,
			"startedBy": "b2b_pod1",
			"startTime": "2021-09-13T09:49:55Z",
			"endTime": "2021-09-13T09:50:12Z",
			"status": "SUCCESS"
		},
		{
			"id": 1000000200264,
			"taskId": 89882,
			"runId": 137199,
			"startedBy": "b2b_pod1",
			"startTime": "2021-09-13T09:43:27Z",
			"endTime": "2021-09-13T09:43:42Z",
			"status": "SUCCESS"
		},
		{
			"id": 1000000200262,
			"taskId": 89882,
			"runId": 137198,
			"startedBy": "b2b_pod1",
			"startTime": "2021-09-13T09:13:58Z",
			"endTime": "2021-09-13T09:14:04Z",
			"status": "FAILED"
		},
		{
			"id": 1000000200261,
			"taskId": 89882,
			"runId": 137197,
			"startedBy": "b2b_pod1",
			"startTime": "2021-09-13T09:13:09Z",
			"endTime": "2021-09-13T09:13:28Z",
			"status": "SUCCESS"
		},
		{
			"id": 1000000200260,
			"taskId": 89882,
			"runId": 137196,
			"startedBy": "b2b_pod1",
			"startTime": "2021-09-13T09:12:21Z",
			"endTime": "2021-09-13T09:12:35Z",
			"status": "SUCCESS"
		}
	]
}

The following example shows a response to get details for a

file ingestion and replication

job using run ID:

{
	"jobActivityLog": [
		{
			"jobStatusResponse": {
				"jobStatus": "FAILED",
				"errorMessage": "[8008 - Create File List] Directory '/root/testnot' not found ",
				"jobDetails": {
					"jobNumber": 1000000200262,
					"status": "Failed",
					"startTime": "2021-09-13T09:13:58Z",
					"endTime": "2021-09-13T09:14:04Z",
					"messageText": "[8008 - Create File List] Directory '/root/testnot' not found ",
					"successFiles": 0,
					"failedFiles": 0,
					"fileDetails": []
				}
			}
		}
	]
}


{
    "jobActivityLog": [
        {
            "jobStatusResponse": {
                "jobStatus": "FAILED",
                "errorMessage": "[8008 - Create File List] Directory '/root/testnot' not found ",
                "jobDetails": {
                    "jobNumber": 1000000200262,
                    "status": "Failed",
                    "startTime": "2021-09-13T09:13:58Z",
                    "endTime": "2021-09-13T09:14:04Z",
                    "messageText": "[8008 - Create File List] Directory '/root/testnot' not found ",
                    "successFiles": 0,
                    "failedFiles": 0,
                    "fileDetails": []
                }
            }
        }
    ]
}

REST API version 2 resource

Use the

file ingestion and replication

task REST API version 2 resource to retrieve details for a given job type using the task ID, run ID, both, or neither.

GET Request

To request details for all jobs in a

file ingestion and replication

task, use the following URI:

mftsaas/api/v2/mitasks/activityLog

To request the details for all jobs using the task ID, use the following URI:

mftsaas/api/v2/mitasks/activityLog?taskId=<taskId>

To request the details for all jobs using the run ID, use the following URI:

mftsaas/api/v2/mitasks/activityLog?runId=<runId>

To specify the number of rows to skip, use the following URI:

mftsaas/api/v2/mitasks/activityLog?taskId=<taskId>&offset=<offset>

To specify a row limit, use the following URI:

mftsaas/api/v2/mitasks/activityLog?taskId=<taskId>&rowLimit<rowLimit>

To specify a job type, use the following URI:

mftsaas/api/v2/mitasks/activityLog?jobType=<jobType>

To specify the number of file events to display and include the file event limit, use the following URI:

mftsaas/api/v2/mitasks/activityLog?runId={{runID}}&fetchFileEvents=true&fileEventsLimit=10

You can use a combination of these options. For example, you can use the following URI:

mftsaas/api/v2/mitasks/activityLog?runId=<runId>&taskId=<taskId>&rowLimit=<rowLimit>&offset=<offset>

You can use the following attributes in the activityLog GET URI:

Field	Description
taskId	File ingestion and replication task ID.
runId	File ingestion and replication run ID.
offset	The number of rows to skip. For example, you might want to skip the first three rows.
rowLimit	The maximum number of rows to return. The maximum number you can specify is 100. Default is 25.
jobType	Types of jobs to include in the response. You can use one of the following options: all completed active Default is all.
fetchFileEvents	Determines if you want to display the file events. Set to one of the following values: true. The file ingestion and replication task displays the job file events. false. The file ingestion and replication task does not display the job file events. Default is false.
fileEventsLimit	The number of file events to return. Applies when fetchFileEvents is set to true . The maximum number you can specify is 1000. Default is 100.

GET Response

The activityLog object returns the following attributes:

Field	Description
totaljobCount	Total number of jobs.
taskId	File ingestion and replication task ID.
runId	File ingestion and replication run ID.
startedBy	Name of the user who created the file ingestion and replication task.
startTime	Start time of the job. Uses Coordinated Universal Time (UTC).
endTime	End time of the job. Uses Coordinated Universal Time (UTC).
status	Whether the job completed successfully.
logLocation	The location of the session log.
messageText	Remarks associated with the job status.
successFiles	The number of files that are successfully transferred from source to target.
failedFiles	The number of files that were not transferred from source to target.

GET Example

The following example shows a response to a request to get details for a

file ingestion and replication

job using task ID:

{
	"totalJobCount": 1,
	"jobActivityLog": [
		{
			"taskId": "gS7ivoMYoOli6v7TR7MIIe",
			"jobs": [
		   {
			   "runId": 490176,
			   "startedBy": "b2b_pod1",
			   "startTime": "2023-05-08T00:20:14Z",
			   "endTime": "2023-05-08T00:20:19Z",
			   "status": "SUCCESS"
				"logLocation": "data/taskLogs/2023-05-08/1000000916286.log"
				"messageText": "Job completed",
				"successFiles": 8,
				"failedFiles": 0
	
            }
        }
    ]
}

The following example shows a response to a request to get details for a

file ingestion and replication

job with fetchFileEvents set to true:

{    
    "totalJobCount": 1,
    "jobActivityLog": [
        {
            "taskId": "34owubT0kvFe18LdELjXop",
            "jobs": [
                {
                    "runId": 496420,
                    "startedBy": "atl",
                    "startTime": "2023-05-08T07:25:25Z",
                    "endTime": "2023-05-08T07:25:54Z",
                    "status": "SUCCESS",
                    "logLocation": "data/taskLogs/2023-05-08/1000000855619.log",
                    "messageText": "Job completed normally",
                    "successFiles": 1003,
                    "failedFiles": 0,
                    "fileDetails": [
                        {
                            "path": "/root/Arun/May/Target/File_5.txt",
                            "size": 12,
                            "lastModified": "2023-05-04T09:00:30Z",
                            "startTime": "2023-05-08T07:25:12Z",
                            "status": "SUCCESS",
                            "duration": 1,
                            "transferDirection": "UPLOAD"
                        },
                        {
                            "path": "/root/Arun/May/Target/File_12.txt",
                            "size": 12,
                            "lastModified": "2023-05-04T09:00:30Z",
                            "startTime": "2023-05-08T07:25:12Z",
                            "status": "SUCCESS",
                            "duration": 0,
                            "transferDirection": "UPLOAD"
                        },
                        {
                            "path": "/root/Arun/May/Target/File_2.txt",
                            "size": 12,
                            "lastModified": "2023-05-04T09:00:30Z",
                            "startTime": "2023-05-08T07:25:12Z",
                            "status": "SUCCESS",
                            "duration": 0,
                            "transferDirection": "UPLOAD"
                        },
                        {
                            "path": "/root/Arun/May/Target/File_8.txt",
                            "size": 12,
                            "lastModified": "2023-05-04T09:00:30Z",
                            "startTime": "2023-05-08T07:25:12Z",
                            "status": "SUCCESS",
                            "duration": 0,
                            "transferDirection": "UPLOAD"
                        },
                        {
                            "path": "/root/Arun/May/Target/File_10.txt",
                            "size": 12,
                            "lastModified": "2023-05-04T09:00:30Z",
                            "startTime": "2023-05-08T07:25:12Z",
                            "status": "SUCCESS",
                            "duration": 1,
                            "transferDirection": "UPLOAD"
                        },
                        {
                            "path": "/root/Arun/May/Target/File_14.txt",
                            "size": 12,
                            "lastModified": "2023-05-04T09:00:30Z",
                            "startTime": "2023-05-08T07:25:12Z",
                            "status": "SUCCESS",
                            "duration": 1,
                            "transferDirection": "UPLOAD"
                        },
                        {
                            "path": "/root/Arun/May/Target/File_16.txt",
                            "size": 12,
                            "lastModified": "2023-05-04T09:00:30Z",
                            "startTime": "2023-05-08T07:25:12Z",
                            "status": "SUCCESS",
                            "duration": 0,
                            "transferDirection": "UPLOAD"
                        },
                        {
                            "path": "/root/Arun/May/Target/File_18.txt",
                            "size": 12,
                            "lastModified": "2023-05-04T09:00:30Z",
                            "startTime": "2023-05-08T07:25:12Z",
                            "status": "SUCCESS",
                            "duration": 0,
                            "transferDirection": "UPLOAD"
                        },
                        {
                            "path": "/root/Arun/May/Target/File_6.txt",
                            "size": 12,
                            "lastModified": "2023-05-04T09:00:30Z",
                            "startTime": "2023-05-08T07:25:12Z",
                            "status": "SUCCESS",
                            "duration": 0,
                            "transferDirection": "UPLOAD"
                        },
                        {
                            "path": "/root/Arun/May/Target/File_13.txt",
                            "size": 12,
                            "lastModified": "2023-05-04T09:00:30Z",
                            "startTime": "2023-05-08T07:25:12Z",
                            "status": "SUCCESS",
                            "duration": 0,
                            "transferDirection": "UPLOAD"
                        }
                    ]
                }
            ]
        }
    ]
}

File Ingestion and Replication REST API

Download Guide

Watch

Comments

Cloud Data Integration Homepage