eventCollectorGetAttributes

Syntax

com.tibco.wcc.base.Requests.eventCollectorGetAttributes(requestId,
                                                        componentId);

Parameters

• requestId - (String) Uniquely identifies the request. For more information, see Submitting Server Requests.
• componentId - (String) Identifies the component whose event collector attributes are to be returned.

Returns

Returns an <ap:AttributeDefinition> element for each component that writes entries to the event collector. Each <ap:AttributeDefinition> element contains the following elements:

• <ap:Id> - The ID of the attribute.
• <ap:Name> - The name of the attribute.
• <ap:Category> - The category in which the attribute was placed when it was defined.
• <ap:Type> - The type of data stored in the attribute.
• <ap:IsPrimary> - Indicates whether or not the attribute is in the primary Events table. For internal use.
• <ap:ComponentId> - The ID of the component in which the attribute was defined. (Components can write to attributes defined in their own component, as well as attributes defined in components higher in the component hierarchical structure.)
• <ap:IsSortable> - true = the attribute is sortable; false = the attribute is not sortable.
• <ap:IsFilterable> - true = the attribute is filterable; false = the attribute is not filterable.

For example:

<ap:Requests>
  <ap:EventCollectorGetAttributes Id="ApiSample.eventCollectorGetAttributes">
    <ap:AttributeDefinitions Id="ApiSample.eventCollectorGetAttributes">
      <ap:AttributeDefinition>
        <ap:Id>31</ap:Id>
        <ap:Name>resourceName</ap:Name>
        <ap:Category />
        <ap:Type>STRING</ap:Type>
        <ap:IsPrimary>true</ap:IsPrimary>
        <ap:ComponentId>2</ap:ComponentId>
        <ap:IsSortable>true</ap:IsSortable>
        <ap:IsFilterable>true</ap:IsFilterable>
      </ap:AttributeDefinition>
               .
               .
               .
    </ap:AttributeDefinitions>
  </ap:EventCollectorGetAttributes>
</ap:Requests>