Informatica Cloud REST API Overview

Version 7

    What is the REST API?

     

    The Informatica Cloud REST API allows you to access information from your Informatica Intelligent Cloud Services organization. You can also perform tasks such as create, update, and delete connections and schedules, start and monitor jobs, and import and export assets.

     

    How can I start using the REST API?

     

    To use the Informatica Cloud REST API, you need a valid Informatica Intelligent Cloud Services login and an understanding of REST API guidelines. To perform a task using the Informatica Cloud REST API, use the appropriate resource and method, along with the applicable parameters. Informatica Intelligent Cloud Services returns the requested information, performs the requested task, or returns a response code and related messages.

     

    What resources are provided to me by the REST API?

     

    Here are some examples of the resources that you might use:

     

    • activityLog. Returns job details from the activity log.
    • activityMonitor. Returns job details from the activity monitor.
    • agent. Returns the details of a Secure Agent or the details of all Secure Agents in the organization. Also deletes a Secure Agent.
    • auditlog. Returns audit log entries.
    • bundleObject. Returns the details of a bundle. Returns the details of all bundles installed on or published by the organization. Pushes a published private bundle to sub-organizations.
    • bundleObjectLicense. Returns the license information for a bundle. Returns the license information for all bundles installed on or available to the organization. Installs a bundle and uninstalls a bundle.
    • connection. Returns the details of a Data Integration connection or the details of all connections in the organization. Returns available source or target objects for a specified connection. Returns all connections of a specified type associated with a Secure Agent. Creates or updates a connection. Tests a connection and deletes a connection.
    • customFunc. Returns the details of a Data Integration mapplet or of all mapplets in the organization. Creates or updates a mapplet. Also deletes a mapplet.
    • export. Starts an export job and returns an export job ID.
    • field. Returns the field details for a Data Integration source or target object.
    • fileRecord. Uploads a Data Integration Visio template XML file or image file. Also deletes a Visio template XML file or image file.
    • import. Uploads an import package or starts an import job.
    • job. Starts or stops a task.
    • login. Logs in to an Informatica Intelligent Cloud Services organization. Returns a 30-minute REST API session ID that you can use for subsequent REST API requests.
    • logout. Logs out of the organization and ends the REST API session specified in the request.
    • logoutall. Logs out of the organization and ends all the REST API session for the user.
    • mapping. Returns the details of a Data Integration mapping or the details of all mappings in the organization.
    • masterTemplate. Returns the details of a Data Integration Visio template or the details of all Visio templates in the organization. Creates or updates an Visio template. Also deletes an Visio template.
    • mttask. Returns the details of a Data Integration mapping task. Creates or updates a mapping task. Also deletes a mapping task.
    • org. Returns details of an Informatica Intelligent Cloud Services organization or related sub-organization. Updates an organization or related sub-organization. Also deletes a related sub-organization.
    • register. Creates an Informatica Intelligent Cloud Services organization or sub-organization using organization details.  (Available for Informatica Cloud partners only.)
    • schedule. Returns the details of a schedule or the details of all schedules in the organization. Creates or updates a schedule. Also deletes a schedule.
    • serverTime. Returns the local time of the Informatica Intelligent Cloud Services server.
    • task. Returns a list of tasks of the specified type.
    • user. Returns the details of a user account or the details of all user accounts in the organization. Creates or updates a user account. Also deletes a user account.
    • workflow. Returns the details of a Data Integration linear taskflow or the details of all linear taskflows in the organization. Creates or updates a linear taskflow. Also deletes a linear taskflow.

     

    Where can I find more information?

     

    For more information about the REST API, download the latest IICS REST API Reference