SOAP API - getAttributes

The table summarizes the SOAP API - getAttributes.

Request Uses the getAttributesRequest element (from the EventCollectorQueryService schema)
Parameter notes
  • componentId: Can be obtained from lookupQueryByTag .
  • getAttributeOptions: (optional) Specifies whether optional data is required. If blank, this defaults to not returning any optional data; this is the same behavior as in earlier versions of TIBCO ActiveMatrix BPM.
  • requiredExtendedData: (optional) Within getAttributeOptions you can specify one of the following values for RequiredExtendedData:
    • requireAllExtendedData: If true, return all the available extended data for the attributes.
    • requiredExtendedData: returns one or more specific items of extended data. This can take the following values:

      IS_SORTABLE - returns whether each attribute is sortable

      IS_FILTERABLE - returns whether each attribute is filterable
Response Returns a getAttributesResponse element (from the EventCollectorQueryService schema)
Parameter notes The response includes:
  • isPrimary — true if the attribute is in the primary events table, false if not. For internal use.

    If you request extended data, the response may include the following for events in the primary events table:

  • isSortable — true if the attribute is sortable, false if not.
  • isFilterable — true if the attribute is filterable, false if not
Example Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.ec.n2.tibco.com" xmlns:base="http://base.api.ec.n2.tibco.com">
   <soapenv:Header/>
   <soapenv:Body>
      <api:getAttributesRequest>
         <componentId>01</componentId>
         <base:GetAttributeOptions>
            <requiredExtendedData>
               <requireAllExtendedData>true</requireAllExtendedData>
            </requiredExtendedData>
         </base:GetAttributeOptions>
      </api:getAttributesRequest>
   </soapenv:Body>
</soapenv:Envelope>
Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <getAttributesResponse xmlns="http://api.ec.n2.tibco.com">
         <AttributeDefinition xmlns="http://base.api.ec.n2.tibco.com">
            <category xmlns="">message</category>
            <componentId xmlns="">1</componentId>
            <id xmlns="">1</id>
            <isPrimary xmlns="">true</isPrimary>
            <name xmlns="">messageId</name>
            <type xmlns="">STRING</type>
            <isFilterable xmlns="">true</isFilterable>
            <isSortable xmlns="">true</isSortable>
         </AttributeDefinition>
         <AttributeDefinition xmlns="http://base.api.ec.n2.tibco.com">
            <category xmlns="">environment</category>
            <componentId xmlns="">1</componentId>
            <id xmlns="">2</id>
            <isPrimary xmlns="">false</isPrimary>
            <name xmlns="">environmentName</name>
            <type xmlns="">STRING</type>
            <isFilterable xmlns="">falsee</isFilterable>
            <isSortable xmlns=""false</isSortable>
         </AttributeDefinition>
                    .
                    .
                    .
      </getAttributesResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>