REST API Guide

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

Back Next

Resource List REST API

Use the Resource List REST API to obtain a list of Informatica Managed File Transfer resources based on a search expression. This API uses the POST method.

Use the following URL for the REST API call:

POST http://<hostName>:<portNumber>/informaticamft/api/v1/resources/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
firstResult	Specify the first result to present.
maxResults	Specify the maximum number of results to present.
selectedSortColumn	Select which column is used to sort the resource information.
sortAscending	Sort the resources in ascending order.
matchAll	Provide all the matches to the search expression when performing the search.
useExactMatch	Exactly match the search expression when performing the search.
simpleSearchString	Use a simple search string to perform the search.
simpleSearch	Use a simple search to perform the search.
searchString	Specify the search string used to perform the search.
types	Select the resource type to search for. The following options apply: ftp ftps ssh as2 http https smtp mq mailbox

The following table describes the response body objects:

Object	Arguments
id	Identifying number for the resource.
name	Name of the resource.
description	Description of the resource.
type	Type of resource, for example ftp .
modifiedDate	Date that the resource was last modified.

Request Body Example

The following code shows the request body syntax:

{   
   "firstResult":0,
   "maxResults":50,
   "selectedSortColumn":1,
   "sortAscending":true,
   "matchAll":true,
   "useExactMatch":false,
   "simpleSearchString":null,
   "simpleSearch":false,
   "searchString":null,
   "types":[   
      "ftp",
      "ftps",
      "ssh",
      "as2",
      "http",
      "https",
      "smtp",
      "mq",
      "mailbox"
   ]
}

Response Body Example

The following code shows the response body syntax:

[   
   {   
      "id":1043,
      "name":"ftpRes",
      "description":"descriptionFtp",
      "type":"ftp",
      "modifiedDate":1490863585583
   },
   {   
      "id":1095,
      "name":"SmtpRes",
      "description":"descriptionSmtp",
      "type":"smtp",
      "modifiedDate":1486985704210
   },
   {   
      "id":1094,
      "name":"SshRes",
      "description":"descriptionSsh",
      "type":"ssh",
      "modifiedDate":1486985572883
   }
]

Rename Saved Search

Table of Contents

REST API Guide

REST API Guide

Resource List REST API

Resource List REST API

Request Body Example

Response Body Example