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

Request header

Request header

The request header is slightly different for version 2 and version 3 resources.
For version 2 calls, use the following format in the REST API request header:
<METHOD> <serverUrl>/<URI> HTTP/<HTTP version> Content-Type: application/<json | xml>
Accept: application/<json | xml>
icSessionId: <SessionId>
For version 3 calls, use the following format in the REST API request header:
<METHOD> <baseApiUrl>/<URI> HTTP/<HTTP version> Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <SessionId>
Note that if you use a tool such as Postman, requests automatically include the HTTP version. If you enter the HTTP version in the URL, the request is not successful because the HTTP version occurs twice in the URL.
The following list describes the attributes of the version 2 and version 3 request header formats:
Attribute
Required
Description
METHOD
Yes
Method you want to use, such as GET, POST, or DELETE.
serverUrl
Required for most v2 resources
Base URL for all version 2 resources except login and register.
Use a placeholder for serverUrl, and replace the placeholder with the
Informatica Intelligent Cloud Services
URL returned by the login resource.
For the login and register resources, use the URL listed in the resource.
baseApiUrl
Required for most v3 resources
Base URL for all version 3 resources except login.
Use a placeholder for baseApiUrl, and replace the placeholder with the
Informatica Intelligent Cloud Services
URL returned by the login resource.
For the login resource, use the URL listed in the resource definition.
URI
Required for most resources
Resource URI.
The URI includes the base URL and the resource name and can also include parameters.
For the login and register resources, use the URL listed in the resource definitions.
HTTP version
Yes
HTTP version that you are using.
Some tools such as Postman automatically include the HTTP version in the header.
Content-Type
Required for POST requests
Format of the request. Use one of the following options:
  • application/json. Reads request as JSON.
  • application/xml. Reads request as XML. Only applicable to version 2 resources.
Default is json.
Accept
No
Request format that you want to receive. Use one of the following options:
  • application/json. Sends response as JSON.
  • application/xml. Sends response as XML. Only applicable to version 2 resources.
Default is json.
icSessionId
Required for most v2 resources
Informatica Intelligent Cloud Services
session ID. Required for all version 2 resources except login and register.
Use a placeholder for sessionId, and replace the placeholder with the session ID returned by the login resource.
INFA-SESSION-ID
Required for most v3 resources
Informatica Intelligent Cloud Services
session ID. Required for all version 3 resources except login.
Use a placeholder for sessionId, and replace the placeholder with the session ID returned by the login resource.


Updated May 03, 2021