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

Platform resource quick reference

Platform resource quick reference

The following list contains the syntax and a brief description of the
Informatica Intelligent Cloud Services REST API
platform resources:
activityLog GET
Version 2 resource.
Returns information from the
Monitor
service.
Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/activity/activityLog/
<id>
/api/v2/activity/activityLog
?rowLimit=<row limit>
/api/v2/activity/activityLog
?offset=<offset>
/api/v2/activity/activityLog
?taskId=<taskId>
/api/v2/activity/activityLog
?runId=<runId>
You can also use the activityLog to download error logs and session logs from the server.
Use the serverUrl from the login response for one of the following URIs:
/api/v2/activity/errorLog/
<id>
/api/v2/activity/activityLog/
<Top_Level_Log_Entry_Id>
/sessionLog?itemId=
<child-log-entry-item-id>
&childItemId=
<child-log-entry-item-id>
activityMonitor GET
Version 2 resource.
Returns information from the
Monitor
service.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/activity/activityMonitor
?details=<true|false>
agent GET
Version 2 resource.
Returns the details of a Secure Agent or of all Secure Agents in the organization.
To get Secure Agent details, use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/agent/
<id>
/api/v2/agent/name/<name>
To get a Secure Agent install token, use the serverUrl from the login response as the base URL in the following URI:
/api/v2/agent/installerInfo/<install platform>
agent DELETE
Version 2 resource.
Deletes a Secure Agent.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/agent/
<id>
agentservice POST
Version 3 resource
Starts or stops a Secure Agent service.
Use the baseApiUrl from the login response as the base URL for the following URI:
public/core/v3/agent/service
auditlog GET
Version 2 resource.
Returns audit log entries.
Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/auditlog /api/v2/auditlog?batchId=
<batchId>
&batchSize=
<batchSize>
bundleObject GET
Version 2 resource.
Returns the details of a bundle or the details of all published or installed bundles in the organization.
Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/bundleObject/
<id>
/api/v2/bundleObject/name/
<name>
/api/v2/bundleObject/?published=true /api/v2/bundleObject/?published=true&installed=false /api/v2/bundleObject/?installed=true /api/v2/bundleObject/?published=false&installed=true
bundleObject POST
Version 2 resource.
Pushes a published private bundle to sub-organizations.
Use the serverUrl from the login response as the base URL in the following URI:
/api/v2/bundleObject/push/
<bundleId>
bundleObjectLicense GET
Version 2 resource.
Returns the details of all bundles available to or installed on the organization.
Use the serverUrl from the login response as the base URL in the following URI:
/api/v2/bundleObjectLicense/
<bundleObjectId>
bundleObjectLicense POST
Version 2 resource.
Installs a bundle.
Use the serverUrl from the login response as the base URL in the following URI:
/api/v2/bundleObjectLicense/
Use a bundleObjectLicense object to define attributes. Include the following required attribute: bundleId.
bundleObjectLicense DELETE
Version 2 resource.
Uninstalls a bundle.
Use the serverUrl from the login response as the base URL in the following URI:
/api/v2/bundleObjectLicense?bundleObjectId=
<bundleId>
&updateOption=
<updateOption>
ChangePassword POST
Version 3 resource.
Changes the password for the user who initiated the session or for a specified user.
Use the baseApiUrl from the login response as the base URL for the following URI:
/public/core/v3/Users/ChangePassword
commitHistory GET
Version 3 resource.
Returns commit history for source-controlled objects with the latest commit listed first.
Use the baseApiUrl from the login response as the base URL for the following URI:
/public/core/v3/commitHistory
export POST
Version 3 resource.
Starts an export job and returns an export job ID.
Use the baseApiUrl from the login response as the base URL for the following URI:
/public/core/v3/export
export GET
Version 3 resource.
Returns export status or the export package.
You can request the following information:
  • To receive status of an export job, use the baseApiUrl from the login response as the base URL for one of the following URIs:
    /public/core/v3/export/
    <id>
    /public/core/v3/export/
    <id>
    ?expand=objects
  • To receive a .zip stream of the export package, use the baseApiUrl from the login response as the base URL for the following URI:
    /public/core/v3/export/
    <id>
    /package
fetchState POST
Version 3 resource.
Creates an object states package and returns a fetchState job ID.
Use the baseApiUrl from the login response as the base URL for the following URI:
/public/core/v3/fetchState
fetchState GET
Version 3 resource.
Returns the status of the fetchState job or the object states package.
You can request the following information:
  • To receive status of a fetchState job, use the baseApiUrl from the login response as the base URL for one of the following URIs:
    /public/core/v3/fetchState/
    <id>
    /public/core/v3/fetchState/<id>?expand=objects
  • To receive a ZIP stream of the object states package, use the baseApiUrl from the login response as the base URL for the following URI:
    /public/core/v3/fetchState/
    <id>
    /package
import POST
Version 3 resource.
Uploads an import package or starts an import job.
You can perform the following actions:
  • To upload an import package, use the baseApiUrl from the login response as the base URL for the following URI:
    /public/core/v3/import/package
    For Content-Type, use multipart/form-data.
  • To specify details for an import job and start the job, use the baseApiUrl from the login response as the base URL for the following URI:
    /public/core/v3/import/
    <id>
import GET
Version 3 resource.
Returns status of an import job.
Use the baseApiUrl from the login response as the base URL and include the import job ID in one of the following URIs:
/public/core/v3/import/
<id>
/public/core/v3/import/
<id>
?expand=objects
job POST
Version 2 resource.
Starts or stops a task and optionally provides job status. You can perform the following actions:
  • To start a task, use the serverUrl from the login response as the base URL for the following URI:
    /api/v2/job
  • To stop a task, use the serverUrl from the login response as the base URL for the following URI:
    /api/v2/job/stop
Do not use this resource for a
file ingestion
task. Instead, use the
file ingestion
job resource. For more information, see job.
license GET
Version 3 resource.
Returns the license details for the organization that you are logged in to or a specified sub-organization.
Use the baseApiUrl from the login response as the base URL in the following URI:
/public/core/v3/license/org/
<id>
license PUT
Version 3 resource.
Updates license information for a sub-organization.
Use the baseApiUrl from the login response as the base URL in the following URI:
/public/core/v3/license/org/
<id>
Use the orgLicenseAssignment object to update license information.
loadState POST
Version 3 resource.
Uploads an object states package ZIP file or loads the object states.
You can perform the following actions:
  • To upload an object states package, use the baseApiUrl from the login response as the base URL for the following URI:
    /public/core/v3/loadState/package
    For Content-Type, use multipart/form-data.
  • To specify details for a loadState job and start the job, use the baseApiUrl from the login response as the base URL for the following URI:
    /public/core/v3/loadState/
    <id>
loadState GET
Version 3 resource.
Returns status of a loadState job.
Use the baseApiUrl from the login response as the base URL and include the job ID in one of the following URIs:
/public/core/v3/loadState/
<id>
/public/core/v3/import/
<id>
?expand=objects
login POST
Version 3 resource.
Logs into an organization and returns a session ID that you can use for other resource calls.
Use the following URL:
https://dm-
<region>
.informaticacloud.com/saas/public/core/v3/login
Use one of the following values for the region:
  • For North America, use
    us
    .
  • For Europe, use
    em
    .
  • For Asia Pacific, use
    ap
    .
Omit INFA-SESSION-ID from the request header.
Use a login object and include the following fields: username, password.
logout POST
Version 3 resource.
Logs out of an organization and ends the REST API session included in the request header.
Use the same URL used for the login POST except for the API name. Use the following URI:
https://dm-us.informaticacloud.com/saas/public/core/v3/logout
login POST
Version 2 resource.
Logs into an organization and returns a session ID that you can use for other resource calls.
To log in with your
Informatica Intelligent Cloud Services
account, use the following URL:
https://dm-
<region>
.informaticacloud.com/ma/api/v2/user/login
Use one of the following values for the region:
  • For North America, use
    us
    .
  • For Europe, use
    em
    .
  • For Asia Pacific, use
    ap
    .
Omit icSessionId from the request header.
Use a login object and include the following fields: username, password.
loginSAML POST
Version 2 resource.
For SAML single sign-on users, logs into an organization and returns a session ID that you can use for other resource calls.
To log in to an organization, use the following URL:
https://dm-us.informaticacloud.com/ma/api/v2/user/loginSaml
Omit icSessionId from the request header.
Include the following required attributes in the login object: orgId, samlToken.
loginSf POST
Version 2 resource.
Logs into an organization using Salesforce credentials and returns a session ID that you can use for other resource calls.
To log in to an organization, use the following URL:
https://dm-us.informaticacloud.com/ma/api/v2/user/loginSf
Omit icSessionId from the request header.
Include the following required attributes in the login object: sfSessionId, sfServerUrl.
logout POST
Version 2 resource.
Logs out of an organization and ends the REST API session included in the request header.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/user/logout
logoutall POST
Version 2 resource.
Logs out of an organization and ends all version 2 REST API sessions for the organization.
Use the following URL:
https://dm-us.informaticacloud.com/ma/api/v2/user/logoutall
Use a logout object to define attributes. Include the following required attributes: username, password.
Omit icSessionId from the request header.
lookup POST
Version 3 resource.
Looks up an object's ID, name, path, or type attributes.
Use the serverUrl from the login response as the base URL for the following URI:
/public/core/v3/lookup
objects GET
Version 3 resource.
Returns a list of your organization's assets.
Use the serverUrl from the login response as the base URL for the following URI:
/public/core/v3/objects?
<query parameters>
org GET
Version 2 resource.
Returns the details of your
Informatica Intelligent Cloud Services
organization or a related sub-organization.
Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/org/
<id>
/api/v2/org/name/
<name>
org POST
Version 2 resource.
Updates the details of an
Informatica Intelligent Cloud Services
organization or a related sub-organization.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/org/
<id>
Use an org object to define attributes.
org DELETE
Version 2 resource.
Deletes a related sub-organization.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/org/
<id>
privileges GET
Version 3 resource.
Returns a list of privileges that can be used in custom roles.
Use the baseApiUrl from the login response as the base URL for the following URI:
/public/core/v3/privileges
pull GET
Version 3 resource.
Returns the status of a pull request.
Use the baseApiUrl from the login response as the base URL for the following URI:
/public/core/v3/pull/<pullActionId>
pull POST
Version 3 resource.
Retrieves objects from your repository and loads them into your organization.
Use the baseApiUrl from the login response as the base URL for the following URI:
/public/core/v3/pull
register POST
Version 2.
Creates an
Informatica Intelligent Cloud Services
sub-organization based on an
Informatica Intelligent Cloud Services
user account. For
Informatica Intelligent Cloud Services
partners only.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/user/register
Use a registration object to define attributes.
ResetPassword
Version 3 resource.
Resets the password for the user who initiated the session.
Use the baseApiUrl from the login response as the base URL for the following URI:
/public/core/v3/Users/ResetPassword
roles GET
Version 3 resource.
Returns details for an organization's roles.
Use the baseApiUrl from the login response as the base URL for the following URI:
/public/core/v3/roles
roles POST
Version 3 resource.
Creates or updates a custom role.
Use the baseApiUrl from the login response as the base URL in one of the following URIs:
/public/core/v3/roles /public/core/v3/roles/
<role ID>
roles DELETE
Version 3 resource.
Deletes a custom role.
Use the baseApiUrl from the login response as the base URL for the following URI:
/public/core/v3/roles/
<role ID>
runtimeEnvironment GET
Version 2 resource.
Returns the details of the runtime environments used by the organization.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/runtimeEnvironment
schedule GET
Version 3 resource.
Returns the details of a schedule or of all schedules in the organization.
Use the baseApiUrl from the login response as the base URL for one of the following URIs:
/public/core/v3/schedule /public/core/v3/schedule/
<id>
schedule POST
Version 3 resource.
Use to create a schedule.
Use the baseApiUrl from the login response as the base URL in the following URI:
/public/core/v3/schedule
schedule PATCH
Version 3 resource.
Use to update a schedule.
Use the baseApiUrl from the login response as the base URL in the following URI:
/public/core/v3/schedule/
<id>
schedule DELETE
Version 3 resource.
Use to delete a schedule.
Use the baseApiUrl from the login response as the base URL in the following URI:
/public/core/v3/schedule/
<id>
schedule GET
Version 2 resource.
Returns the details of a schedule or of all schedules in the organization.
Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/schedule/
<id>
/api/v2/schedule/name/
<name>
schedule POST
Version 2 resource.
Creates or updates a schedule.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/schedule/
<id>
We recommend that you use the version 3 schedule resource, instead of using the version 2 schedule resource. The version 2 schedule resource doesn't support full scheduling functionality.
schedule DELETE
Version 2 resource.
Deletes a schedule.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/schedule/
<id>
securityLog GET
Version 3 resource.
Returns security log entries that include events such as login actions and permission changes.
Use the baseApiUrl from the login response as the base URL for the following URI:
/public/core/v3/securityLog
serverTime GET
Version 2 resource.
Returns the local time for the
Informatica Intelligent Cloud Services
server.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/server/serverTime
TagObject POST
Version 3 resource.
Assigns tags to an asset.
Use the baseApiUrl from the login response as the base URL for the following URI:
/public/core/v3/TagObject
task GET
Version 2 resource.
Returns a list of tasks of the specified type.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/task?type=
<type>
UntagObject POST
Version 3 resource.
Removes tags that were assigned to an asset.
Use the baseApiUrl from the login response as the base URL for the following URI:
/public/core/v3/UntagObject
user GET
Version 2 resource.
Returns the details of an
Informatica Intelligent Cloud Services
user account or of all user accounts in the organization.
Use the serverUrl from the login response as the base URL for one of the following URIs:
/api/v2/user/
<id>
/api/v2/user/name/
<name>
We recommend that you use the version 3 users resource, instead of using the version 2 user resource. The version 2 user resource doesn't support user groups or user roles.
user POST
Version 2 resource.
Creates or updates an
Informatica Intelligent Cloud Services
user account.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/user/
<id>
We recommend that you use the version 3 users resource, instead of using the version 2 user resource. The version 2 user resource doesn't support user groups or user roles.
user DELETE
Version 2 resource.
Deletes an
Informatica Intelligent Cloud Services
user account.
Use the serverUrl from the login response as the base URL for the following URI:
/api/v2/user/
<id>
userGroups GET
Version 3 resource.
Returns details for all user groups in the organization or the details for a particular user group.
Use the baseApiUrl from the login response as the base URL for the following URI:
/public/core/v3/userGroups
userGroups POST
Version 3 resource.
Creates an
Informatica Intelligent Cloud Services
user group.
Use the baseApiUrl from the login response as the base URL for one of the following URIs:
/public/core/v3/userGroups /public/core/v3/userGroups/
<user group ID>
userGroups DELETE
Version 3 resource.
Deletes an
Informatica Intelligent Cloud Services
user group.
Use the baseApiUrl from the login response as the base URL for the following URI:
/public/core/v3/userGroups/
<user group ID>
UserProfile GET
Version 3 resource.
Returns the security question for the specified user.
Use the baseApiUrl from the login response as the base URL for the following URI:
public/core/v3/Users/
<user ID>
/UserProfile
UserProfile PATCH
Version 3 resource.
Sets the security answer for the user who initiated the session.
Use the baseApiUrl from the login response as the base URL for the following URI:
public/core/v3/Users/UserProfile
users GET
Version 3 resource.
Returns details for all users in the organization or the details for a particular user.
Use the baseApiUrl from the login response as the base URL for the following URI:
/public/core/v3/users
users POST
Version 3 resource.
Creates an
Informatica Intelligent Cloud Services
user account, and changes and resets user passwords.
Use the baseApiUrl from the login response as the base URL for one of the following URIs:
/public/core/v3/users /public/core/v3/users/
<user ID>
users DELETE
Version 3 resource.
Deletes an
Informatica Intelligent Cloud Services
user account.
Use the baseApiUrl from the login response as the base URL for the following URI:
/public/core/v3/users/
<user ID>


Updated May 03, 2021