eventCollectorGetComponents

This request returns a list of the components that generate events.

Syntax

com.tibco.wcc.base.Requests.eventCollectorGetComponents(requestId);

Parameters

Returns

Returns an <ap:Component> element for each component that generate events. Each <ap:Component> element contains the following elements:

  • <ap:Id> - The ID of the component.
  • <ap:Name> - The name of the component.
  • <ap:Version> - The version of the component.
  • <ap:Description> - The description of the component.
  • <ap:ParentId> - The ID of the parent component. (Components can write to attributes defined in their own component, as well as attributes defined in components higher in the component hierarchical structure.)

For example:

<ap:Requests>
  <ap:EventCollectorGetComponents Id="ApiSample.eventCollectorGetComponents">
    <ap:Components Id="ApiSample.eventCollectorGetComponents">
      <ap:Component>
        <ap:Id>1</ap:Id>
        <ap:Name>N2LF</ap:Name>
        <ap:Version>1.1</ap:Version>
        <ap:Description>N2 Logging Framework</ap:Description>
        <ap:ParentId>-1</ap:ParentId>
      </ap:Component>
               .
               .
               .
    </ap:Components>
  </ap:EventCollectorGetComponents>
</ap:Requests>