SOAP API - executeRegisteredGenericQuery

The table summarizes the SOAP API - executeRegisteredGenericQuery.

Request Uses the executeRegisteredGenericQueryRequest element (from the EventCollectorQueryService schema)
Parameter notes
  • QueryIdentifier.guid, QueryIdentifier.tag: Either the GUID or the tag can be used to identify the query, which was previously registered with the registerQuery operation—both are returned by registerQuery . Note, however, passing the GUID makes a more efficient query. You can determine the GUID using the lookupQueryByTag operation.
Response Returns a executeRegisteredGenericQueryResponse element (from the EventCollectorQueryService schema)
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:executeRegisteredGenericQueryRequest>
         <base:QueryIdentifier>
            <tag>EventTag123</tag>
         </base:QueryIdentifier>
         <base:QueryOptions>
            <numberOfItems>-1</numberOfItems>
            <populateAttributeNames>true</populateAttributeNames>
         </base:QueryOptions>
      </api:executeRegisteredGenericQueryRequest>
   </soapenv:Body>
</soapenv:Envelope>
Response:
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header/>
   <SOAP-ENV:Body>
      <executeRegisteredGenericQueryResponse xmlns="http://api.ec.n2.tibco.com">
         <GenericResult xmlns="http://base.api.ec.n2.tibco.com">
            <endPosition xmlns="">11</endPosition>
            <startPosition xmlns="">0</startPosition>
            <totalItems xmlns="">11</totalItems>
            <resultEntry xmlns="">
               <id>65</id>
               <ref>BRM_WORKITEM_SCHEDULED</ref>
               <attribute xsi:type="base:StringEntryAttribute" xmlns:base="http://base.api.ec.n2.tibco.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                  <attributeId>27</attributeId>
                  <attributeName>hostAddress</attributeName>
                  <type>STRING</type>
                  <value>10.97.8.153</value>
               </attribute>
                     .
                     .
                     .
            </resultEntry>
         </GenericResult>
      </executeRegisteredGenericQueryResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>