Skip Ribbon Commands
Skip to main content
Navigate Up
Sign In

Quick Launch

Average Rating:

facebook Twitter
Email
Print Bookmark Alert me when this article is updated

Feedback

HOW TO: Fetch activity monitor details for IICS tasks using Rest API
Solution
You can use of Informatica Cloud ReST API to request information from the activity monitor. "activityMonitor" resource can be used for this purpose.

1. Making the login call:

To use most of the APIs, the <icSessionId> amd serverURL are required which is obtained by invoking the Login() API.

To log in to IICS organization using Informatica Cloud credentials, you might use the following request:

POST https://dm-us.informaticacloud.com/ma/api/v2/user/login
Content-Type: application/json
Accept: application/json
Body:
{
"@type": "login",
"username": "<IICS_Username>",
"password": "<password>"
}
If successful, it returns the user object along with sessionID and baseApiUrl.

2. Perform GET call to request the activity monitor details:

To request information from the activity monitor, use the following URI:
{server-URL}/api/v2/activity/activityMonitor?details=<true|false>

Activity monitor detail to be returned from Informatica Intelligent Cloud Services. 

Use one of the following options:
    • true. Returns activity monitor information for tasks, linear taskflows, and child objects. Child objects can include tasks within linear taskflows, and objects within replication tasks.
    • false. Returns activity monitor information for tasks and linear taskflows.

Default is false. If you omit this optional attribute, activitymonitor does not return additional details.
A successful request returns an activityMonitorEntry object for each row in the activity monitor. Returns the error object if errors occur.

More Information
​To return activity monitor information including details about child objects in XML, you might use the following request:
GET <serverUrl>/api/v2/activity/activityMonitor?details=trueContent-Type: application/xmlAccept: application/xmlicSessionId: <icSessionId>
​​
A successful request returns a list: an activityMonitorEntry object for each item returned from the activity monitor.

The following text is a sample return in XML:
<root> 
<activityMonitorEntry> 
<id>000001C100000000000D</id> 
<type>DSS</type> 
<objectName>dss-f2f</objectName> 
<runId>0</runId> 
<startTime>2012-07-30T13:30:00.000Z</startTime> 
<endTime></endTime> 
<executionState>RUNNING</executionState> 
<failedSourceRows>0</failedSourceRows> 
<successSourcerows>938</successSourceRows> 
<failedTargetRows>0</failedTargetRows> 
<successTargetRows>596</successTargetRows> 
<errorMsg> </errorMsg> 
<entries> </entries> 
<agentId>00000C08000000000003</agentId> 
<runtimeEnvironmentId>00000C25000000000002</runtimeEnvironmentId> 
</activityMonitorEntry> <activityMonitorEntry> 
<id>000001C500000000000L</id> 
<type>PCS</type> 
<objectName>pcs-lookup</objectName> 
<runId>2</runId> 
<startTime>2012-07-30T13:30:03.001Z</startTime> 
<endTime>2012-07-30T13:30:03.010Z</endTime> 
<executionState>COMPLETE</executionState> 
<failedSourceRows>0</failedSourceRows> 
<successSourcerows>688</successSourceRows> 
<failedTargetRows>0</failedTargetRows> 
<successTargetRows>688</successTargetRows> 
<errorMsg> </errorMsg> 
<entries> </entries> 
<agentId>00000C08000000000003</agentId> 
<runtimeEnvironmentId>00000C25000000000002</runtimeEnvironmentId> 
</activityMonitorEntry>

Reference
Applies To
Product: Cloud Data Integration
Problem Type: Configuration
User Type: Architect
Project Phase: Configure
Product Version:
Database:
Operating System:
Other Software:
Attachments
Last Modified Date:11/11/2019 5:42 AMID:562874
People who viewed this also viewed

Feedback

Did this KB document help you?



What can we do to improve this information (2000 or fewer characters)