Communities
A collaborative platform to connect and grow with like-minded Informaticans across the globe
Product Communities
Connect and collaborate with Informatica experts and champions
Discussions
Have a question? Start a Discussion and get immediate answers you are looking for
User Groups
Customer-organized groups that meet online and in-person. Join today to network, share ideas, and get tips on how to get the most out of Informatica
Get Started
Community Guidelines
Knowledge Center
Troubleshooting documents, product guides, how to videos, best practices, and more
Knowledge Base
One-stop self-service portal for solutions, FAQs, Whitepapers, How Tos, Videos, and more
Support TV
Video channel for step-by-step instructions to use our products, best practices, troubleshooting tips, and much more
Documentation
Information library of the latest product documents
Velocity (Best Practices)
Best practices and use cases from the Implementation team
Learn
Rich resources to help you leverage full capabilities of our products
Trainings
Role-based training programs for the best ROI
Certifications
Get certified on Informatica products. Free, Foundation, or Professional
Product Learning Paths
Free and unlimited modules based on your expertise level and journey
Resources
Library of content to help you leverage the best of Informatica products
Tech Tuesdays Webinars
Most popular webinars on product architecture, best practices, and more
Product Availability Matrix
Product Availability Matrix statements of Informatica products
SupportFlash
Monthly support newsletter
Support Documents
Informatica Support Guide and Statements, Quick Start Guides, and Cloud Product Description Schedule
Product Lifecycle
End of Life statements of Informatica products
Ideas
Events
Change Request Tracking
Marketplace
English
  • Administrator
  • All Products

Table of Contents

Search

  1. Preface
  2. Informatica Intelligent Cloud Services REST API
  3. Platform REST API version 2 resources
  4. Platform REST API version 3 resources
  5. Data Integration REST API
  6. File Ingestion and Replication REST API
  7. Streaming Ingestion and Replication REST API
  8. Model Serve REST API
  9. RunAJob utility
  10. ParamSetCli utility
  11. REST API codes
  12. REST API resource quick references

REST API Reference

REST API Reference

Back Next

View file ingestion and replication tasks

View
file ingestion and replication
 tasks

Use the GET request to view
file ingestion and replication
 tasks.

GET request

To view the details of a particular
file ingestion and replication
 task, include the
file ingestion and replication
 in the following URI: 
mftsaas/api/v1/mitasks/{{TASK-ID}}
To view the details for all
file ingestion and replication
 tasks in the organization, omit the
file ingestion and replication
 ID. 
mftsaas/api/v1/mitasks
For example: 
GET https://na1.dm-us.informaticacloud.com/mftsaas/api/v1/mitasks

GET response

Returns the task object if successful or an error object if errors occur.
The task object includes the following information about each of the
file ingestion and replication
 tasks in the organization:
Field
Type
Description
taskId
String
ID number associated with the task.
taskName
String
Name of the task.
description
String
Description of the task.
location
String
Project and folder path where the task exists.
createTime
Date/time
Time when the task was created.
updateTime
Date/time
Time when the task was last updated.
The create and update time in the response are in UTC time.

GET response example to view all
file ingestion and replication
 tasks

The following sample response shows that there are three
file ingestion and replication
 tasks in the organization: 

{
    "mitasks": [
        {
            "id": "1ONE5Vewzztl0tuKR0EDum",
            "name": "A01_UMAR_MITASK2318",
            "description": "",
            "sourceType": "CONNECTION",
            "sourceConnection": {
                "id": "",
                "name": "",
                "type": "local"
            },
            "targetConnection": {
                "id": "0100000B000000000002",
                "name": "ftps",
                "type": "Advanced FTPS"
            },
            "agentGroupId": "01000025000000000002",
            "updatedTime": "2019-01-30T11:17:49Z"
        },
        {
            "id": "9D1tGkAxopJeFmUWoG4s48",
            "name": "A01_UMAR_MITASK3354",
            "description": "",
            "sourceType": "CONNECTION",
            "sourceConnection": {
                "id": "0100000B00000000000M",
                "name": "AzureBlob",
                "type": "Azure Blob"
            },
            "targetConnection": {
                "id": "0100000B00000000000L",
                "name": "SFTP_Conn",
                "type": "Advanced SFTP"
            },
            "agentGroupId": "01000025000000000002",
            "updatedTime": "2019-01-30T06:42:19Z"
        },
        {
            "id": "4hcTFqKVOQrl1z4d6pGUMP",
            "name": "A01_UMAR_MITASK5124",
            "description": "",
            "sourceType": "CONNECTION",
            "sourceConnection": {
                "id": "0100000B0000000004IO",
                "name": "S3",
                "type": "AmazonS3"
            },
            "targetConnection": {
                "id": "",
                "name": "",
                "type": "local"
            },
            "agentGroupId": "01000025000000000002",
            "updatedTime": "2019-01-30T06:35:01Z"
        }]
		}

Get response example showing a
file ingestion and replication
 task with file pattern as the file pickup option

The following sample response shows details of a
file ingestion and replication
 task. 
IDS-SESSION-ID:{{IDS-SESSION-ID}}
Accept:application/json
{
    "id": "j9OLB12nqYObykdFSUMpO2",
    "name": "FTPSrcTarget",
    "location": {
        "projectId": "dNC6zbp2lI8ghrKPo6hpwn",
        "projectName": "Hardening"
    },
    "description": "",
    "sourceType": "CONNECTION",
    "sourceConnection": {
        "id": "0100000B00000000028M",
        "name": "CCI_FTPS",
        "type": "Advanced FTPS V2"
    },
    "targetConnection": {
        "id": "0100000B0000000001JR",
        "name": "CCI_FTP_Lin",
        "type": "Advanced FTP V2"
    },
    "sourceParameters": {
        "filePattern": "*.txt",
        "sourceTransferMode": "AUTO",
        "filePatternType": "WILDCARD",
        "includeSubfolder": "false",
        "sourceDirectory": "/root/suraj/qa/test/automation/RSFiles",
        "checkDuplicate": "false",
        "fileStability": "true",
        "stabilityCheckInterval": "60",
        "postPickupAction": "KEEP"
    },
    "targetParameters": {
        "fileExistsAction": "APPEND_TIMESTAMP",
        "targetDirectory": "/",
        "targetTransferMode": "AUTO"
    },
    "agentGroupId": "01000025000000000003",
    "createdTime": "2019-02-04T10:34:08Z",
    "updatedTime": "2019-02-04T11:04:02Z",
	"filePickupOption": "PATTERN"
}

GET response example showing a
file ingestion and replication
 task with file list (file path) as the file pickup option

The following sample response shows a
file ingestion and replication
 task with filePickupOption type as FILELIST and a filePickupFilePath in its sourceParameters, indicating that this task reads the designated pickup file to identify which files need to be processed. 

{
	"id": "aFHWKrr1RwycuBRBLTtt2t",
	"name": "FilePath_CheckStability",
	"location": {
		"projectId": "0ggRhrI8ZziguyBxHBzuG0",
		"projectName": "Default"
	},
	"description": "",
	"sourceType": "CONNECTION",
	"sourceConnection": {
		"id": "",
		"name": "",
		"type": "local"
	},
	"targetConnection": {
		"id": "",
		"name": "",
		"type": "local"
	},
	"sourceParameters": {
		"filePickupFilePath": "test.txt",
		"sourceDirectory": "/root/test",
		"checkDuplicate": "false",
		"stabilityCheckInterval": "60",
		"postPickupAction": "KEEP",
		"filepickupByName": "FILEPATH",
		"batchSize": "5",
                "fileStability": "true",
                "stabilityCheckInterval": "60"
	},
	"targetParameters": {
		"fileExistsAction": "OVERWRITE",
		"targetDirectory": "/root/testCheckStability"
	},
	"agentGroupId": "01001D25000000000002",
	"createdTime": "2021-08-13T09:38:03Z",
	"updatedTime": "2021-08-13T09:39:02Z",
	"logLevel": "NORMAL",
	"filePickupOption": "FILELIST"
}

GET response example showing a
file ingestion and replication
 tasks with file list as the file pickup option

The following sample response shows a
file ingestion and replication
 task with filePickupOption type as FILELIST, filepickupByName as LISTOFFILES, and a filePickupFileList in its sourceParameters, indicating that this task reads and identifies the designated pickup files to be processed. 

{
    "id": "2bTlAolXbAGlE7I5qauSAW",
    "name": "DedupFilelist_pushdown",
    "location": {
        "projectId": "0ggRhrI8ZziguyBxHBzuG0",
        "projectName": "Default"
    },
    "description": "",
    "sourceType": "CONNECTION",
    "sourceConnection": {
        "id": "01001D0B0000000005PP",
        "name": "ADLSGen2",
        "type": "Azure Data Lake Gen2"
    },
    "targetConnection": {
        "id": "01001D0B0000000005PU",
        "name": "AzureDW_Gen2",
        "type": "Azure DW"
    },
    "sourceParameters": {
        "sourceDirectory": "/B2B/MI",
        "checkDuplicate": "true",
        "postPickupAction": "KEEP",
        "filepickupByName": "LISTOFFILES",
        "blockSize": "8388608",
        "filePickupFileList": "File1.txt,File2.txt",
        "batchSize": "5",
        "timeoutInterval": "60",
        "fileStability": "true",
        "stabilityCheckInterval": "60"
    },
    "targetParameters": {
        "commandType": "auto",
        "targetTableName": "test1234",
        "isPushdown": "true",
        "ingestionMethod": "polybase",
        "targetSchemaName": "testing",
        "isTruncateTarget": "true"
    },
    "agentGroupId": "01001D25000000000002",
    "createdTime": "2021-04-29T08:47:57Z",
    "updatedTime": "2021-04-29T08:47:57Z",
    "logLevel": "NORMAL",
    "filePickupOption": "FILELIST"
}
0 COMMENTS
We’d like to hear from you!