REST API Reference

Back Next

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.
fileServerUsername	String	Yes	The user name of the file server.
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.
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_CASE_SENSITIVE	String	-	Whether the file pattern is case sensitive. The values are not case sensitive. Default is false.
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",
	"fileServerUsername": "arun",
	"pattern":".*csv",
	"targetLocation":"C:\\Informatica_Target",
	"taskVariables": {
	"PATTERN_CASE_SENSITIVE": "false",
	"DECOMPRESSION_TYPE": "unzip",
	"PATTERN_TO_COLLECT": ".*zip"
	}
}

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": 1000000007161,
				"runId": 20
}

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

Hosted file transfer task

Download Guide

Watch

Comments

Cloud B2B Gateway Homepage