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. Mass Ingestion Files REST API
  7. RunAJob utility
  8. REST API codes
  9. REST API resource quick references

REST API Reference

REST API Reference

Update a file ingestion task

Update a file ingestion task

Use a PUT request to update a file ingestion task.

PUT request

To update a
file ingestion
task, use the following URI:
mftsaas/api/v1/mitasks/<taskID>
Include the following fields in the PUT request:
Field
Type
Required
Description
id
String
-
ID number of the task.
name
String
Yes
Name of the task.
description
String
-
Description of the task.
sourceType
String
Yes
Determines the type where files are transferred. Enter one of the following options:
  • CONNECTION
    . Use connection as a source.
  • FILELISTENER
    . Use file listener as a source.
sourceConnection
String
-
Directory from where files are transferred.
includeSubfolder
String
-
Values are
true
or
false
. Set the value to
true
to transfer files from all sub-folders under the defined source directory.
checkDuplicate
String
-
Values are
true
or
false
. Set the value to
true
to check duplicate files and deny file transfer. If the value is set to
false
all files are transferred.
filePatternType
String
Yes
File name pattern used to select the files to transfer. Enter one of the following options:
  • Wildcard
  • Regex
filePattern
String
Yes
Enter pattern types, depending on the file pattern that you have selected.
  • wildcard. You can use the following wildcard character filters:
    • An asterisk (*) matches any number of characters.
    • A question mark (?) matches a single character.
  • Regex. Use regular expression to match the file pattern. Consider the following examples:
    • Use the following syntax to listen to all files except for files with a name that contains out, foo, and baz:
      ^(?!.*(?:out|baz|foo)).*$ à all except
    • Use the following syntax to listen to all files with doc and docx, pdf extensions:
      ([a-zA-Z0-9\s_\\.\-\(\):])+(.doc|.docx|.pdf)$ à
postPickupAction
String
-
Determines what to do with source files after the files transfer. The following options are available:
  • KEEP. Keep the files in the source directory.
  • DELETE. Delete the files from the source directory.
  • RENAME. Rename the files in the source directory. You must specify a file name suffix that
    file ingestion
    adds to the file name when renaming the files.
  • ARCHIVE. Archive the files to a different location. You must specify an archive directory.
targetConnection
String
Yes
Directory details to which files are transferred.

PUT request example

Use this sample as a reference to update a file ingestion task.
PUT <serverUrl>/public/core/v1/mitasks Content-Type: application/json Accept:application/json Content-Type:application/json IDS-SESSION-ID:{{IDS-SESSION-ID}} { "id": "cEMWKpibm44bNf5aMjbJ4U", "name": "Green Green v2", "description": "Green Green v2 Description", "sourceType": "CONNECTION", "sourceConnection": { "id": "", "name": "", "type": "local" }, "sourceParameters": { "filePattern": "*.txt", "filePatternType": "WILDCARD", "includeSubfolder": "false", "sourceDirectory": "C:\\Monitor", "checkDuplicate": "false", "postPickupAction": "KEEP" }, "targetConnection": { "id": "0100000B000000000002", "name": "ADLS", "type": "Azure Data Lake" }, "targetParameters": { "adlsTargetLocation": "/satyen/green" }, "agentGroupId": "01000025000000000002 }

PUT response example

If the request is successful, you might receive a response similar to the following example:
{ "id": "cEMWKpibm44bNf5aMjbJ4U", "name": "Green Green v2", "description": "", "sourceType": "CONNECTION", "sourceConnection": { "id": "", "name": "", "type": "local" }, "sourceParameters": { "filePattern": "*.txt", "filePatternType": "WILDCARD", "includeSubfolder": "false", "sourceDirectory": "C:\\Monitor", "checkDuplicate": "false", "postPickupAction": "KEEP }, "targetConnection": { "id": "0100000B000000000002", "name": "ADLS", "type": "Azure Data Lake" }, "targetParameters": { "adlsTargetLocation": "/satyen/green" }, "agentGroupId": "01000025000000000002", "createdTime": "2018-08-27T07:03:32Z", "updatedTime": "2018-08-29T12:14:58Z" }
The created and updated time in the response is displayed in the UTC time.


Updated May 03, 2021