Activity Monitor

GET Request

To request information from the activity monitor, use the following URI:

/api/v2/activity/activityMonitor?details=<true|false>

You can use the following attribute in the activityMonitor GET URI:

details

Optional

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, the activity monitor does not return additional details.

/api/v2/activity/activityMonitor?details=<true|false>

You can use the following attribute in the activityMonitor GET URI:

GET Response

Returns an activityMonitorEntry object for each row in the activity monitor. Returns the error object if errors occur.
The activityMonitorEntry object includes the following GET response attributes:

Field	Type	Description
id	String	Activity monitor entry ID.
type	String	The type of task. Returns one of the following codes: DMASK. Masking task. DRS. Replication task. DSS. Synchronization task. MTT. Mapping task. PCS. PowerCenter task. WORKFLOW. Linear taskflow
taskId	String	Task ID.
taskName	String	Task name.
objectName	String	Source object used in the task, or the replication object being processed
runId		ID for the task run.
startTime		Start time for the task or linear taskflow.
endTime		End time for the task or linear taskflow.
executionState		State of the task. Returns one of the following codes: INITIALIZED RUNNING STOPPING COMPLETED FAILED
failedSourceRows	Long	Number of rows that were not read from the source.
successSourceRows	Long	Number of rows that were successfully read from the source.
failedTargetRows	Long	Number of rows that were not written to the target.
successTargetRows	Long	Number of rows that were successfully written to the target.
errorMsg	String	Error message associated with the job.
entries	String	Indicates the start of information for a child object. A child object might be a task within a linear taskflow, or an object in a replication task.
agentId	String	Agent used for the activity.
runtimeEnvironmentId	String	Runtime environment used for the activity.
startedBy	String	User who started the task.
runContextType	String	Method through which the task was initiated. Includes the following values: UI. Task was initiated through the Data Integration user interface. SCHEDULER. Task was initiated through the task scheduler. REST-API. Task was initiated through the REST API. OUTBOUND MESSAGE. Task was initiated through an outbound message.
scheduleName	String	Schedule name, if task was initiated by a schedule.
callbackURL	String	Status of the job.

GET Example

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=true
Content-Type: application/xml
Accept: application/xml
icSessionId: <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>
</root>