REST API Reference

Back Next

Compress and transfer files

Compress and transfer inbound files to or within a folder specified in the home directory of the remote server.

POST Request

To compress and transfer files, include the connection ID in the following URI.

mftsaas/api/v1/filetransferTask/execute/1003

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.
connectionId	String	Yes	The connection ID of the Advanced FTP, Advanced FTPS, or Advanced SFTP V2 connector.
relativeTargetLocation	String	-	The relative target location within the remote server home directory.
pattern	String	Yes	The file pattern to identify the files to collect for compression. The regular expression pattern is supported.
sourceLocation	String	Yes	The source directory that contains the files that you want to compress.
COMPRESSION_TYPE	String	Yes	The format of the files that you want to compress. Select one of the following compression methods: Zip Tar Gzip The values are not case sensitive.

For example, to compress and transfer a file, you might use the following request:

POST <serverUrl>/mftsaas/api/v1/filetransferTask/execute/1003
Accept:application/json
IDS-SESSION-ID: <icSessionId or INFA-SESSION-ID>
{
   "agentGroupId": "01000125000000000002",
    "portalUser": "false",
    "connectionId": "0100010B000000000002",
    "pattern":"arun_zip.txt",
    "relativeTargetLocation":"/",
    "sourceLocation":"C:\\FIS_Home\\DOCSTORE",
    "taskVariables": {
      "COMPRESSION_TYPE": "gzip"
      }
}

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": 1000000007170,
    "runId": 29
}

If unsuccessful, the response includes a reason for the failure.

Remote file transfer task

Download Guide

Watch

Comments

Cloud B2B Gateway Homepage