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

Encrypt and transfer files

Encrypt and transfer files

Encrypt and transfer files from the source location to the home directory of the file server user or the directory specified in the REST API param within the file server user’s home directory.

POST Request

To encrypt and transfer files, include the connection ID in the following URI.
mftsaas/api/v1/filetransferTask/execute/1001
Include the following information in the request:
Field
Type
Required
Description
agentGroupId
String
Yes
The ID of the agent group.
connectionId
String
Yes
The connection ID of the Advanced FTP, Advanced FTPS, or Advanced SFTP V2 connector.
portalUser
String
-
Whether the user is a portal user. Default is false.
relativeTargetLocation
String
-
The relative target location within the file server user’s home directory.
pattern
String
Yes
The file pattern to identify the files to collect for encryption. The regular expression pattern is supported.
sourceLocation
String
Yes
The source directory that contains the files you want to encrypt.
SIGN
String
-
Whether the file is signed by PGP. The values are not case sensitive.
Default is false.
PUBLIC_KEY_ID
String
Yes
The ID of the key that is used to encrypt the file.
SECRET_KEY_ID
String
Yes
The ID of the secret key that is used to sign the file, if the value of the SIGN variable is true.
SECRET_KEY_PASSPHRASE
String
Yes
The passphrase used to access the secret key if the value of the SIGN variable is true.
For example, to encrypt and transfer a file, you might use the following request:
POST <serverUrl>/mftsaas/api/v1/filetransferTask/execute/1001 Accept:application/json IDS-SESSION-ID: <icSessionId or INFA-SESSION-ID> { "agentGroupId": "01000125000000000002", "portalUser": "false", "connectionId": "0100010B000000000002", "pattern":"arun.txt", "relativeTargetLocation":"/", "sourceLocation":"C:\\FIS_Home\\DOCSTORE", "taskVariables": { "SIGN":"true", "PUBLIC_KEY_ID":"0x51986F687ADACBE1", "SECRET_KEY_ID":"0x51986F687ADACBE1", "SECRET_KEY_PASSPHRASE":"TESTER" } }

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": 1000000007165, "runId": 24 }
If unsuccessful, the response includes a reason for the failure.


Updated May 03, 2021