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

Decompress and transfer files

Decompress and transfer files

Decompress and transfer the uploaded files from the home directory of file server user to the target location.

POST Request

To decompress and transfer files, include the connection ID in the following URI.
mftsaas/api/v1/filetransferTask/execute/1004
Include the following information in the request:
Field
Type
Required
Description
agentGroupId
String
Yes
The ID of the agent group.
portalUser
String
-
Whether the user is a portal user. Default is false.
relativeSourceLocation
String
-
The relative source location within the file server user's home directory.
pattern
String
Yes
The file pattern of the file to release to the specified target location after decompressing the file. The regular expression pattern is supported.
targetLocation
String
Yes
The target directory to which the file is moved after decompressing.
relativeTargetLocation
String
-
The relative target location within the file server user's home directory.
connectionId
String
Yes
The connection ID of the Advanced FTP, Advanced FTPS, or Advanced SFTP V2 connector.
afterFilePickupAction
String
-
Determines what to do with the source files after the files are transferred.
Select one of the following filter options:
  • KEEP. Keep the files in the source directory.
  • DELETE. Delete the files from the source directory.
  • RENAME. Rename the files in the source directory.
  • ARCHIVE. Archive the files to a different location. You must specify an archive directory
Default is KEEP.
renameSuffix
String
Yes
If afterFilePickupAction is selected as RENAME, the file name suffix to append to the files in the source directory.
You can use the following suffix types:
  • $date
  • $time
  • $runId
  • $timestamp
archiveDirectoryPath
String
Yes
If afterFilePickupAction is selected as ARCHIVE, the archive directory in which to archive the files.
skipDuplicateFiles
String
-
Indicates whether to skip the source files which are already present in the docstore location. Default is false.
processFilesRecursively
String
-
Indicates whether to process files from all sub-folders within the base directory. Default is false.
DECOMPRESSION_TYPE
String
Yes
The format of the files that you want to decompress.
Select one of the following decompression methods:
  • Zip
  • Tar
  • Gzip
The values are not case sensitive.
PATTERN _TO_COLLECT
String
Yes
The pattern of the file that you want to collect to decompress from the file server user’s home directory. Use a regular expression to match the file name pattern.
For example, to decompress and transfer a file, you might use the following request:
POST <serverUrl>/mftsaas/api/v1/filetransferTask/execute/1004 Accept:application/json IDS-SESSION-ID: <icSessionId or INFA-SESSION-ID> { "agentGroupId": "01000125000000000002", "portalUser": "false", "pattern": "arun_zip.txt", "relativeSourceLocation": "/", "targetLocation": "C:\\Informatica_Target", "relativeTargetLocation": "", "connectionId": "0100010B000000000002", "afterFilePickupAction": "RENAME", "renameSuffix":"_RENAME_", "archiveDirectoryPath" :"", "skipDuplicateFiles": true, "processFilesRecursively": false, "taskVariables": { "DECOMPRESSION_TYPE": "gunzip", "PATTERN_TO_COLLECT": ".*gz" } }

POST Response

If successful,
Informatica Intelligent Cloud Services
returns the run ID for the job. Use the run ID to monitor the job status.
The following example shows a successful response:
{ "projectId": 0, "timeTaken": 0, "queuePriority": 0, "runPriority": 0, "runMode": "UNKNOWN", "submitSourceId": -1, "runModeInteractive": false, "runModeBatch": false, "runModeDebug": false, "runModeUnknown": true, "formattedTimeTaken": "0.00", "id": 1000000007171, "runId": 30 }
If unsuccessful, the response includes a reason for the failure.


Updated May 03, 2021