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

REST API versions

REST API versions

Informatica Intelligent Cloud Services
supports the platform REST API version 2 and version 3 resources, and service-specific resources.
You can log in to
Informatica Intelligent Cloud Services
using the platform REST API version 2 or version 3 login resource. The version of any subsequent resource that you use does not need to match the version of the login resource that you use to log in.
Note the following differences between REST API version 2 and version 3 calls:
Format
You can use the following formats depending upon which API version you use:
  • Version 2 supports XML and JSON calls.
  • Version 3 supports JSON calls.
Login URL
Use one of the following login URLs:
  • For version 2, use
    https://dm-<POD region>.informaticacloud.com/ma/api/v2/user/login
    .
  • For version 3, use
    https://dm-<POD region>.informaticacloud.com/saas/public/core/v3/login
    .
Your POD (Point of Deployment) region is based on the location of your
Informatica Intelligent Cloud Services
data center. Use one of the following POD regions:
  • For North America, use
    us
  • For Europe, use
    em
  • For Asia, use
    ap
The POD region is included in the URL you receive when you register with
Informatica Intelligent Cloud Services
.
Base URL
The login response includes the base URL that you must include in subsequent calls.
The base URL includes the following components:
  • The name and region of the POD that your organization uses, for example, usw3.dm-us.
  • The
    Informatica Intelligent Cloud Services
    domain, informaticacloud.com.
  • The internal service that manages the API calls, for example, saas.
The following example is a base URL for an organization on the usw3.dm-us POD:
https://usw3.dm-us.informaticacloud.com/saas
In the login response, the attribute that provides the base URL depends on the API version that you use to log in. For example:
  • In a version 2 response, the attribute name is
    serverUrl
    .
  • In a version 3 response, the attribute name is
    baseApiUrl
    .
Request URL
The URL that you use in requests differs between the version 2 and version 3 resources, for example:
  • For version 2 resources, use
    <serverUrl>/api/v2/<REST API resource>
    , for example:
    https://usw3.dm-us.informaticacloud.com/saas/api/v2/activityLog
  • For version 3 resources, use
    <baseApiUrl>/public/core/v3/<REST API resource>
    , for example:
    https://usw3.dm-us.informaticacloud.com/saas/public/core/v3/schedule
Session ID
The login response includes a session ID that you must include in headers during the session. You can use the same session ID for version 2 and version 3 resources. In the login response, the name of the attribute for session ID depends on the API version that you use to log in. Use one of the following attributes:
  • For version 2 resources, use
    icSessionId
    in the header.
  • For version 3 resources, use
    INFA-SESSION-ID
    in the header.