activityLog resource 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.
Note: 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:
{
The following example shows a response to get details for a file ingestion and replication job using run ID:
{
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:
Default is all.
fetchFileEvents
Determines if you want to display the file events. Set to one of the following values:
- file ingestion and replication task displays the job file events.- 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:
{
The following example shows a response to a request to get details for a file ingestion and replication job with fetchFileEvents set to true:
{