REST API Guide

10.2.2
- 10.5.3
- 10.5.0
- 10.4.0
- 10.2.3
- 10.2.2 HotFix 1
- 10.2.1
- 10.2

Back Next

Project Definition REST API

Use the Project Definition REST API to obtain full details for a Informatica Managed File Transfer project. This API uses the GET method.

Use the following URL for the REST API call:

GET http://<hostName>:<portNumber>/informaticamft/api/v1/projectsxml/{Project}

is the host name or IP address of the Managed File Transfer server.

is the port number of the Managed File Transfer server. The default port for HTTP is 8000 and the default port for HTTPS is 8002, for example,

http://myserver:8000

https://myserver:8002

In this URL,

{Project}

represents the variable

Project

set to the path for the project, for example:

Project = "DXProjects/Receive/DX_Remote_FTPS_Receive"

The resulting project XML file is delivered to the

<MFT Installation>\userdata\projects

directory.

You can also view the project XML file location in the Informatica File Transfer Portal. Select

System

Global Settings

Data

Projects Directory

XML Output Example

The following code shows the XML output syntax:

<?xml version="1.0" encoding="UTF-8" ?>
<projectname="DX_Remote_FTPS_Receive"mainModule="Main"version="2.0"logLevel="verbose"threadSafe="true">
<modulename="Main"onError="call:ErrorModule">
<iflabel="if RegEx"condition="${Upper(RegEx_or_WildCard)==Upper(&apos;Regex&apos;)}">
<else>
<iflabel="if WildCard"condition="${Upper(RegEx_or_WildCard)== Upper(&apos;Wildcard&apos;)}">…</if>
</else>
<ftpslabel="Connect to FTPS server"resourceId="${Source_FTPS_Connection}"outputSessionId="${FTPSSession}"version="1.0">
<getdestinationDir="${DX_FileDownloadDir}"whenFileExists="rename"processedSourceFilesVariable="${remoteFileList}">…</get>
</ftps>
<iflabel="Delete_From_Source_After_Download"condition="${Delete_From_Source_After_Download==&apos;true&apos;}">
<ftpslabel="Connect to FTPS server"resourceId="${Source_FTPS_Connection}"inputSessionId="${FTPSSession}"version="1.0">…</ftps>
</if>
</if>
</module>
<description>A Project for receiving files from a remote FTPS resource. Uses variables for seamless integration with B2B DX.</description>
<variablename="Source_FTPS_Connection"value=""""description="Select a pre-configured FTPS server connection. This variable is mandatory."/>
<variablename="Source_Directory"value="/"description="Specify a directory from which files will be downloaded."/>
<variablename="RegEx_or_WildCard"value="WildCard"description="Specify whether to use a Wild Card Filter or a Regular Expression Filter to search for file(s) to download. Accepted values: WildCard or RegEx."/>
<variablename="File_Pattern_To_Download"value="*.in"description="Specify the file name pattern for download."/>
<variablename="Delete_From_Source_After_Download"value="true"description="Specify whether to delete to the file from source after download. Accepted values: true or false."/>
<variablename="SMTP_Server"value=""""description="Specify the SMTP server to be used to sending error notification. This variable is optional."/>
<variablename="Email_For_Notification"value=""""description="Specify the email address of the user to be notified in case the MFT project fails."/>
<modulename="ErrorModule"onError="continue">
<iflabel="Check for SMTP server value"condition="${IsNotEmpty(SMTP_Server)}">
<sendEmaillabel="Send Error email"resourceId="${SMTP_Server}"toList="${Email_For_Notification}"version="2.0">
<fromaddress="admin@infamft.com"/>
<subject><![CDATA[Project ${system.project.name} Failed]]></subject>
<messagefile="${system.job.log}"><![CDATA[Project ${system.project.name} failed due to the following reason: ${system.job.error}]]></message>
</sendEmail>
</if>
<raiseErrorversion="1.0">
<message>
Project ${system.project.name} failed due to the following reason:
${system.job.error}
</message>
</raiseError>
</module>
</project>

Rename Saved Search

Table of Contents

REST API Guide

REST API Guide

Project Definition REST API

Project Definition REST API

XML Output Example