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

login

login

Use this resource to log in to
Informatica Intelligent Cloud Services
to use version 3 REST API resources.
The login response includes the session ID and base URL that you need to include in subsequent REST API calls. Use values from the following fields:
  • sessionId. A REST API session ID that you include in the header for version 3 REST API calls. The session ID expires after 30 minutes of inactivity. After the session ID expires, log in again to continue working with the REST API.
    For information on retrieving session status details, see Session IDs.
  • baseApiUrl. The base URL that you use in all version 3 resource URIs except for login, for example:
    <baseApiUrl>/public/core/v3/lookup

POST request

To log in using version 3 of the
Informatica Intelligent Cloud Services
API, use one of the following URLs:
  • North America:
    https://dm-us.informaticacloud.com/saas/public/core/v3/login
  • Europe:
    https://dm-em.informaticacloud.com/saas/public/core/v3/login
  • Asia Pacific:
    https://dm-ap.informaticacloud.com/saas/public/core/v3/login
Use the following fields in a login object:
Field
Type
Required
Description
username
String
Yes
Informatica Intelligent Cloud Services
user name.
Maximum length is 255 characters.
password
String
Yes
Informatica Intelligent Cloud Services
password.
Maximum length is 255 characters.

POST response

Returns user information if the request is successful. Returns the error object if errors occur.
Use the base URL and session ID returned in the response for subsequent requests during this session.
A successful request returns the following objects:
Field
Type
Description
products
Collection
Subscribed Informatica products.
name
String
Product name.
baseApiUrl
String
Returned in the product object.
Base API URL for the product. Use in REST API requests.
userInfo
Collection
User information.
sessionId
String
Returned in the userInfo object.
REST API session ID for the current session. Use in most REST API request headers.
id
String
Returned in the userInfo object.
User ID.
name
String
User name.
parentOrgId
String
Organization ID for the parent organization.
orgId
String
Returned in the userInfo object.
ID of the organization the user belongs to.
22 characters.
orgName
String
Returned in the userInfo object.
Organization name.
groups
Collection
User group information for the user.
status
String
Status of the user.
Returns one of the following values:
  • Active
  • Inactive

POST example

To log in to your
Informatica Intelligent Cloud Services
organization, you might use the following request:
POST https://dm-us.informaticacloud.com/saas/public/core/v3/login Content-Type: application/json Accept: application/json { "username": "user@informatica.com", "password": "mypassword" }
If successful, the response includes the products and userInfo objects which contain the baseApiUrl and sessionId values to use in subsequent calls, as shown in the following example:
{ "products": [ { "name": "Integration Cloud", "baseApiUrl": "https://pod.clouddev.informaticacloud.com/saas" } ], "userInfo": { "sessionId": "9KA11tLGqxVcGeul8SQBK3", "id": "9L1GFroXSDHe2IIg7QhBaT", "name": "user", "parentOrgId": "52ZSTB0IDK6dXxaEQLUaQu", "orgId": "0cuQSDTq5sikvN7x8r1xm1", "orgName": "MyOrg_INFA", "groups": {}, "status": "Active" } }
Using the above response as an example, to send a GET request to obtain license information, you might use the following request:
GET https://pod.clouddev.informaticacloud.com/saas/public/core/v3/license/org/0cuQSDTq5sikvN7x8r1xm1 Content-Type: application/json Accept: application/json INFA-SESSION-ID: 9KA11tLGqxVcGeul8SQBK3


Updated May 03, 2021