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 guidelines

REST API guidelines

The following list is a summary of guidelines to follow when working with the
Informatica Intelligent Cloud Services REST API
:
  • All resources and attributes are case-sensitive.
  • Use the login resource to start a REST API session. The session expires after 30 minutes of inactivity. However, best practice is to log out before the session ends. To continue work with the REST API, start a new session.
  • Use the logout resource to log out of the
    Informatica Intelligent Cloud Services
    session included in the request header.
  • Specify the format of the request and response in the header. Use the Content-Type attribute to specify the request format and the Accept attribute to specify the response format.
  • If a request or response type is not configured,
    Informatica Intelligent Cloud Services
    uses JSON by default.
  • For requests in JSON that use version 2 resources, you can optionally use the @type attribute to define an object. For requests in JSON that use version 3 resources, do not use the @type attribute.
  • For requests in XML, use an enclosing <object name> tag to define an object.
  • XML responses that include a list of objects return the objects enclosed in the <root> tag.
  • For all resources except login and register, use a placeholder for the session ID in request headers. Replace the placeholder with the session ID data returned when you log in to a session.
    Do not include icSessionId or INFA-SESSION-ID in the request header for login and register resources.
  • For all resources except login, use a placeholder for the base URL. For version 2 resources, replace the placeholder with the URL returned in the serverUrl. For version 3 resources, replace the placeholder with the URL returned in the baseApiUrl.
  • For POST requests, you must include all fields in the request object unless you submit the request in JSON format using partial mode. Partial mode is not applicable to most resources. By default, the REST API uses full mode.
  • Where indicated, enclose POST request attributes in the specified object. When no object is specified, include attributes in the request body.


Updated May 03, 2021