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 List REST API

Use the Project List REST API to obtain a list of Informatica Managed File Transfer projects sorted according to path, folder, and project ID categories. This API uses the POST method.

Use the following URL for the REST API call:

POST http://<hostName>:<portNumber>/informaticamft/api/v1/projects/search

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

You can provide a request body in JSON to the REST API call. The following table describes the request body objects:

Object	Arguments
categoryId	Obtain a list of projects identified by ID.
path	Obtain a list of projects identified by the path at which the project file is located.
category	Obtain a list of projects identified by the name of the directory in which the project file is located or the name of the project file.

The following table describes the response body objects:

Object	Arguments
id	The identifying number of the project.
name	Name of the project.
description	Description of the project.
path	Path at which the project file is located, or list of projects according to path.
folders	List of projects according to directory in which the project is located.
projects	List of projects.

Request Body Example

The following code shows the request body syntax:

{                
 "categoryId": "102",
 "path": "/DXProjects"
}

Response Body Example

The following code shows the response body syntax:

{   
   "path":"/DXProjects",
   "folders":[   
      {   
         "id":1001,
         "name":"DataExchange",
         "path":"/DataExchange"
      },
      {   
         "id":102,
         "name":"DXProjects",
         "description":"DX Projects",
         "path":"/DXProjects"
      }
   ],
   "projects":[   
      {   
         "id":1055,
         "name":"Cha",
         "path":"/Cha"
      },
      {   
         "id":1056,
         "name":"ChangeDir",
         "path":"/ChangeDir"
      }
   ]
}

Rename Saved Search

Table of Contents

REST API Guide

REST API Guide

Project List REST API

Project List REST API

Request Body Example

Response Body Example